diff --git a/docs/pages/api/hidden.md b/docs/pages/api/hidden.md index 407861298f1122..3d6075cd73e4ee 100644 --- a/docs/pages/api/hidden.md +++ b/docs/pages/api/hidden.md @@ -31,7 +31,7 @@ Responsively hides children based on the selected implementation. | lgUp | bool | false | If true, screens this size and up will be hidden. | | mdDown | bool | false | If true, screens this size and down will be hidden. | | mdUp | bool | false | If true, screens this size and up will be hidden. | -| only | 'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| Array<'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'>
| | Hide the given breakpoint(s). | +| only | 'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| Array<'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'>
| | Hide the given breakpoint(s). | | smDown | bool | false | If true, screens this size and down will be hidden. | | smUp | bool | false | If true, screens this size and up will be hidden. | | xlDown | bool | false | If true, screens this size and down will be hidden. | diff --git a/docs/pages/api/slider.md b/docs/pages/api/slider.md index 6b653336e4a71a..9abaed322be30c 100644 --- a/docs/pages/api/slider.md +++ b/docs/pages/api/slider.md @@ -30,7 +30,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi | classes | object | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. | | color | 'primary'
| 'secondary'
| 'primary' | The color of the component. It supports those theme colors that make sense for this component. | | component | elementType | 'span' | The component used for the root node. Either a string to use a DOM element or a component. | -| defaultValue | number
| Array
| | The default element value. Use when the component is not controlled. | +| defaultValue | number
| Array<number>
| | The default element value. Use when the component is not controlled. | | disabled | bool | false | If `true`, the slider will be disabled. | | getAriaLabel | func | | Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider.

**Signature:**
`function(index: number) => string`
*index:* The thumb label's index to format. | | getAriaValueText | func | | Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider.

