{"id":15047086,"url":"https://github.com/georgiowan/react-impressjs","last_synced_at":"2025-08-21T02:32:20.740Z","repository":{"id":74048544,"uuid":"85051302","full_name":"GeorgioWan/react-impressjs","owner":"GeorgioWan","description":"Making an awesome presentations easy with React","archived":false,"fork":false,"pushed_at":"2018-06-07T05:14:12.000Z","size":921,"stargazers_count":114,"open_issues_count":5,"forks_count":36,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-07T15:02:42.500Z","etag":null,"topics":["component","css3","impressjs","presentation","react","reactjs"],"latest_commit_sha":null,"homepage":"http://oawan.me/react-impressjs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeorgioWan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-15T09:05:26.000Z","updated_at":"2024-11-16T16:10:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"abef376d-e60f-4899-b1ac-156c91c433e7","html_url":"https://github.com/GeorgioWan/react-impressjs","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/GeorgioWan%2Freact-impressjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgioWan%2Freact-impressjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgioWan%2Freact-impressjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeorgioWan%2Freact-impressjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeorgioWan","download_url":"https://codeload.github.com/GeorgioWan/react-impressjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230479864,"owners_count":18232630,"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":["component","css3","impressjs","presentation","react","reactjs"],"created_at":"2024-09-24T20:54:18.822Z","updated_at":"2024-12-19T18:18:21.724Z","avatar_url":"https://github.com/GeorgioWan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# React-impressJS\n\nimpress.js via React :tada:\n\n[![NPM version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![LICENCE][licence-image]][licence-url]\n\n[npm-image]: https://img.shields.io/npm/v/react-impressjs.svg\n[npm-url]: https://www.npmjs.com/package/react-impressjs\n[travis-image]: https://travis-ci.org/GeorgioWan/react-impressjs.svg?branch=master\n[travis-url]: https://travis-ci.org/GeorgioWan/react-impressjs\n[licence-image]: https://img.shields.io/npm/l/react-impressjs.svg\n[licence-url]: https://github.com/GeorgioWan/react-impressjs/blob/master/LICENSE\n\n## Why React-impressJS\n\nEasy to create an impressive **Slide**/**Introduction**/**Presentation** in ReactJS.\n\n## Install\n\n[![NPM install](https://nodei.co/npm/react-impressjs.png)](https://www.npmjs.com/package/react-impressjs)\n\n## Feature\n\n### Quick Navigation\n\n#### Navigation on Mobile devise (YES! We provide mobile browser now :tada:)\n\nJust **Swipe** to navigate:\n\n`swipe right`: Go to the previous Step.\n\n`swipe left`: Go to the next Step.\n\n#### Navigation on PC/Laptop\n\nYou can use **Spacebar** or **Arrow keys** to navigate, and here's all the keys for navigation:\n\n`←` or `↑` or `PageUp`: Go to the previous Step.\n\n`→` or `↓` or `Space` or `PageDown`: Go to the next Step.\n\n`Home`: Go to the first Step.\n\n`End`: Go to the last Step.\n\n\u003e p.s. You can also **Click** the Step directly.\n\n### Progress (Step Counter)\n\nProvide **progress bar** and **Slide Counter** (current/total number), let presentation more clearly.\n\n### Hash Permalinks\n\nYou can navigate to the Step you want with `#/step-id`.\n\n## Usage\n\n### Components\n\n**React-impressJS** have two components: **`\u003cImpress /\u003e`** and **`\u003cStep /\u003e`**, as same as [**impress.js**](https://github.com/impress/impress.js/).\n\n**`\u003cImpress /\u003e`** contains the **root of impress** and the **camera**, then put **`\u003cStep /\u003e`** inside impress component, magic happens :sparkles:\n\n\u003e What's **impress.js**!? \n\u003e\n\u003e It's an awesome presentation framework power of CSS3 transorms and transitions, please check [THIS](https://github.com/impress/impress.js) first!!\n\n## API\n\n### Impress props\n\n| name     | type    | description     | default      |\n|----------|----------------|----------|--------------|\n|rootData | Object | setting impress basic config | **defaults** |\n|fallbackMessage | String or Element | fallback message is only visible when there is `impress-not-supported` | - |\n|hint | Boolean | display hint or not | **true** |\n|hintMessage | String or Element | hint for presentation | - |\n|progress | Boolean | progress of presentation | **false** |\n\n```js\nconst defaults = {\n    width: 1024,\n    height: 768,\n    maxScale: 1,\n    minScale: 0,\n    perspective: 1000,\n    transitionDuration: 1000\n};\n```\n\n### Step props\n\n| name     | type    | description     | default      |\n|----------|----------------|----------|--------------|\n|id | String | id of dom node | \"step-\" + ~**timestamp**~ **idHelper**(counter of Step) |\n|className | String | additional css class of step dom node | '' |\n|data | Object | setting Step's presentation | **defaultData** |\n|duration | number | define duration of the transition in ms  | **1000** |\n\n```js\nconst defaultData = {\n  x: 0,       // as data-x\n  y: 0,       // as data-y\n  z: 0,       // as data-z\n  rotateX: 0, // as data-rotate-x\n  rotateY: 0, // as data-rotate-y\n  rotateZ: 0, // as data-rotate and data-rotate-z\n  scale: 1    // as data-scale\n};\n```\n\n### Basic Use\n\n```jsx\nimport { Impress, Step } from 'react-impressjs';\n// styles of react-impressjs\nimport 'react-impressjs/styles/react-impressjs.css';\n\n\u003cImpress \n    progress={true}\n    fallbackMessage={\u003cp\u003eSorry, your \u003cb\u003edevice or browser\u003c/b\u003e couldn't support well.\u003c/p\u003e}\n    \u003e\n    \u003cStep id={'overview'} /\u003e \n    \u003cStep id={'any_id'} className={'class_name'} /\u003e\n    \u003cStep className={'without_id_is_ok'} \n          data={\n            {\n                x:100,\n                y:-100,\n                scale:2\n            }}/\u003e\n    \u003cStep duration={1500}\u003e\n        \u003ch1\u003eAny Element write in Step!\u003c/h1\u003e\n        \u003chr /\u003e\n        \u003cp\u003eMade by your \u003cb\u003eCreativity\u003c/b\u003e !!\u003c/p\u003e\n    \u003c/Step\u003e\n\u003c/Impress\u003e\n```\n\n## Style\n\nCurrently, you can use style of **impress.js** or **React-impressJS** in your app:\n\n```js\n// style of impress\nimport 'react-impressjs/styles/impress-demo.css';\n\n// style of react-impressjs\nimport 'react-impressjs/styles/react-impressjs.css';\n```\n\n\u003e We suggest you use the **React-impressJS**.\n\u003e\n\u003e If you have the better one, I'm glad you can share with us, expect yours! :grin::grin:\n\n## Development\n\nThis Component is still under development, if you have any suggestion, you could tell me in [**issue**](https://github.com/GeorgioWan/react-impressjs/issues) or [**fork this repo**](https://github.com/GeorgioWan/react-impressjs#fork-destination-box) :muscle:\n\n## License\n\n**React-impressJS** is released under the [MIT license](https://github.com/GeorgioWan/react-impressjs/blob/master/LICENSE).\n\n\n\u003e This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorgiowan%2Freact-impressjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeorgiowan%2Freact-impressjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorgiowan%2Freact-impressjs/lists"}