From 007d3cdc83980ac819add1db10e77769f15b0ec7 Mon Sep 17 00:00:00 2001 From: Chen Oppenhaim Date: Sat, 14 Jul 2018 15:58:37 +0300 Subject: [PATCH] added 3 exports and ran yarn docs:api --- packages/material-ui/.size-snapshot.json | 6 +-- .../material-ui/src/TableBody/TableBody.js | 2 +- .../src/TableFooter/TableFooter.js | 2 +- pages/api/button-base.md | 6 +-- pages/api/checkbox.md | 2 +- pages/api/fade.md | 4 +- pages/api/form-control-label.md | 4 +- pages/api/input.md | 2 +- pages/api/native-select.md | 2 +- pages/api/popover.md | 6 +-- pages/api/radio-group.md | 2 +- pages/api/radio.md | 2 +- pages/api/select.md | 2 +- pages/api/slide.md | 4 +- pages/api/snackbar.md | 4 +- pages/api/switch-base.md | 2 +- pages/api/switch.md | 2 +- pages/api/table-body.md | 14 +++++++ pages/api/table-footer.md | 14 +++++++ pages/api/tabs.md | 2 +- pages/api/text-field.md | 40 +++++++++---------- pages/api/typography.md | 2 +- pages/api/zoom.md | 6 +-- pages/lab/api/speed-dial.md | 2 +- pages/lab/api/toggle-button-group.md | 2 +- test/regressions/tests/Paper/SimplePaper.js | 2 +- 26 files changed, 83 insertions(+), 55 deletions(-) diff --git a/packages/material-ui/.size-snapshot.json b/packages/material-ui/.size-snapshot.json index c021a36ebe400f..d551b00f0b554c 100644 --- a/packages/material-ui/.size-snapshot.json +++ b/packages/material-ui/.size-snapshot.json @@ -1,7 +1,7 @@ { "build/umd/material-ui.production.min.js": { - "bundled": 820697, - "minified": 320569, - "gzipped": 85623 + "bundled": 712602, + "minified": 292116, + "gzipped": 77174 } } diff --git a/packages/material-ui/src/TableBody/TableBody.js b/packages/material-ui/src/TableBody/TableBody.js index a73144da7f5a59..5090d85434632c 100644 --- a/packages/material-ui/src/TableBody/TableBody.js +++ b/packages/material-ui/src/TableBody/TableBody.js @@ -3,7 +3,7 @@ import PropTypes from 'prop-types'; import classNames from 'classnames'; import withStyles from '../styles/withStyles'; -const styles = { +export const styles = { root: { display: 'table-row-group', }, diff --git a/packages/material-ui/src/TableFooter/TableFooter.js b/packages/material-ui/src/TableFooter/TableFooter.js index 7466ab2e564468..9754ebcfd68bfb 100644 --- a/packages/material-ui/src/TableFooter/TableFooter.js +++ b/packages/material-ui/src/TableFooter/TableFooter.js @@ -3,7 +3,7 @@ import PropTypes from 'prop-types'; import classNames from 'classnames'; import withStyles from '../styles/withStyles'; -const styles = { +export const styles = { root: { display: 'table-footer-group', }, diff --git a/pages/api/button-base.md b/pages/api/button-base.md index cd96329f3b5242..ba9d513ad076f5 100644 --- a/pages/api/button-base.md +++ b/pages/api/button-base.md @@ -9,15 +9,15 @@ title: ButtonBase API

The API documentation of the ButtonBase React component.

-`ButtonBase` contains as few styles as possible. -It aims to be a simple building block for creating a button. +`ButtonBase` contains as few styles as possible. +It aims to be a simple building block for creating a button. It contains a load of style reset and some focus/ripple logic. ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| -| action | func |   | Callback fired when the component mounts. This is useful when you want to trigger an action programmatically. It currently only supports `focusVisible()` action.

**Signature:**
`function(actions: object) => void`
*actions:* This object contains all possible actions that can be triggered programmatically. | +| action | func |   | Callback fired when the component mounts. This is useful when you want to trigger an action programmatically. It currently only supports `focusVisible()` action.

**Signature:**
`function(actions: object) => void`
*actions:* This object contains all possible actions that can be triggered programmatically. | | buttonRef | union: func |
 object
|   | Use that property to pass a ref callback to the native button component. | | centerRipple | bool | false | If `true`, the ripples will be centered. They won't start at the cursor interaction position. | | children | node |   | The content of the component. | diff --git a/pages/api/checkbox.md b/pages/api/checkbox.md index e5e01eb2bf90ed..96daa70da39aa7 100644 --- a/pages/api/checkbox.md +++ b/pages/api/checkbox.md @@ -27,7 +27,7 @@ title: Checkbox API | indeterminateIcon | node | <IndeterminateCheckBoxIcon /> | The icon to display when the component is indeterminate. | | inputProps | object |   | Properties applied to the `input` element. | | inputRef | union: func |
 object
|   | Use that property to pass a ref callback to the native input component. | -| onChange | func |   | Callback fired when the state is changed.

**Signature:**
`function(event: object, checked: boolean) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.checked`.
*checked:* The `checked` value of the switch | +| onChange | func |   | Callback fired when the state is changed.

**Signature:**
`function(event: object, checked: boolean) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.checked`.
*checked:* The `checked` value of the switch | | type | string |   | The input component property `type`. | | value | string |   | The value of the component. | diff --git a/pages/api/fade.md b/pages/api/fade.md index 2c5a7f0b4005f1..74b912c2a25e18 100644 --- a/pages/api/fade.md +++ b/pages/api/fade.md @@ -9,7 +9,7 @@ title: Fade API

The API documentation of the Fade React component.

-The Fade transition is used by the [Modal](/utils/modal) component. +The Fade transition is used by the [Modal](/utils/modal) component. It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally. ## Props @@ -18,7 +18,7 @@ It uses [react-transition-group](https://github.com/reactjs/react-transition-gro |:-----|:-----|:--------|:------------| | children | union: element |
 func
|   | A single child content element. | | in | bool |   | If `true`, the component will transition in. | -| timeout | union: number |
 { enter?: number, exit?: number }
| { enter: duration.enteringScreen, exit: duration.leavingScreen,} | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. | +| timeout | union: number |
 { enter?: number, exit?: number }
| { enter: duration.enteringScreen, exit: duration.leavingScreen, } | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. | Any other properties supplied will be spread to the root element ([Transition](https://reactcommunity.org/react-transition-group/#Transition)). diff --git a/pages/api/form-control-label.md b/pages/api/form-control-label.md index 9782dfd0ffdfc6..793d8557407591 100644 --- a/pages/api/form-control-label.md +++ b/pages/api/form-control-label.md @@ -9,7 +9,7 @@ title: FormControlLabel API

The API documentation of the FormControlLabel React component.

-Drop in replacement of the `Radio`, `Switch` and `Checkbox` component. +Drop in replacement of the `Radio`, `Switch` and `Checkbox` component. Use this component if you want to display an extra label. ## Props @@ -23,7 +23,7 @@ Use this component if you want to display an extra label. | inputRef | union: func |
 object
|   | Use that property to pass a ref callback to the native input component. | | label | node |   | The text to be used in an enclosing label element. | | name | string |   | | -| onChange | func |   | Callback fired when the state is changed.

**Signature:**
`function(event: object, checked: boolean) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.checked`.
*checked:* The `checked` value of the switch | +| onChange | func |   | Callback fired when the state is changed.

**Signature:**
`function(event: object, checked: boolean) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.checked`.
*checked:* The `checked` value of the switch | | value | string |   | The value of the component. | Any other properties supplied will be spread to the root element (native element). diff --git a/pages/api/input.md b/pages/api/input.md index f11748a0147ee4..d1711ec03d67db 100644 --- a/pages/api/input.md +++ b/pages/api/input.md @@ -32,7 +32,7 @@ title: Input API | margin | enum: 'dense' |
 'none'
|   | If `dense`, will adjust vertical spacing. This is normally obtained via context from FormControl. | | multiline | bool | false | If `true`, a textarea element will be rendered. | | name | string |   | Name attribute of the `input` element. | -| onChange | func |   | Callback fired when the value is changed.

**Signature:**
`function(event: object) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.value`. | +| onChange | func |   | Callback fired when the value is changed.

**Signature:**
`function(event: object) => void`
*event:* The event source of the callback. You can pull out the new value by accessing `event.target.value`. | | placeholder | string |   | The short hint displayed in the input before the user enters a value. | | rows | union: string |
 number
|   | Number of rows to display when multiline option is set to true. | | rowsMax | union: string |
 number
|   | Maximum number of rows to display when multiline option is set to true. | diff --git a/pages/api/native-select.md b/pages/api/native-select.md index 3e56b9638c219b..4bcbf62f056a49 100644 --- a/pages/api/native-select.md +++ b/pages/api/native-select.md @@ -20,7 +20,7 @@ An alternative to `