diff --git a/docs/src/pages/demos/dividers/dividers.md b/docs/src/pages/demos/dividers/dividers.md index d3236e9dea48d4..4ae5dde83e171a 100644 --- a/docs/src/pages/demos/dividers/dividers.md +++ b/docs/src/pages/demos/dividers/dividers.md @@ -16,11 +16,14 @@ You can save rendering this DOM element by using the `divider` property on the ` {{"demo": "pages/demos/dividers/ListDividers.js"}} -## Inset Dividers +## HTML5 Specification -The following example demonstrates the `inset` variant. We need to make sure the `Divider` is rendered as a `li` to match the HTML5 specification. -The example shows two ways of achieving this. +The examples below show two ways of achieving this. + +## Inset Dividers + +The `inset` property has now been deprecated. You should now use `variant="inset"` {{"demo": "pages/demos/dividers/InsetDividers.js"}} diff --git a/packages/material-ui/src/Divider/Divider.js b/packages/material-ui/src/Divider/Divider.js index bc81436fb382c4..f3b040f705bfe3 100644 --- a/packages/material-ui/src/Divider/Divider.js +++ b/packages/material-ui/src/Divider/Divider.js @@ -106,6 +106,8 @@ Divider.propTypes = { component: PropTypes.oneOfType([PropTypes.string, PropTypes.func, PropTypes.object]), /** * If `true`, the divider will be indented. + * __WARNING__: `inset` is deprecated. + * Instead use `variant="inset"`. */ inset: chainPropTypes(PropTypes.bool, props => { /* istanbul ignore if */ diff --git a/pages/api/divider.md b/pages/api/divider.md index 1243244e85d532..0e1816b6948275 100644 --- a/pages/api/divider.md +++ b/pages/api/divider.md @@ -22,6 +22,7 @@ import Divider from '@material-ui/core/Divider'; | absolute | bool | false | | | classes | object |   | Override or extend the styles applied to the component. See [CSS API](#css-api) below for more details. | | component | union: string |
 func |
 object
| 'hr' | The component used for the root node. Either a string to use a DOM element or a component. | +| inset | bool |   | If `true`, the divider will be indented. __WARNING__: `inset` is deprecated. Instead use `variant="inset"`. | | light | bool | false | If `true`, the divider will have a lighter color. | | subheader | string |   | Divider subheader text. This will not work with `variant={'middle'}` | | variant | enum: 'fullBleed' |
 'inset' |
 'middle'
| 'fullBleed' | The variant to use. |