diff --git a/README.md b/README.md index 92fb7c9..77609b9 100644 --- a/README.md +++ b/README.md @@ -1 +1,85 @@ -# shared-element \ No newline at end of file +# Shared Element + +Create smooth transition between individual DOM elements. +[Demo](https://joshuaamaju.github.io/shared-element/index.html) + +## Installation + +```html + +``` + +### OR + +```bash +yarn add shared-element + +or + +npm install shared-element +``` + +## Usage + +```javascript +let transition = new SharedElement({ from, to }); +transition.init(object); +transition.reverse(); +``` + +## Config + +### Methods + +- play +- reverse +- [css](#css) +- [init](#init) +- [points](#points) + +#### Init + +--- + +Properties - type: Object + +| Key | Default | Type | +| ------------- | -------------- | --------- | +| `duration` | 300 | `number` | +| `easing` | easeInOutQuint | `string` | +| `withOverlay` | true | `boolean` | +| `delay` | 0 | `number` | + +#### CSS + +--- + +format: {property: [from, to]} + +example + +```javascript +transition.css({ + borderRadius: ["2em", 0], + background: ["red", "blue"] +}); +``` + +#### Points + +--- + +example + +```javascript +transition.points({ + from: { + top: 100, + left: 400 + }, + to: { + top: 10, + left: 0 + } +}); +``` diff --git a/dist/shared-element.esm.js b/dist/shared-element.esm.js index cc9d06b..337e0d6 100644 --- a/dist/shared-element.esm.js +++ b/dist/shared-element.esm.js @@ -69,7 +69,7 @@ function SharedElement({ to, from }) { var hasPlayed = false; var withOverlay = true; var parent = _to.parentNode; - var easing = "cubic-bezier(0.65, 0.05, 0.36, 1)"; + var easing = "cubic-bezier(0.86, 0, 0.07, 1)"; return { css: function(_css) { diff --git a/dist/shared-element.umd.js b/dist/shared-element.umd.js index 0ea237a..1c74978 100644 --- a/dist/shared-element.umd.js +++ b/dist/shared-element.umd.js @@ -75,7 +75,7 @@ var hasPlayed = false; var withOverlay = true; var parent = _to.parentNode; - var easing = "cubic-bezier(0.65, 0.05, 0.36, 1)"; + var easing = "cubic-bezier(0.86, 0, 0.07, 1)"; return { css: function(_css) { diff --git a/docs/index.html b/docs/index.html index fc14711..cfdb661 100644 --- a/docs/index.html +++ b/docs/index.html @@ -32,7 +32,8 @@

- + + diff --git a/package.json b/package.json index e93fd83..cea22ab 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,16 @@ "files": [ "dist" ], + "keywords": [ + "hero", + "morph", + "animation", + "transition", + "shared element", + "page transition", + "morph transition", + "shared element transition" + ], "scripts": { "build": "rollup -c", "dev": "rollup -c -w" diff --git a/src/shared-element.js b/src/shared-element.js index 18dacbb..c89a3b9 100644 --- a/src/shared-element.js +++ b/src/shared-element.js @@ -21,7 +21,7 @@ function SharedElement({ to, from }) { var hasPlayed = false; var withOverlay = true; var parent = _to.parentNode; - var easing = "cubic-bezier(0.65, 0.05, 0.36, 1)"; + var easing = "cubic-bezier(0.86, 0, 0.07, 1)"; return { css: function(_css) {