Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@animxyz/core

ingram-projects7kMIT0.6.6

AnimXYZ is a composable animation library that makes your site shine

css, scss, animation, css-animations, composable-animations, css-framework, functional-css, animxyz

readme

AnimXYZ Logo

AnimXYZ

npm version

animxyz.com

AnimXYZ helps you create, customize, and compose animations for your website. Powered by CSS variables to allow a nearly limitless number of unique animations without writing a single keyframe. Save time and have complete control over how your elements move. Built for Vue, React, SCSS, and CSS, AnimXYZ will bring your website to life.

For example here is how you make an element fade and shrink in from above:

<div class="xyz-in" xyz="fade up big">I will animate in!</div>

Changing the class to xyz-out reverses the direction of the animation:

<div class="xyz-out" xyz="fade up big">I will animate out!</div>

[See it in action here](<https://animxyz.com/docs?tab=examples&example=Example 1#the-basics>)

For simple animations, that's all you need, but AnimXYZ can do so much more! Check out the AnimXYZ docs!


Installation

Using a package manager

AnimXYZ can be installed using your favorite package manager:

# with npm
npm install @animxyz/core

# with yarn
yarn add @animxyz/core

After installation, you will need to import AnimXYZ into your project.

Import into a Webpack project

If your Webpack project uses css-loader you can import the CSS by putting this snippet anywhere in your javascript code:

import '@animxyz/core'

Import into a SASS project

AnimXYZ is built in SASS and provides useful functions and mixins for customization. Import it anywhere in your SASS code:

// Import the functions/mixins
@import '@animxyz/core';

// Add all the core/utilities selectors
@include xyz-all;
// --- Or for more control and granularity ---
@include xyz-core;
@include xyz-utilities;

Using jsDelivr

To add AnimXYZ using a CDN put this link in the <head> of your index.html file:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@animxyz/core">

Vue & React

If you are using AnimXYZ in a Vue or React project we strongly recommend you also use our AnimXYZ components. To add those, follow the installation instructions in the relevant sections Vue and React.


Made By

Miles Ingram • GitHubWebsite

Mattan Ingram • GitHubWebsite

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.6.6 (2022-01-12)

Note: Version bump only for package animxyz

0.6.5 (2021-12-01)

Bug Fixes

  • fixed unmount with vue3 directive and ssr error in mergeData function (93f58e9)

0.6.4 (2021-06-30)

Note: Version bump only for package animxyz

0.6.3 (2021-06-30)

Bug Fixes

  • fixed wierd issue blocking monorepo build process (3bf7489)

0.6.2 (2021-06-29)

Bug Fixes

  • addressed issue with findDOMNode (1776347)
  • make xyz utility classes !important (03503f5)
  • small improvement to react package (917c25f)

Reverts

0.6.1 (2021-06-23)

Bug Fixes

  • fixed StrictMode findDOMNode error with react transition group (862b643)

0.6.0 (2021-06-22)

Bug Fixes

  • fixed an issue where vue3 wasn't adding the essential classes in latest version (1a23a54)

Features

  • Added official react integration (0d99ba1)

0.5.0 (2021-02-16)

Features

  • added animation-direction utilities (9597ffb)

0.4.1 (2021-02-09)

Bug Fixes

  • add types declaration file (9838dc0)
  • tweaked peer dependencies (b5db20b)

0.4.0 (2021-01-17)

Bug Fixes

  • temporary workaround for postcss-calc bug (3bbf7e4)

Features

  • added appear-visible prop to vue2 package (5db7914)

0.3.0 (2020-12-31)

Code Refactoring

  • modified percentage based utilities and some utility values (92f2b33)

BREAKING CHANGES

  • Utilities with percentage levels (i.e. big-100, left-25) must now be written with a percentage sign. big-100 -> big-100% left-25 -> left-25% rotate-50 -> rotate-50%

0.2.0 (2020-12-30)

Note: Version bump only for package animxyz

0.2.0-alpha.2 (2020-12-30)

Note: Version bump only for package animxyz

0.2.0-alpha.1 (2020-12-30)

Bug Fixes

  • fixed issues with combined vue2/vue3 package by moving vue3 to new package (1020121)

0.2.0-alpha.0 (2020-12-29)

Features

  • vue: added vue 3 support (f0f1aa2)

0.1.2 (2020-12-29)

Note: Version bump only for package animxyz