Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Select API default value for input prop #8385

Merged
merged 2 commits into from
Sep 25, 2017
Merged

[docs] Select API default value for input prop #8385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd83ce1
[docs] Select API default value for input prop
kgregory Sep 25, 2017
70d7a2c
[docs] Default value with jsx being rendered on docs site. Instead, …
kgregory Sep 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/modules/utils/generateMarkdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ function generateProps(reactAPI) {
let defaultValue = '';

if (prop.defaultValue) {
defaultValue = prop.defaultValue.value.replace(/\n/g, '');
defaultValue = prop.defaultValue.value.replace(/\n/g, '').replace(/</g, '&lt;');
}

if (prop.required) {
Expand Down
2 changes: 1 addition & 1 deletion pages/api/checkbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
| disabledClassName | string | | The CSS class name of the root element when disabled. |
| icon | Node | | The icon to display when the component is unchecked. If a string is provided, it will be used as a font ligature. |
| indeterminate | boolean | false | If `true`, the component appears indeterminate. |
| indeterminateIcon | Node | <IndeterminateCheckBoxIcon /> | The icon to display when the component is indeterminate. If a string is provided, it will be used as a font ligature. |
| indeterminateIcon | Node | &lt;IndeterminateCheckBoxIcon /> | The icon to display when the component is indeterminate. If a string is provided, it will be used as a font ligature. |
| inputProps | Object | | Properties applied to the `input` element. |
| inputRef | Function | | Use that property to pass a ref callback to the native input component. |
| name | string | | |
Expand Down
12 changes: 7 additions & 5 deletions pages/api/drawer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ Any other properties supplied will be [spread to the root element](/customizatio

You can override all the class names injected by Material-UI thanks to the `classes` property.
This property accepts the following keys:
- `paper`
- `anchorLeft`
- `anchorRight`
- `anchorTop`
- `anchorBottom`
- `docked`
- `paper`
- `paperAnchorLeft`
- `paperAnchorRight`
- `paperAnchorTop`
- `paperAnchorBottom`
- `paperAnchorDockedLeft`
- `paperAnchorDockedRight`
- `modal`

Have a look at [overriding with classes](/customization/overrides#overriding-with-classes)
Expand Down
2 changes: 1 addition & 1 deletion pages/api/select.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| MenuProps | Object | | Properties applied to the `Menu` element. |
| <span style="color: #31a148">children *</span> | ChildrenArray | | The option elements to populate the select with. Can be some `MenuItem` when `native` is false and `option` when `native` is true. |
| classes | Object | | Useful to extend the style applied to components. |
| input | Element | <Input /> | An `Input` element. |
| input | Element | &lt;Input /> | An `Input` element. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is automatically generated, but follow a pattern close can help.
https://github.com/callemall/material-ui/blob/353f64d896eca71399c1e97a5c02d3ed5d78050c/docs/src/modules/utils/generateMarkdown.js#L42

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take care of it when parsing the default value

| multiple | boolean | false | If true, `value` must be an array and the menu will support multiple selections. |
| native | boolean | false | If `true`, the component will be using a native `select` element. |
| renderValue | Function | | Render the selected value. It's only useful when the `native` property is not set to `true`. |
Expand Down
14 changes: 6 additions & 8 deletions pages/api/table-cell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@
## Props
| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| checkbox | bool | false | If `true`, the cell padding will be adjusted to accommodate a checkbox. |
| children | node | | The table cell contents. |
| classes | object | | Useful to extend the style applied to components. |
| compact | bool | false | If `true`, compact cell padding will be used to accommodate more content. |
| component | string | null | The component used for the root node. Either a string to use a DOM element or a component. |
| disablePadding | bool | false | If `true`, left/right cell padding will be disabled. |
| numeric | bool | false | If `true`, content will align to the right. |
| children | Node | | The table cell contents. |
| classes | Object | | Useful to extend the style applied to components. |
| component | ElementType | null | The component used for the root node. Either a string to use a DOM element or a component. |
| numeric | boolean | false | If `true`, content will align to the right. |
| padding | union:&nbsp;'default'<br>&nbsp;'checkbox'<br>&nbsp;'dense'<br>&nbsp;'none'<br> | 'default' | Sets the padding applied to the cell. |

Any other properties supplied will be [spread to the root element](/customization/api#spread).

Expand All @@ -25,7 +23,7 @@ This property accepts the following keys:
- `numeric`
- `head`
- `padding`
- `compact`
- `dense`
- `checkbox`
- `footer`

Expand Down
8 changes: 4 additions & 4 deletions pages/api/table-row.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ based on the material table element parent (head, body, etc).
## Props
| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| children | node | | Should be valid `<tr>` children such as `TableCell`. |
| classes | object | | Useful to extend the style applied to components. |
| children | Node | | Should be valid `<tr>` children such as `TableCell`. |
| classes | Object | | Useful to extend the style applied to components. |
| component | string | 'tr' | The component used for the root node. Either a string to use a DOM element or a component. |
| hover | bool | false | If `true`, the table row will shade on hover. |
| selected | bool | false | If `true`, the table row will have the selected shading. |
| hover | boolean | false | If `true`, the table row will shade on hover. |
| selected | boolean | false | If `true`, the table row will have the selected shading. |

Any other properties supplied will be [spread to the root element](/customization/api#spread).

Expand Down
8 changes: 4 additions & 4 deletions pages/api/table-sort-label.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ A button based label for placing inside `TableCell` for column sorting.
## Props
| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| active | bool | false | If `true`, the label will have the active styling (should be true for the sorted column). |
| children | node | | Label contents, the arrow will be appended automatically. |
| classes | object | | Useful to extend the style applied to components. |
| direction | enum:&nbsp;'asc'<br>&nbsp;'desc'<br> | 'desc' | The current sort direction. |
| active | boolean | false | If `true`, the label will have the active styling (should be true for the sorted column). |
| children | Node | | Label contents, the arrow will be appended automatically. |
| classes | Object | | Useful to extend the style applied to components. |
| direction | union:&nbsp;'asc'<br>&nbsp;'desc'<br> | 'desc' | The current sort direction. |

Any other properties supplied will be [spread to the root element](/customization/api#spread).

Expand Down
1 change: 1 addition & 0 deletions pages/api/tabs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ This property accepts the following keys:
- `fixed`
- `scrollable`
- `centered`
- `buttonAuto`

Have a look at [overriding with classes](/customization/overrides#overriding-with-classes)
section for more detail.
Expand Down