@gluestack-style/animation-plugin

Installation

To use @gluestack-style/animation-plugin, all you need to do is install the @gluestack-style/animation-plugin package:

1$ yarn add @gluestack-style/animation-plugin
2
3# or
4
5$ npm i @gluestack-style/animation-plugin

Usage

You can initialize the Animation plugin by creating a new instance of the AnimationResolver class and providing it as an argument to the createStyled function. The AnimationResolver takes an optional styledUtils object that maps the styled utils object. Here's an example:

1import { createStyled } from '@gluestack-style/react';
2import { AnimationResolver } from '@gluestack-style/animation-plugin';
3
4const styled = createStyled([
5  new AnimationResolver({
6    aliases: {
7      ':initial': 'initial',
8      ':animate': 'animate',
9      ':exit': 'exit',
10    },
11  }),
12]);

In this example, we are creating a new instance of the AnimationResolver class, passing an object with the 'aliases' property as an argument. The aliases object maps the aliases :initial, :animate, and :exit to their corresponding animation props.

Example of creating a styled component:

Once the plugin is initialized, you can use the styled function to create styled components with animation props. Here's an example:

1const Box = styled(Motion.View, {
2  ':initial': { opacity: 0 },
3  ':animate': { opacity: 1 },
4  ':exit': { opacity: 0 },
5});

The final internal styled object that will be resolved is:

1styledObject = {
2  'props': {
3    initial: {
4      opacity: 0,
5    },
6    animate: {
7      opacity: 1,
8    },
9    exit: {
10      opacity: 0,
11    },
12    }
13  },
14};

More guides on how to get started are available here.