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

Improve markdown format

old
Javi Velasco 2015-10-31 21:55:12 +01:00
parent 7474c39ad3
commit 7c87940c8f
8 changed files with 60 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/app_bar/readme.md
View File

@ -18,7 +18,7 @@ Coming soon, the `AppBar` component will support arbitrary content attributes fo
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| **className** | String | `''` | Set a class for the root component.|
| **flat** | Bool | `false` | If true, the AppBar shows a shadow.|
| **fixed** | Bool | `false` | Determine if the bar should have position `fixed` or `relative`.|
|:-----|:-----|:-----|:-----|
| `className` | `String` | `''` | Set a class for the root component.|
| `flat` | `Bool` | `false` | If true, the AppBar shows a shadow.|
| `fixed` | `Bool` | `false` | Determine if the bar should have position `fixed` or `relative`.|

20
components/autocomplete/readme.md
View File

@ -28,16 +28,16 @@ const AutocompleteTest = () => (
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| className | `String` | `''` | Sets a class to style of the Component.|
| dataSource | `Object` or `Array` | | Object of key/values or array representing all items suggested.|
| disabled | `Bool` | `false` | If true, component will be disabled.|
| error | `String` | | Sets the error string for the internal input element.|
| label | `String` | | The text string to use for the floating label element.|
| multiple | `Bool` | `true` | If true, component can hold multiple values.|
| onChange | `Function` | | Callback function that is fired when the components's value changes.|
| required | `Boolean` | | If true, component input is set as required.|
| value | `String` or `Array` | | Default value to initialize the component.|
|:-----|:-----|:-----|:-----|
| `className` | `String` | `''` | Sets a class to style of the Component.|
| `dataSource` | `Object` or `Array` | | Object of key/values or array representing all items suggested.|
| `disabled` | `Bool` | `false` | If true, component will be disabled.|
| `error` | `String` | | Sets the error string for the internal input element.|
| `label` | `String` | | The text string to use for the floating label element.|
| `multiple` | `Bool` | `true` | If true, component can hold multiple values.|
| `onChange` | `Function` | | Callback function that is fired when the components's value changes.|
| `required` | `Boolean` | | If true, component input is set as required.|
| `value` | `String` or `Array` | | Default value to initialize the component.|
## Methods

24
components/button/readme.md
View File

@ -20,17 +20,17 @@ const TestButtons = () => (
## Properties
| Name | Type | Default | Description|
|:- |:-: |:- |:-|
| accent | `Bool` | `false` | Indicates if the button should have accent color.|
| className | `String` | `''` | Set a class to style the Component.|
| disabled | `Boolean` | `false` | If true, component will be disabled.|
| icon | `String` | | Value of the icon (See icon component). |
| kind | `String` | `flat` | Type of the component, overwrite this property if you need set a different stylesheet.|
| label | `String` | | The text string to use for the name of the button.|
| loading | `Boolean` | `false` | If true, component will be disabled and show a loading animation.|
| mini | `Boolean` | `false` | To be used with floating button. If true the button will be smaller.|
| onClick | `Function` | | Callback called when the button is clicked.|
| primary | `false` | | If true, component will have the primary color.|
| ripple | `Boolean` | `true` | If true, component will have a ripple effect on click.|
|:-----|:-----|:-----|:-----|
| `accent` | `Bool` | `false` | Indicates if the button should have accent color.|
| `className` | `String` | `''` | Set a class to style the Component.|
| `disabled` | `Boolean` | `false` | If true, component will be disabled.|
| `icon` | `String` | | Value of the icon (See icon component). |
| `kind` | `String` | `flat` | Type of the component, overwrite this property if you need set a different stylesheet.|
| `label` | `String` | | The text string to use for the name of the button.|
| `loading` | `Boolean` | `false` | If true, component will be disabled and show a loading animation.|
| `mini` | `Boolean` | `false` | To be used with floating button. If true the button will be smaller.|
| `onClick` | `Function` | | Callback called when the button is clicked.|
| `primary` | `false` | | If true, component will have the primary color.|
| `ripple` | `Boolean` | `true` | If true, component will have a ripple effect on click.|
Also, any additional properties will be directly transferred to the `button` tag.

22
components/card/readme.md
View File

@ -25,14 +25,14 @@ const TestCards = () => (
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| actions | Array | | Array of objects describing actions. These actions will be rendered as buttons and the object fields will be transferred to those.|
| className | String | `''` | Sets a class to give customized styles to the card.|
| color | String | | Sets HEX or RGBA color to add a colored layer to the heading.|
| image | String | | URL to sets a background image in the heading.|
| loading | Boolean | `false` | If true, component will be disabled and showing a loading animation.|
| onClick | Function | | Callback function that is fired when the components's is clicked. It also will display a ripple effect on click. |
| subtitle | String | | Sets a complementary smaller text under the title.|
| text | String | | Sets a complementary text display as a card description.|
| title | String | | Sets the title of the card.|
| type | String | `default` | Type of the component to display general modifications. It can be `wide` for a larger card, `image` if it's an image card or `event` which shows just a title on top. |
|:-----|:-----|:-----|:-----|
| `actions` | `Array` | | Array of objects describing actions. These actions will be rendered as buttons and the object fields will be transferred to those.|
| `className` | `String` | `''` | Sets a class to give customized styles to the card.|
| `color` | `String` | | Sets HEX or RGBA color to add a colored layer to the heading.|
| `image` | `String` | | URL to sets a background image in the heading.|
| `loading` | `Boolean` | `false` | If true, component will be disabled and showing a loading animation.|
| `onClick` | `Function` | | Callback function that is fired when the components's is clicked. It also will display a ripple effect on click. |
| `subtitle` | `String` | | Sets a complementary smaller text under the title.|
| `text` | `String` | | Sets a complementary text display as a card description.|
| `title` | `String` | | Sets the title of the card.|
| `type` | `String` | `default` | Type of the component to display general modifications. It can be `wide` for a larger card, `image` if it's an image card or `event` which shows just a title on top. |

18
components/checkbox/readme.md
View File

@ -18,15 +18,15 @@ const TestCheckbox = () => (
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| checked | Bool | `false` | If true, the checkbox will be checked.|
| className | String | `''` | Sets a class to give customized styles to the checkbox field.|
| disabled | Bool | `false` | If true, the checkbox shown as disabled and is not possible to modify it.|
| label | String | | Text label to attach next to the checkbox element.|
| name | String | `false` | The name of the field to set in the input checkbox.|
| onBlur | Function | | Callback called when the checkbox is blurred.|
| onChange | Function | | Callback called when the checkbox value is changed.|
| onFocus | Function | | Callback called when the checkbox is focused |
|:-----|:-----|:-----|:-----|
| `checked` | `Bool` | `false` | If true, the checkbox will be checked.|
| `className` | `String` | `''` | Sets a class to give customized styles to the checkbox field.|
| `disabled` | `Bool` | `false` | If true, the checkbox shown as disabled and is not possible to modify it.|
| `label` | `String` | | Text label to attach next to the checkbox element.|
| `name` | `String` | `false` | The name of the field to set in the input checkbox.|
| `onBlur` | `Function` | | Callback called when the checkbox is blurred.|
| `onChange` | `Function` | | Callback called when the checkbox value is changed.|
| `onFocus` | `Function` | | Callback called when the checkbox is focused |
## Methods

6
components/date_picker/readme.md
View File

@ -15,9 +15,9 @@ const DatePickerTest = () => (
## Properties
| Name | Type | Default | Description|
| ------------- |:-------:|:--------------- |:---------- |
| className | String | `''` | Sets a class to give customized styles to the time picker.|
| value | Date | | Date object with the currently selected date. |
|:-----|:-----|:-----|:-----|
| `className` | `String` | `''` | Sets a class to give customized styles to the time picker.|
| `value` | `Date` | | Date object with the currently selected date. |
## Methods

12
components/dialog/readme.md
View File

@ -36,12 +36,12 @@ class DialogTest extends React.Component {
## Properties
| Name | Type | Default | Description|
|:-----|:-----:|:-----|:-----|
| actions | Array | `[]` | A array of objects representing the buttons for the dialog navigation area. The properties will be transferred to the buttons.|
| active | Boolean | `false` | If true, the dialog will be active by default.|
| className | String | `''` | Sets a class to give customized styles to the dialog.|
| title | String | | The text string to use as standar title of the dialog.|
| type | String | `normal` | Used to determine the size of the dialog. It can be `small`, `normal` or `large`. |
|:-----|:-----|:-----|:-----|
| `actions` | `Array` | `[]` | A array of objects representing the buttons for the dialog navigation area. The properties will be transferred to the buttons.|
| `active` | `Boolean` | `false` | If true, the dialog will be active by default.|
| `className` | `String` | `''` | Sets a class to give customized styles to the dialog.|
| `title` | `String` | | The text string to use as standar title of the dialog.|
| `type` | `String` | `normal` | Used to determine the size of the dialog. It can be `small`, `normal` or `large`. |
## Methods

10
components/drawer/readme.md
View File

@ -28,11 +28,11 @@ class DrawerTest extends React.Component {
## Properties
| Name | Type | Default | Description|
|:- |:-: | :- |:-|
| active | Boolean | `false` | If true, the drawer will be active by default.|
| className | String | `''` | Sets a class to give customized styles to the drawer.|
| hideable | Bool | `true` | If true, the drawer will be hidden by clicking the overlay.|
| type | String | `left` | Type of drawer. It can be left or right to display the drawer on the left or right side of the screen.|
|:-----|:-----|:-----|:-----|
| `active` | `Boolean` | `false` | If true, the drawer will be active by default.|
| `className` | `String` | `''` | Sets a class to give customized styles to the drawer.|
| `hideable` | `Bool` | `true` | If true, the drawer will be hidden by clicking the overlay.|
| `type` | `String` | `left` | Type of drawer. It can be left or right to display the drawer on the left or right side of the screen.|
## Methods