https://github.com/dansnow/react-intro

Step-by-step guide component for react
https://github.com/dansnow/react-intro

Last synced: 11 days ago
JSON representation

Step-by-step guide component for react

• Host: GitHub
• URL: https://github.com/dansnow/react-intro
• Owner: DanSnow
• Created: 2016-05-12T08:19:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-21T03:01:53.000Z (almost 8 years ago)
• Last Synced: 2024-12-18T08:25:08.369Z (2 months ago)
• Language: JavaScript
• Size: 53.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
React Intro

===========

This is a React component for step-by-step guide and feature introduction.   

Inspire by [intro.js](http://introjs.com/).   

Currently, it is a very simple version.

## Usage ##

See [example](examples/simple/components/App.js) for usage example.

## API ##

###  ###

|    Prop    |    Type    |          Description          |

| ---------- | ---------- | ----------------------------- |

| start      | bool       | Control start or not          |

| onFinish   | func       | Emit on it is finish          |

| children   | node(opt.) | Children                      |

###  ###

|    Prop    |    Type      |          Description                |

| ---------- | ------------ | ----------------------------------- |

| text       | string       | Intro. text                         |

| step       | number       | Step number                         |

| position   | string(opt.) | Pos. of intro. Only bottom or right |

| children   | node         | Only allow a child                  |