vitalif
/
react-toolbox
1
0
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

Add document for the root component documentation

old
Javi Velasco 2015-11-01 16:18:35 +01:00
parent 62d3b9c888
commit dd5948e122
3 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/switch/readme.md
View File

@ -3,7 +3,7 @@
On/off switches toggle the state of a single settings option. The option that the switch controls, as well as the state it’s in, should be made clear from the corresponding inline label. Switches take on the same visual properties of the radio button.
<!-- example -->
```
```jsx
import Switch from 'react-toolbox/switch';
const SwitchTest = () => (

2
components/tabs/readme.md
View File

@ -1,6 +1,6 @@
# Tabs
Tabs make it easy to explore and switch between different views or functional aspects of an app or to browse categorized data sets. For now we are using tabs along with content so it's not possible to render just the tab headers with event listeners. In the future we will add this feature but for now you can compose your tabs with content:
[Tabs](https://www.google.com/design/spec/components/tabs.html) make it easy to explore and switch between different views or functional aspects of an app or to browse categorized data sets. For now we are using tabs along with content so it's not possible to render just the tab headers with event listeners. In the future we will add this feature but for now you can compose your tabs with content:
<!-- example -->
```jsx

10
docs/app/components/layout/main/modules/components.md
View File

@ -1 +1,9 @@
# Index for the collection of components
# React Toolbox Components
React Toolbox is a library of React Components based on Google's Material Design Guidelines. The main purpose of the documentation is to explore each of the components and to learn how to use them. To make the best possible experience and to experiment with the components properties and methods, we've created a playground to try components live.
On the top right side of the screen you will see a rounded button with a code icon. It opens a the playground with a small in-browser editor and an area to render what you type in real time.
Inside the documentation of each component you will see one or multiple example code boxes. Each of this boxes include a button to load an example of the given component in the playground. Recall the playground will keep your progress until you load a new example!
Enjoy and remember that [feedback](https://github.com/react-toolbox/react-toolbox/issues) is really appreciated.