# blendic-svg-player

> This is the component to play the animations exported by Blendic SVG.

Latest version **0.0.1** (published 2021-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install blendic-svg-player
pnpm add blendic-svg-player
yarn add blendic-svg-player
bun add blendic-svg-player
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-02-28 |
| First published | 2021-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 189.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | miyanokomiya |
| Maintainers | miyanokomiya |

## Links

- npm: https://www.npmjs.com/package/blendic-svg-player
- Repository: https://github.com/miyanokomiya/blendic-svg-player
- npm.io page: https://npm.io/package/blendic-svg-player

## Recent versions

- 0.0.1 (latest) — 2021-02-28

## README

![Main](https://github.com/miyanokomiya/blendic-svg-player/workflows/test/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# blendic-svg-player
This is the component to play the animations exported by Blendic SVG.

The detail of Blendic SVG is here: https://github.com/miyanokomiya/blendic-svg

## demo
https://miyanokomiya.github.io/blendic-svg-player/

## usage

### install
```sh
yarn add blendic-svg-player
```

### mount
```html
<div id="target_id" />
```

```ts
import { Player } from 'blendic-svg-player'

const bakedData = { /* json data exported by Blendic SVG */ }

const player = new Player('target_id', {
  bakedData: bakedData,
  width: '100%',
  height: '100%',
})

player.play()
// player.reverse()
// player.pause()
// player.stop()
// player.dispose()
```

## commnad

``` bash
# install dependencies
$ yarn install

# start dev & demo server
$ yarn demo

# lint
$ yarn lint[:fix]

# test
$ yarn test [--watch]

# build
$ yarn build
```

## publish
Update `version` in `package.json`, commit with a comment `Release x.x.x` and merge into the `main` branch.

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