@plutonium-js/react-atomic

Plutonium Atomic - [react animation component]

About

Atomic is an ultra lightweight React component that simplifies the management and control of CSS animations.

• Define pure CSS keyframe or transition style animations directly in the JSX
• Control play states such as 'running', 'pause', 'reset', 'cancel', 'to', and 'from'
• Easily pause, reverse, reset, and more from any event
• Add state to CSS key frame at-rules ('@keyframe')
• All standard CSS features are supported such as delay, direction, duration, ease, etc...
• Add any child components and elements without conflict

Links

• Atomic Home
  • Documentation
  • API

Bookmarks

• Installation
• Usage
  • Module
  • CDN Script Tags
• Create Component
• Animate
• Key Frames or Transitions
• Adding State
• Control
• License

Installation

> npm install @plutonium-js/react-atomic

🔼

Usage

• Module

  Using ES6...

  import Atomic from '@plutonium-js/react-atomic';

  Or when using CommonJS...

  const {Atomic} = require('@plutonium-js/react-atomic');

• CDN Script Tag

  Add the component directly to a web page.

  <script src="https://cdn.jsdelivr.net/npm/@plutonium-js/react-atomic@1/dist/bundle.min.js"></script>

🔼

Create Component

To create a basic Atomic component, add the 'Atomic' tag to your JSX. The child content can be any text, elements, or other React components.

class App extends Component {
   render() {
      return (
         <Atomic>your content here</Atomic>
      );
   }
}

🔼

Animate

To animate an Atomic component add the animate property. The example below fades in the element while rotating it one revolution.

render() {
   return <Atomic
      animate = {{
         keyframes:`
            from {
               transform:rotate(0deg);opacity:0;
            }
            to {
               transform:rotate(360deg);opacity:1;
            }
         `,
         animation:"2s ease",
         playState:'running'
       }}
   >Plutonium Atomic!</Atomic>;
}

🔼

Key Frames or Transitions

Animations can be defined using CSS key frames or transitions (only use one method per component and not both). For key frames, provide standard CSS at-rule syntax as a string. (the example below uses an ES6 template string)

keyframes:`
   from {
      transform:rotate(0deg);opacity:0;
   }
   to {
      transform:rotate(360deg);opacity:1;
   },
   animation:"2s ease",
   playState:'running'
`

To use transitions...

transitions:{
   transform:{
      from:'rotate(0deg)',
	  to:'rotate(360deg)'
   },
   opacity:{
      from:0,
	  to:1
   }
   animation:"2s ease",
   playState:'running'
}

With transitions the 'to' value is required. With both key frames and transitions the 'from' value is optional. If 'from' is omitted the animation or transition will start at the elements applied style value.

🔼

Adding State

Add state to any part of the animate property or the entire value. When rendering animation state changes Atomic resets the animation and resumes the current play state.

TIP: To add state to an ES6 template string (backtick '`' enclosed content) use the standard interpolation data syntax '${data}'...

keyframes:`
   from {
      transform:rotate(0deg);
   }
   to {
      transform:rotate(${this.state.myRotation}deg);
   }
`

🔼

Control

The API exposes the 'setPlayState' method for controlling animations. The example below resets the key frame animation when clicking the element.

return <Atomic
   ref = {this.myAtomicElm = React.createRef()}
   onClick = {e => {
      this.myAtomicElm.current.setPlayState('reset');
   }}
   animate = {{
      keyframes:`
         from {
            transform:rotate(0deg);
         }
         to {
            transform:rotate(360deg);
         }
      `,
      animation:"2s ease",
      playState:'running'
   }}
>Plutonium Atomic!</Atomic>;

Supported key frame play state types...

• 'running'
• 'paused'
• 'toggle' (toggles between 'running' and 'paused')
• 'reset'
• 'cancel'
• 'none'

Supported transition play state types...

• 'to'
• 'from'
• 'running' (same as 'to')
• 'paused' (same as 'from')
• 'toggle' (toggles between 'to' and 'from')
• 'reset'
• 'cancel'
• 'none'

🔼

License

Released under the MIT license

Author: Jesse Dalessio / Plutonium.dev

🔼