README.md

justFlipIt

A lightweight JavaScript library for beautiful, customizable flip and tilt animations on any DOM element.

---

🚀 Live Demo & Examples

Try it out!
The interactive Live Demo shows all features and use cases.

---

✨ Features

• Plug & Play: Automatically adopts classes and styles for seamless integration.
• 3D Tilt Effect: Adds an interactive 3D tilt effect on hover and touch.
• Lightweight & Fast: Minimal footprint, maximum performance.
• Highly Customizable: Use your own styles, templates, and animations.
• Modern & Responsive: Works on all modern browsers and devices.
• Flexible: Use via CDN, NPM, or ES modules.

---

📦 Installation

CDN / Local:

<script src="https://unpkg.com/@simhub2/justflipit/dist/justFlipIt-modern.min.js"></script>

NPM:

npm install @simhub2/justflipit

import justFlipIt from "@simhub2/justflipit";

---

▶️ Usage

Initialize the flip effect on your elements. The default trigger is hover.

Hover to Flip (Default)

<div class="card">Hover me!</div>

<script>
  justFlipIt(".card");
</script>

Click to Flip

justFlipIt(".card", { Click: true });

Enable Tilt Effect

// Enable with default settings
justFlipIt(".card", { Tilt: true });

// Customize tilt
justFlipIt(".card", {
  Tilt: {
    max: 15,
    perspective: 800,
  },
});

---

⚙️ Options

Customize the behavior with these options.

Option	Type	Default	Description
Tilt	Boolean / Object	false	Enables a 3D tilt effect. Customize with { max, perspective }.
Click	Boolean / String	false	true for click trigger, or a selector for a custom trigger.
FlipX	Boolean	false	true for vertical flip (around X-axis).
Template	String	null	HTML content for the back side.
preserveClasses	Boolean	true	Inherit all CSS classes from the original element.
preserveStyles	Boolean	true	Inherit all inline styles from the original element.
Duration	Number	400	Animation duration in ms.
Easing	String	ease-in-out	CSS easing function for the animation.
Style	Array	[]	Apply custom styles to the flip panels (see demo).

Advanced Example

justFlipIt(".card", {
  preserveClasses: false, // Start with a clean slate
  Click: true,
  FlipX: true,
  Tilt: true,
  Duration: 800,
  Easing: "cubic-bezier(0.68, -0.55, 0.27, 1.55)",
  Template: "<div>My custom back side!</div>",
  Style: [
    {
      el: "self",
      style: {
        background: "#fff",
        borderRadius: "1rem",
        boxShadow: "0 2px 8px #0002",
      },
    },
    { el: ".front", style: { background: "#f5c939", color: "#222" } },
    { el: ".backY", style: { background: "#ca9dfe", color: "#fff" } },
  ],
});

---

Versions & Compatibility

• modern: justFlipIt-modern.js (Recommended, uses Web Animations API)
• vanilla: justFlipIt-vanilla.js (CSS transitions only)
• combined: justFlipIt-combined.js (Optional jQuery support)

Browser Support:

• ✅ Chrome 60+
• ✅ Firefox 55+
• ✅ Safari 12+
• ✅ Edge 79+

---

License

Released under the MIT License.

You are free to use, modify, and distribute this project, even for commercial purposes. All that is required is to include the original copyright and license notice in any copy of the software/source.

---