view-transition-name-handler
v0.0.7
Published
That library manages the view-transition-name property between DOM nodes during navigation
Maintainers
Readme
view-transition-name-handler
That library manages the view-transition-name property between DOM nodes during navigation.
- First-class support for history (back/forward) navigation.
- Tiny size, less than 1 kB (gzip).
- Works with any router/meta-framework.
- Any scenario is possible. By using custom data attributes, you can achieve transitioning between any tags (
<img>/<iframe>/<video>/<canvas>/<div>).
Installation
$ npm install view-transition-name-handler$ yarn add view-transition-name-handlerAPI
handleTransitionStarted
Call that function before navigation
handleTransitionStarted(currentRouterKey: string, [{ fromElement, toAttributeName = 'src', toAttributeValue, transitionName }])- fromElement—DOM element that starts transition
- toAttributeName and toAttributeValue are used to find a DOM element that should finish transition
- transitionName—used for setting view-transition-name value
handleHistoryTransitionStarted
Should be called on "popstate" event.
handleHistoryTransitionStarted(navigatedRouterKey: string)handleRouteChangeComplete
Should be called once navigation is completed.
handleRouteChangeComplete(currentRouterKey: string)