okiba-gang/okiba

View on GitHub
packages/easings/README.md

Summary

Maintainability
Test Coverage


# Okiba / easings
Collection of easings to alter a value

__



```javascript
import {easeInQuad} from '@okiba/easings'
const easedProgress = easeInQuad(progress)
```



### Installation

```bash
npm i --save @okiba/easings
```

Or import it directly in the browser
```html
<script type="module" src="https://unpkg.com/@okiba/easings/index.js"></script>
```

## Usage

```javascript
import easings from '@okiba/easings'
```

#### Untranspiled code 🛑
Okiba Core packages are not transpiled, so _don't forget to transpile them with your favourite bundler_.
For example, using Babel with Webpack, you should prevent imports from okiba to be excluded from transpilation, like follows:

```javascript
{
  test: /\.js$/,
  exclude: /node_modules\/(?!(@okiba)\/).*/,
  use: {
    loader: 'babel-loader',
    options: {
      presets: ['@babel/preset-env']
    }
  }
}
```