**Signature:**
`function(value: number, index: number) => string`
*value:* The thumb label's value to format.
*index:* The thumb label's index to format. | @@ -44,7 +44,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi | step | number | 1 | The granularity with which the slider can step through values. (A "discrete" slider.) When step is `null`, the thumb can only be slid onto marks provided with the `marks` prop. | | ThumbComponent | elementType | 'span' | The component used to display the value label. | | track | 'normal'
| false
| 'inverted'
| 'normal' | The track presentation:
- `normal` the track will render a bar representing the slider value. - `inverted` the track will render a bar representing the remaining slider value. - `false` the track will render without a bar. | -| value | number
| Array
| | The value of the slider. For ranged sliders, provide an array with two values. | +| value | number
| Array<number>
| | The value of the slider. For ranged sliders, provide an array with two values. | | ValueLabelComponent | elementType | ValueLabel | The value label component. | | valueLabelDisplay | 'on'
| 'auto'
| 'off'
| 'off' | Controls when the value label is displayed:
- `auto` the value label will display when the thumb is hovered or focused. - `on` will display persistently. - `off` will never display. | | valueLabelFormat | string
| func
| x => x | The format function the value label's value.
When a function is provided, it should have the following signature:
- {number} value The value label's value to format - {number} index The value label's index to format | diff --git a/docs/pages/api/tree-view.md b/docs/pages/api/tree-view.md index 21798b7208fcfc..e5edac0ec42cd5 100644 --- a/docs/pages/api/tree-view.md +++ b/docs/pages/api/tree-view.md @@ -28,10 +28,10 @@ You can learn more about the difference by [reading this guide](/guides/minimizi | classes | object | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. | | defaultCollapseIcon | node | | The default icon used to collapse the node. | | defaultEndIcon | node | | The default icon displayed next to a end node. This is applied to all tree nodes and can be overridden by the TreeItem `icon` prop. | -| defaultExpanded | Array | [] | Expanded node ids. (Uncontrolled) | +| defaultExpanded | Array<string> | [] | Expanded node ids. (Uncontrolled) | | defaultExpandIcon | node | | The default icon used to expand the node. | | defaultParentIcon | node | | The default icon displayed next to a parent node. This is applied to all parent nodes and can be overridden by the TreeItem `icon` prop. | -| expanded | Array | | Expanded node ids. (Controlled) | +| expanded | Array<string> | | Expanded node ids. (Controlled) | | onNodeToggle | func | | Callback fired when tree items are expanded/collapsed.

**Signature:**
`function(event: object, nodeIds: array) => void`
*event:* The event source of the callback
*nodeIds:* The ids of the expanded nodes. | The `ref` is forwarded to the root element. diff --git a/docs/src/modules/utils/generateMarkdown.js b/docs/src/modules/utils/generateMarkdown.js index b2fe747fd32650..841df23311458c 100644 --- a/docs/src/modules/utils/generateMarkdown.js +++ b/docs/src/modules/utils/generateMarkdown.js @@ -217,7 +217,7 @@ function generatePropType(type) { } case 'arrayOf': { - return `Array<${generatePropType(type.value)}>`; + return `Array<${generatePropType(type.value)}>`; } case 'instanceOf': { diff --git a/docs/src/pages/components/buttons/buttons.md b/docs/src/pages/components/buttons/buttons.md index f953af2bc14804..72c9c8f417044f 100644 --- a/docs/src/pages/components/buttons/buttons.md +++ b/docs/src/pages/components/buttons/buttons.md @@ -145,24 +145,26 @@ If you wish to use `not-allowed`, you have two options: 1. **CSS only**. You can remove the pointer events style on the disabled state of the ` - -``` + ```jsx + + + + ``` -This has the advantage of supporting any element, for instance, a link `` element. + This has the advantage of supporting any element, for instance, a link `` element. diff --git a/docs/src/pages/customization/theming/theming.md b/docs/src/pages/customization/theming/theming.md index 9e04ed98e4f1b1..c81df210ba607b 100644 --- a/docs/src/pages/customization/theming/theming.md +++ b/docs/src/pages/customization/theming/theming.md @@ -104,13 +104,13 @@ Generate responsive typography settings based on the options received. 1. `theme` (*Object*): The theme object to enhance. 2. `options` (*Object* [optional]): - - `breakpoints` (*Array* [optional]): Default to `['sm', 'md', 'lg']`. Array of [breakpoints](/customization/breakpoints/) (identifiers). + - `breakpoints` (*Array\* [optional]): Default to `['sm', 'md', 'lg']`. Array of [breakpoints](/customization/breakpoints/) (identifiers). - `disableAlign` (*Boolean* [optional]): Default to `false`. Whether font sizes change slightly so line heights are preserved and align to Material Design's 4px line height grid. This requires a unitless line height in the theme's styles. - `factor` (*Number* [optional]): Default to `2`. This value determines the strength of font size resizing. The higher the value, the less difference there is between font sizes on small screens. The lower the value, the bigger font sizes for small screens. The value must be greater than 1. - - `variants` (*Array* [optional]): Default to all. The typography variants to handle. + - `variants` (*Array\* [optional]): Default to all. The typography variants to handle. #### Returns diff --git a/docs/src/pages/discover-more/backers/backers.md b/docs/src/pages/discover-more/backers/backers.md index f74aa5a01fa69e..d6be6d979e344e 100644 --- a/docs/src/pages/discover-more/backers/backers.md +++ b/docs/src/pages/discover-more/backers/backers.md @@ -20,16 +20,16 @@ Gold Sponsors are those who have pledged $500/month and more to Material-UI. via [Patreon](https://www.patreon.com/oliviertassinari)

- creative-tim - tidelift - bitsrc + creative-tim + tidelift + bitsrc

via [OpenCollective](https://opencollective.com/material-ui)

- callemall - crosswordsolver + callemall + crosswordsolver

## Silver Sponsors diff --git a/docs/src/pages/getting-started/support/support.md b/docs/src/pages/getting-started/support/support.md index 671b5fb2c79a84..db4cf08dc08dd7 100644 --- a/docs/src/pages/getting-started/support/support.md +++ b/docs/src/pages/getting-started/support/support.md @@ -6,13 +6,13 @@ The community is your first stop for questions and advice about the framework. Welcome to the community! -### StackOverflow +### StackOverflow StackOverflow logo For crowdsourced technical questions from expert Material-UI devs in our community. Also frequented by the Material-UI core team. [Post a question](https://stackoverflow.com/questions/tagged/material-ui) -### GitHub +### GitHub GitHub logo We use GitHub issues exclusively as a bugs and feature requests tracker. If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported or fixed](https://github.com/mui-org/material-ui/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed). You can search through existing issues and pull requests to see if someone has reported one similar to yours. @@ -28,7 +28,7 @@ If you think you have found a bug, or have a new feature idea, please start by m - Please don't group multiple topics in one issue – each should have its own issue instead. - Please don't comment "+1" on an issue. It spams the maintainers and doesn't help move the issue forward. Use GitHub reactions instead (👍). -### Spectrum +### Spectrum Spectrum logo Chat with the community on Spectrum. If you feel your thread could be a StackOverflow question, go to StackOverflow instead. We lock/delete questions that are better asked on StackOverflow to avoid duplicates. @@ -46,7 +46,7 @@ New to Material-UI? It's easy to learn if you know where to start! [Learn Material-UI](/getting-started/learn/) -### Twitter +### Twitter Twitter logo Receive the latest news on Material-UI. @@ -108,7 +108,7 @@ A complete support package, for teams using Material-UI for critical business ap [Get a quote](mailto:advisory@material-ui.com) -### Tidelift subscription +### Tidelift subscription Tidelift logo Material-UI and the maintainers of thousands of other packages are working with Tidelift to deliver one enterprise subscription that covers all of the open-source you use. diff --git a/docs/src/pages/styles/api/api.md b/docs/src/pages/styles/api/api.md index e5dddbc8f4c4eb..d70a557dc14fae 100644 --- a/docs/src/pages/styles/api/api.md +++ b/docs/src/pages/styles/api/api.md @@ -212,7 +212,7 @@ It should preferably be used at **the root of your component tree**. | children * | node | | Your component tree. | | disableGeneration | bool | false | You can disable the generation of the styles with this option. It can be useful when traversing the React tree outside of the HTML rendering step on the server. Let's say you are using react-apollo to extract all the queries made by the interface server-side. You can significantly speed up the traversal with this property. | | generateClassName | func | | JSS's class name generator. | -| injectFirst | bool | false | By default, the styles are injected last in the element of the page. As a result, they gain more specificity than any other style sheet. If you want to override Material-UI's styles, set this prop. | +| injectFirst | bool | false | By default, the styles are injected last in the `` element of the page. As a result, they gain more specificity than any other style sheet. If you want to override Material-UI's styles, set this prop. | | jss | object | | JSS's instance. | #### Examples diff --git a/docs/static/images/logos/github.svg b/docs/static/images/logos/github.svg new file mode 100644 index 00000000000000..69a42a11025b76 --- /dev/null +++ b/docs/static/images/logos/github.svg @@ -0,0 +1 @@ + diff --git a/docs/static/images/logos/spectrum.svg b/docs/static/images/logos/spectrum.svg new file mode 100644 index 00000000000000..fc1fddfc452626 --- /dev/null +++ b/docs/static/images/logos/spectrum.svg @@ -0,0 +1 @@ + diff --git a/docs/static/images/logos/stackoverflow.svg b/docs/static/images/logos/stackoverflow.svg new file mode 100644 index 00000000000000..4bc56a7720c1ea --- /dev/null +++ b/docs/static/images/logos/stackoverflow.svg @@ -0,0 +1 @@ + diff --git a/docs/static/images/logos/tidelift.svg b/docs/static/images/logos/tidelift.svg new file mode 100644 index 00000000000000..ebb791cbbe9597 --- /dev/null +++ b/docs/static/images/logos/tidelift.svg @@ -0,0 +1 @@ + diff --git a/docs/static/images/logos/twitter.svg b/docs/static/images/logos/twitter.svg new file mode 100644 index 00000000000000..25b4c819573c82 --- /dev/null +++ b/docs/static/images/logos/twitter.svg @@ -0,0 +1 @@ +