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

[buildAPI] Fix deprecatedPropType #25

Open
wants to merge 1 commit into
base: feat/textfield-deprecated-props
Choose a base branch
from
Open

[buildAPI] Fix deprecatedPropType #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/api-docs/collapse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The `MuiCollapse` name can be used for providing [default props](/customization/
|:-----|:-----|:--------|:------------|
| <span class="prop-name">children</span> | <span class="prop-type">node</span> | | The content node to be collapsed. |
| <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
| ~~<span class="prop-name">collapsedHeight</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. The prop was renamed to support the vertical orientation, use `collapsedSize` instead<br><br>The height of the container when collapsed. |
| ~~<span class="prop-name">collapsedHeight</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. The prop was renamed to support the vertical orientation, use `collapsedSize` instead<br><br>The height of the container when collapsed. |
| <span class="prop-name">collapsedSize</span> | <span class="prop-type">number<br>&#124;&nbsp;string</span> | <span class="prop-default">'0px'</span> | The height of the container when collapsed. |
| <span class="prop-name">component</span> | <span class="prop-type">elementType</span> | <span class="prop-default">'div'</span> | The component used for the root node. Either a string to use a HTML element or a component. |
| <span class="prop-name">disableStrictModeCompat</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Enable this prop if you encounter 'Function components cannot be given refs', use `unstable_createStrictModeTheme`, and can't forward the ref in the passed `Component`. |
Expand Down
10 changes: 8 additions & 2 deletions docs/pages/api-docs/grid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,14 @@ The `MuiGrid` name can be used for providing [default props](/customization/glob
| <span class="prop-name">container</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | If `true`, the component will have the flex *container* behavior. You should be wrapping *items* with a *container*. |
| <span class="prop-name">direction</span> | <span class="prop-type">'row'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'column-reverse'</span> | <span class="prop-default">'row'</span> | Defines the `flex-direction` style property. It is applied for all screen sizes. |
| <span class="prop-name">item</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | If `true`, the component will have the flex *item* behavior. You should be wrapping *items* with a *container*. |
| ~~<span class="prop-name">justify</span>~~ | <span class="prop-type">oneOf([
'flex-start'</span> | | *Deprecated*. Use `justifyContent` instead, the prop was renamed.<br><br>Defines the `justify-content` style property. It is applied for all screen sizes. |
| ~~<span class="prop-name">justify</span>~~ | <span class="prop-type">PropTypes.oneOf([
'flex-start',
'center',
'flex-end',
'space-between',
'space-around',
'space-evenly',
])</span> | | *Deprecated*. Use `justifyContent` instead, the prop was renamed.<br><br>Defines the `justify-content` style property. It is applied for all screen sizes. |
| <span class="prop-name">justifyContent</span> | <span class="prop-type">'flex-start'<br>&#124;&nbsp;'center'<br>&#124;&nbsp;'flex-end'<br>&#124;&nbsp;'space-between'<br>&#124;&nbsp;'space-around'<br>&#124;&nbsp;'space-evenly'</span> | <span class="prop-default">'flex-start'</span> | Defines the `justify-content` style property. It is applied for all screen sizes. |
| <span class="prop-name">lg</span> | <span class="prop-type">false<br>&#124;&nbsp;'auto'<br>&#124;&nbsp;true<br>&#124;&nbsp;1<br>&#124;&nbsp;2<br>&#124;&nbsp;3<br>&#124;&nbsp;4<br>&#124;&nbsp;5<br>&#124;&nbsp;6<br>&#124;&nbsp;7<br>&#124;&nbsp;8<br>&#124;&nbsp;9<br>&#124;&nbsp;10<br>&#124;&nbsp;11<br>&#124;&nbsp;12</span> | <span class="prop-default">false</span> | Defines the number of grids the component is going to use. It's applied for the `lg` breakpoint and wider screens if not overridden. |
| <span class="prop-name">md</span> | <span class="prop-type">false<br>&#124;&nbsp;'auto'<br>&#124;&nbsp;true<br>&#124;&nbsp;1<br>&#124;&nbsp;2<br>&#124;&nbsp;3<br>&#124;&nbsp;4<br>&#124;&nbsp;5<br>&#124;&nbsp;6<br>&#124;&nbsp;7<br>&#124;&nbsp;8<br>&#124;&nbsp;9<br>&#124;&nbsp;10<br>&#124;&nbsp;11<br>&#124;&nbsp;12</span> | <span class="prop-default">false</span> | Defines the number of grids the component is going to use. It's applied for the `md` breakpoint and wider screens if not overridden. |
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/api-docs/image-list-item-bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The `MuiImageListItemBar` name can be used for providing [default props](/custom
| <span class="prop-name">position</span> | <span class="prop-type">'bottom'<br>&#124;&nbsp;'top'</span> | <span class="prop-default">'bottom'</span> | Position of the title bar. |
| <span class="prop-name">subtitle</span> | <span class="prop-type">node</span> | | String or element serving as subtitle (support text). |
| <span class="prop-name">title</span> | <span class="prop-type">node</span> | | Title to be displayed on item. |
| ~~<span class="prop-name">titlePosition</span>~~ | <span class="prop-type">oneOf(['bottom'</span> | | *Deprecated*. Use the `position` prop instead.<br><br>Position of the title bar. |
| ~~<span class="prop-name">titlePosition</span>~~ | <span class="prop-type">PropTypes.oneOf(['bottom', 'top'])</span> | | *Deprecated*. Use the `position` prop instead.<br><br>Position of the title bar. |

The `ref` is forwarded to the root element.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/api-docs/image-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The `MuiImageList` name can be used for providing [default props](/customization

| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| ~~<span class="prop-name">cellHeight</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use the `rowHeight` prop instead.<br><br>Cell height in `px`. Set to `'auto'` to let the children determine the height. |
| ~~<span class="prop-name">cellHeight</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.oneOf(['auto'])</span> | | *Deprecated*. Use the `rowHeight` prop instead.<br><br>Cell height in `px`. Set to `'auto'` to let the children determine the height. |
| <span class="prop-name">children</span> | <span class="prop-type">node</span> | | Items that will be in the image list. |
| <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
| <span class="prop-name">cols</span> | <span class="prop-type">number</span> | <span class="prop-default">2</span> | Number of columns. |
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/api-docs/text-field.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ The `MuiTextField` name can be used for providing [default props](/customization
| <span class="prop-name">onChange</span> | <span class="prop-type">func</span> | | Callback fired when the value is changed.<br><br>**Signature:**<br>`function(event: object) => void`<br>*event:* The event source of the callback. You can pull out the new value by accessing `event.target.value` (string). |
| <span class="prop-name">placeholder</span> | <span class="prop-type">string</span> | | The short hint displayed in the input before the user enters a value. |
| <span class="prop-name">required</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | If `true`, the label is displayed as required and the `input` element` will be required. |
| ~~<span class="prop-name">rows</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use `minRows` instead<br><br>Number of rows to display when multiline option is set to true. |
| ~~<span class="prop-name">rowsMax</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use `maxRows` instead<br><br>Maximum number of rows to display. |
| ~~<span class="prop-name">rows</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. Use `minRows` instead<br><br>Number of rows to display when multiline option is set to true. |
| ~~<span class="prop-name">rowsMax</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. Use `maxRows` instead<br><br>Maximum number of rows to display. |
| <span class="prop-name">select</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Render a [`Select`](/api/select/) element while passing the Input element to `Select` as `input` parameter. If this option is set you must pass the options of the select as children. |
| <span class="prop-name">SelectProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Select`](/api/select/) element. |
| <span class="prop-name">size</span> | <span class="prop-type">'medium'<br>&#124;&nbsp;'small'</span> | | The size of the text field. |
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/api-docs/textarea-autosize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
|:-----|:-----|:--------|:------------|
| <span class="prop-name">maxRows</span> | <span class="prop-type">number<br>&#124;&nbsp;string</span> | | Maximum number of rows to display. |
| <span class="prop-name">minRows</span> | <span class="prop-type">number<br>&#124;&nbsp;string</span> | <span class="prop-default">1</span> | Minimum number of rows to display. |
| ~~<span class="prop-name">rows</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use `minRows` instead.<br><br>Minimum number of rows to display. |
| ~~<span class="prop-name">rowsMax</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use `maxRows` instead.<br><br>Maximum number of rows to display. |
| ~~<span class="prop-name">rowsMin</span>~~ | <span class="prop-type">oneOfType([PropTypes.number</span> | | *Deprecated*. Use `minRows` instead.<br><br>Minimum number of rows to display. |
| ~~<span class="prop-name">rows</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. Use `minRows` instead.<br><br>Minimum number of rows to display. |
| ~~<span class="prop-name">rowsMax</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. Use `maxRows` instead.<br><br>Maximum number of rows to display. |
| ~~<span class="prop-name">rowsMin</span>~~ | <span class="prop-type">PropTypes.oneOfType([PropTypes.number, PropTypes.string])</span> | | *Deprecated*. Use `minRows` instead.<br><br>Minimum number of rows to display. |

The `ref` is forwarded to the root element.

Expand Down
10 changes: 8 additions & 2 deletions docs/src/modules/utils/generateMarkdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,21 @@ function generateHeader(reactAPI) {
return ['---', `filename: ${normalizePath(reactAPI.filename)}`, '---'].join('\n');
}

function getPropTypeString(str) {
if(str.indexOf('oneOfType') >= 0 || str.indexOf('oneOf') >= 0) {
return 'PropTypes.' + str.substring(0, str.indexOf(')') + 1);
}
return str.substring(0, str.indexOf(','));
}

function getDeprecatedInfo(type) {
const marker = /deprecatedPropType\((\r*\n)*\s*PropTypes\./g;
const match = type.raw.match(marker);
const startIndex = type.raw.search(marker);
if (match) {
const offset = match[0].length;

return {
propTypes: type.raw.substring(startIndex + offset, type.raw.indexOf(',')),
propTypes: getPropTypeString(type.raw.substring(startIndex + offset, type.raw.length)),
explanation: recast.parse(type.raw).program.body[0].expression.arguments[1].value,
};
}
Expand Down