{"id":18465243,"url":"https://github.com/sleexyz/react-router-tween","last_synced_at":"2025-04-30T22:16:30.083Z","repository":{"id":33745385,"uuid":"37400231","full_name":"sleexyz/react-router-tween","owner":"sleexyz","description":"state tweening page transitions for react router","archived":false,"fork":false,"pushed_at":"2015-06-16T06:48:03.000Z","size":136,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T17:39:33.010Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sleexyz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-14T05:21:10.000Z","updated_at":"2015-06-14T13:09:36.000Z","dependencies_parsed_at":"2022-08-26T12:12:55.816Z","dependency_job_id":null,"html_url":"https://github.com/sleexyz/react-router-tween","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleexyz%2Freact-router-tween","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleexyz%2Freact-router-tween/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleexyz%2Freact-router-tween/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleexyz%2Freact-router-tween/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sleexyz","download_url":"https://codeload.github.com/sleexyz/react-router-tween/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251582966,"owners_count":21612740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T09:12:31.485Z","updated_at":"2025-04-29T20:46:15.714Z","avatar_url":"https://github.com/sleexyz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-router-tween\n\nProvides tweening state transitions for [react-router](https://github.com/rackt/react-router) on route entrances and exits.\n\n\n\u003cbr\u003e\n\nRRT binds `this.state.presence` in a component, which tweens from 0 to 1 when the component is mounted. When our route changes, the `presence` variable tweens back to 0 and the component is unmounted.\n\n\u003cbr\u003e\n\nRRT uses [react-set-state-tween](https://github.com/freshdried/react-set-state-tween), a promises wrapper around [react-tween-state](https://github.com/chenglou/react-tween-state)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n## install\n\n```\nnpm install --save react-router-tween\n```\n\n\n## example\n*on page load:*\n\n- Outer is mounted.\n- Outer tweens `presence` from 0 to 1. (opacity fade-in)\n- InnerA is mounted.\n- InnerA tweens `presence` from 0 to 1. (opacity fade-in)\n\n\n*when route switches to InnerB:*\n\n- InnerA tweens `presence` from 1 to 0. (opacity fade-out)\n- InnerA is unmounted.\n- InnerB is mounted.\n- InnerB tweens `presence` from 0 to 1. (opacity fade-in)\n\n```javascript\nimport React from \"react\"\nimport Promise from \"bluebird\"\nimport RRT from \"react-router-tween\"\nimport Router from \"react-router\"\n\nconst {Route, DefaultRoute, RouteHandler} = Router;\n\nconst Outer = React.createClass({\n    mixins: [RRT],\n    render() {\n        let presence = this.getTweeningValue(\"presence\");\n        let style = { opacity: presence };\n\n        //Here we specify to mount subroutes only when the fade-in completes.\n        //We could very much mount RouteHandler directly, so that\n        //Outer and Inner would fade-in in parallel\n    \n        let routehandler = (presence === 1)\n            ? \u003cRouteHandler/\u003e\n            : null;\n\n        return (\u003cdiv style={style}\u003e\n            \u003ch1\u003eHello World\u003c/h1\u003e\n            \u003cdiv\u003e\n                \u003cLink to={\"/\"}\u003eHome (InnerA)\u003c/Link\u003e\n            \u003c/div\u003e\n            \u003cdiv\u003e\n                \u003cLink to={\"/B\"}\u003eInnerB\u003c/Link\u003e\n            \u003c/div\u003e\n            {routehandler}\n        \u003c/div\u003e)\n    }\n});\n\nconst InnerA = React.createClass({\n    mixins: [RRT],\n    render() {\n        let presence = this.getTweeningValue(\"presence\");\n        let style = { opacity: presence}; //fade-in and fade-out\n\n        return (\u003cp style={style}\u003e A \u003c/p\u003e)\n    }\n});\n\nconst InnerB = React.createClass({\n    mixins: [RRT],\n    render() {\n        let presence = this.getTweeningValue(\"presence\");\n        let style = { opacity: presence}; //fade-in and fade-out\n\n        return (\u003cp style={style}\u003e B \u003c/p\u003e)\n    }\n});\n\nconst routes = (\n    \u003cRoute path=\"/\" handler={Outer}\u003e\n        \u003cDefaultRoute handler={InnerA}/\u003e\n        \u003cRoute path=\"/B\" handler={InnerB}/\u003e\n    \u003c/Route\u003e\n);\n\nRouter.run(routes, Router.HashLocation,\n    (Handler) =\u003e React.render(\u003cHandler/\u003e, document.body));\n```\n## custom tweening behavior\n#### Override entrance behavior by providing `this.enterTween()`\n`this.enterTween() -\u003e Promise`\n\n\n```javascript\n    // default enterTween\n    ...\n    enterTween() {\n        return this.setStateTween({presence: 1}, {\n            duration: 300,\n            easing: tweenState.easingTypes.easeInOutQuad\n        });\n    }\n    ...\n```\n\n#### Override exit behavior by providing `this.exitTween()`\n`this.exitTween() -\u003e Promise`\n\n\n\n```javascript\n    // default exitTween\n    ...\n    exitTween() {\n        return this.setStateTween({presence: 0}, {\n            duration: 300,\n            easing: tweenState.easingTypes.easeInOutQuad\n        });\n    }\n    ...\n```\n\n#### example custom tweens\n*when route changes to InnerC*\n- InnerC is mounted.\n- InnerC tweens `presence`to 1 (linear, 500ms)\n- InnerC tweens `presence` to 0 (easeInOutQuad, 1000ms)\n- InnerC tweens `presence` to 1 (easeInOutQuad, 1000ms)\n\n*when route changes out*\n- InnerC tweens `presence` to 0 (easeInOutQuad, 1000ms)\n\n```javascript\nimport tweenState from \"react-tween-state\"\n...\n\nconst InnerC = React.createClass({\n    mixins: [RRT],\n\n    enterTween() {\n        return this.setStateTween({presence: 1}, {\n                duration: 500,\n                easing: tweenState.easingTypes.linear\n            })\n            .then(() =\u003e this.setStateTween({presence: 0}, {duration: 1000}))\n            .then(() =\u003e this.setStateTween({presence: 1}, {duration: 1000}));\n    },\n    exitTween() {\n        return this.setStateTween({presence: 0}, {duration: 1000});\n    },\n\n    render() {\n        let presence = this.getTweeningValue(\"presence\");\n        let style = { opacity: presence };\n\n        return (\u003cp style={style}\u003e C \u003c/p\u003e);\n    }\n});\n\n...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleexyz%2Freact-router-tween","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsleexyz%2Freact-router-tween","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleexyz%2Freact-router-tween/lists"}