Add documentation for Tabs
Javi Velasco
parent
f63103c36d
commit
9d809deb50
|
|
@ -1,50 +1,44 @@
|
|||
# Tabs
|
||||
|
||||
```javascript
|
||||
Tabs = require('../../components/tabs').Tabs
|
||||
Tab = require('../../components/tabs').Tab
|
||||
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>
|
||||
<Tab label='Primary'>
|
||||
<small>primary</small>
|
||||
</Tab>
|
||||
<Tab label='Secondary'>
|
||||
<small>secondary</small>
|
||||
</Tab>
|
||||
<Tab label='Third' disabled>
|
||||
<small>third</small>
|
||||
</Tab>
|
||||
<Tab label='Fourth' hidden>
|
||||
<small>fourth</small>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
<!-- example -->
|
||||
```jsx
|
||||
import {Tab, Tabs} from 'react-toolbox';
|
||||
|
||||
const TabsExample = () => (
|
||||
<Tabs>
|
||||
<Tab label='Primary'><small>Primary content</small></Tab>
|
||||
<Tab label='Secondary'><small>Secondary content</small></Tab>
|
||||
<Tab label='Third' disabled><small>Disabled content</small></Tab>
|
||||
<Tab label='Fourth' hidden><small>Fourth content hidden</small></Tab>
|
||||
<Tab label='Fifth'><small>Fifth content</small></Tab>
|
||||
</Tabs>
|
||||
);
|
||||
```
|
||||
|
||||
## Tabs
|
||||
|
||||
## Properties <Tabs>
|
||||
| Name | Type | Default | Description|
|
||||
|:- |:-: | :- |:-|
|
||||
| **className** | String | `''` | Additional class name to provide custom styling.|
|
||||
| **index** | Number | `0` | Current <Tab> |
|
||||
| **onChange** | Function | | Callback function that is fired when the tab changes.
|
||||
|
||||
## Properties <Tab>
|
||||
This component acts as the wrapper and the main controller of the content that is being displayed. It gets some properties that can be spread to the children.
|
||||
|
||||
| Name | Type | Default | Description|
|
||||
|:- |:-: | :- |:-|
|
||||
| **active** | Boolean | `false` | If true, the current component is visible.|
|
||||
| **className** | String | `''` | Additional class name to provide custom styling.|
|
||||
| **disabled** | Boolean | `false` | If true, the current component is not clickable.|
|
||||
| **hidden** | Boolean | `false` | If true, the current component is not visible.|
|
||||
| **label** | String | | Label for navigation|
|
||||
| **onActive** | Function | | Callback function that is fired when the tab is activated. |
|
||||
| **tabIndex** | Number | | Sets the tabindex html attribute.|
|
||||
|:-----|:-----|:-----|:-----|
|
||||
| `className` | `String` | `''` | Additional class name to provide custom styling.|
|
||||
| `index` | `Number` | `0` | Current <Tab> |
|
||||
| `onChange` | `Function` | | Callback function that is fired when the tab changes.
|
||||
|
||||
## Methods <Tab>
|
||||
The tabs component has state to hold the currently activated tab and exposes a method to change it manually called `active`. You can call this method with the index value of the child you want to activate.
|
||||
|
||||
#### active
|
||||
Active/Deactive a determinate instance of the <Tab> component.
|
||||
## Tab
|
||||
|
||||
```
|
||||
tab_instance.active(true);
|
||||
```
|
||||
Represent a single tab element and it should include some properties to describe the tab itself and get children elements as content.
|
||||
|
||||
| Name | Type | Default | Description|
|
||||
|:-----|:-----|:-----|:-----|
|
||||
| `active` | `Boolean` | `false` | If true, the current component is visible.|
|
||||
| `className` | `String` | `''` | Additional class name to provide custom styling.|
|
||||
| `disabled` | `Boolean` | `false` | If true, the current component is not clickable.|
|
||||
| `hidden` | `Boolean` | `false` | If true, the current component is not visible.|
|
||||
| `label` | `String` | | Label text for navigation header |
|
||||
| `onActive` | `Function` | | Callback function that is fired when the tab is activated. |
|
||||
| `tabIndex` | `Number` | | Sets the tabindex html attribute.|
|
||||
|
|
|
|||
|
|
@ -40,13 +40,6 @@ class Tab extends React.Component {
|
|||
</section>
|
||||
);
|
||||
}
|
||||
|
||||
active (value) {
|
||||
this.setState({active: value});
|
||||
if (this.props.onActive && value) {
|
||||
this.props.onActive(this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default Tab;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# TimePicker
|
||||
# Time Picker
|
||||
|
||||
A [dialog picker](https://www.google.com/design/spec/components/pickers.html#pickers-time-pickers) is used to select a single time (hours:minutes). The selected time is indicated by the filled circle at the end of the clock hand.
|
||||
|
||||
|
|
@ -18,10 +18,10 @@ const TimePickerTest = () => (
|
|||
## Properties
|
||||
|
||||
| Name | Type | Default | Description|
|
||||
| ------------- |:-------:|:--------------- |:---------- |
|
||||
| className | String | `''` | Sets a class to give customized styles to the time picker.|
|
||||
| format | String | `24hr` | Format to display the clock. It can be `24hr` or `ampm`.|
|
||||
| value | Date | | Datetime object with currrently selected time |
|
||||
|:-----|:-----|:-----|:-----|
|
||||
| `className` | `String` | `''` | Sets a class to give customized styles.|
|
||||
| `format` | `String` | `24hr` | Format to display the clock. It can be `24hr` or `ampm`.|
|
||||
| `value` | `Date` | | Datetime object with currrently selected time |
|
||||
|
||||
## Methods
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,8 @@ import RadioExample1 from './examples/radio_example_1.txt';
|
|||
import SliderExample1 from './examples/slider_example_1.txt';
|
||||
import SnackbarExample1 from './examples/snackbar_example_1.txt';
|
||||
import SwitchExample1 from './examples/switch_example_1.txt';
|
||||
import TimePickerTest from './examples/timepicker_example_1.txt';
|
||||
import TabsExample1 from './examples/tabs_example_1.txt';
|
||||
import TimePickerExample1 from './examples/timepicker_example_1.txt';
|
||||
|
||||
export default {
|
||||
app_bar: {
|
||||
|
|
@ -167,12 +168,13 @@ export default {
|
|||
tabs: {
|
||||
name: 'Tabs',
|
||||
docs: Tabs,
|
||||
path: '/components/tabs'
|
||||
path: '/components/tabs',
|
||||
examples: [TabsExample1]
|
||||
},
|
||||
time_picker: {
|
||||
name: 'Time Picker',
|
||||
docs: TimePicker,
|
||||
path: '/components/time_picker',
|
||||
examples: [TimePickerTest]
|
||||
examples: [TimePickerExample1]
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
const TabsExample = () => (
|
||||
<Tabs>
|
||||
<Tab label='Primary'><small>Primary content</small></Tab>
|
||||
<Tab label='Secondary'><small>Secondary content</small></Tab>
|
||||
<Tab label='Third' disabled><small>Disabled content</small></Tab>
|
||||
<Tab label='Fourth' hidden><small>Fourth content hidden</small></Tab>
|
||||
<Tab label='Fifth'><small>Fifth content</small></Tab>
|
||||
</Tabs>
|
||||
);
|
||||
|
||||
return <TabsExample />;
|
||||
Loading…
Reference in New Issue