# react-spriter

> ReactSpriter is a React component that allows you to create animated sprites by providing a convenient interface

Latest version **0.1.0** (published 2023-06-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-spriter
pnpm add react-spriter
yarn add react-spriter
bun add react-spriter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-06-26 |
| First published | 2023-06-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Callum Eddisford |
| Maintainers | callumeddisford |
| Keywords | react, animation, sprite, lightweight, browser-support |

## Links

- npm: https://www.npmjs.com/package/react-spriter
- Repository: https://github.com/CallumEddisford/react-spriter
- Homepage: https://callumeddisford.github.io/react-spriter
- Issues: https://github.com/CallumEddisford/react-spriter/issues
- npm.io page: https://npm.io/package/react-spriter

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^5

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2023-06-26
- 0.0.3 — 2023-06-22
- 0.0.2 — 2023-06-21
- 0.0.1 — 2023-06-21

## README

# This package is a work in progress!

[![npm version](https://badge.fury.io/js/react-spriter.svg)](https://badge.fury.io/js/react-spriter)
![workflow](https://github.com/CallumEddisford/react-spriter/actions/workflows/npm-publish.yml/badge.svg)
![cypress](https://github.com/CallumEddisford/react-spriter/actions/workflows/test.yml/badge.svg)

# React Spriter
React Spriter is a React component that allows you to create animated sprites using styled-components. It simplifies the process of animating sprites by providing a convenient interface to define sprite properties and animations.

DEMOS: [https://react-spriter.callumeddisford.co.uk/](https://react-spriter.callumeddisford.co.uk/)

Build a game! Tell a story! Animate your icons!

# Features
- Pause and play sprite
- Change sprite layer

# Installation
To use ReactSpriter in your React project, you can install it via npm or yarn:

```shell
npm install react-spriter
```

or

```shell
yarn add react-spriter
```

# Usage
1. Import ReactSpriter into your component:
```jsx
import ReactSpriter from "react-spriter";
```
2. Use ReactSpriter in your component's render method:
```jsx
class MyComponent extends React.Component {
  render() {
    return (
      <ReactSpriter
        sprite={sprite}
        spriteWidth={spriteWidth}
        frameWidth={frameWidth}
        frameHeight={frameHeight}
        elementWidth={elementWidth}
        duration={animationDuration}
        isInfinite={isInfinite}
        shouldAnimate={shouldAnimate}
        layer={layer}
      />
    );
  }
}
```

# Props
| Field             | Type    | Description                                                                                                                                       |
|-------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| sprite            | string  | The URL of the sprite image.                                                                                                                      |
| frameWidth        | number  | The width of each frame in the sprite.                                                                                                            |
| frameHeight       | number  | The height of each frame in the sprite.                                                                                                           |
| elementWidth      | number  | (optional) Use this option to resize the sprite to a given pixel width, the element height is calculated automatically to mantain apsect ratio.   |
| spriteWidth       | number  | The total width of the sprite image.                                                                                                              |
| animationDuration | number  | The duration of the animation in milliseconds.                                                                                                    |
| isInfinite        | boolean | Whether the animation should loop infinitely.                                                                                                     |
| shouldAnimate     | boolean | (optional) Whether the animation should start automatically. Defaults to true.                                                                    |
| layer             | number  | (optional) The layer of the sprite animation. If multiple sprites are layered on top of each other, this value determines the order of rendering. |

# Examples
Here's an example of how you can use ReactSpriter to animate a sprite, in this example each frame width is `64` and the total sprite image width is `512` this indicates there are `8` frames to animate over:

```jsx
import React from "react";
import ReactSpriter from "react-spriter";
import sprite from "path/to/sprite.png";

const MyComponent = () => {
  const spriteWidth = 512;
  const frameWidth = 64;
  const frameHeight = 64;
  const elementWidth= 50;
  const animationDuration = 1000;
  const isInfinite = true;
  const shouldAnimate = true;
  const layer = 0;

  return (
    <ReactSpriter
      sprite={sprite}
      spriteWidth={spriteWidth}
      frameWidth={frameWidth}
      frameHeight={frameHeight}
      elementWidth={elementWidth}
      duration={animationDuration}
      isInfinite={isInfinite}
      shouldAnimate={shouldAnimate}
      layer={layer}
    />
  );
};

export default MyComponent;
```

Please check out the `src/examples` directory for more

# Local development
To start storybook locally:

```shell
  npm install
  npm run storybook
```

---
_Source: https://npm.io/package/react-spriter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._