Skip to content

Commit

Permalink
API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaldudak committed Oct 24, 2022
1 parent bf88525 commit 601d64b
Show file tree
Hide file tree
Showing 24 changed files with 103 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/pages/material-ui/api/autocomplete.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@
},
"default": "'medium'"
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }"
},
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/material-ui/api/avatar-group.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
"default": "{}"
},
"max": { "type": { "name": "custom", "description": "number" }, "default": "5" },
"slotProps": {
"type": { "name": "shape", "description": "{ additionalAvatar?: object }" },
"default": "{}"
},
"spacing": {
"type": {
"name": "union",
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/material-ui/api/backdrop.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@
"default": "{}"
},
"invisible": { "type": { "name": "bool" } },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/material-ui/api/filled-input.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"rows": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"slotProps": {
"type": { "name": "shape", "description": "{ input?: object, root?: object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" },
"default": "{}"
},
"startAdornment": { "type": { "name": "node" } },
"sx": {
"type": {
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/material-ui/api/form-control-label.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
"default": "'end'"
},
"onChange": { "type": { "name": "func" } },
"slotProps": {
"type": { "name": "shape", "description": "{ typography?: object }" },
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/material-ui/api/input-base.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@
"description": "'medium'<br>&#124;&nbsp;'small'<br>&#124;&nbsp;string"
}
},
"slotProps": {
"type": { "name": "shape", "description": "{ input?: object, root?: object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" },
"default": "{}"
},
"startAdornment": { "type": { "name": "node" } },
"sx": {
"type": {
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/material-ui/api/input.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"rows": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"slotProps": {
"type": { "name": "shape", "description": "{ input?: object, root?: object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" },
"default": "{}"
},
"startAdornment": { "type": { "name": "node" } },
"sx": {
"type": {
Expand Down
8 changes: 8 additions & 0 deletions docs/pages/material-ui/api/list-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@
"deprecated": true,
"deprecationInfo": "checkout <a href=\"/material-ui/api/list-item-button/\">ListItemButton</a> instead"
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/material-ui/api/outlined-input.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"rows": { "type": { "name": "union", "description": "number<br>&#124;&nbsp;string" } },
"slots": {
"type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" },
"default": "{}"
},
"startAdornment": { "type": { "name": "node" } },
"sx": {
"type": {
Expand Down
9 changes: 8 additions & 1 deletion docs/pages/material-ui/api/pagination-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"name": "shape",
"description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }"
},
"default": "{\n first: FirstPageIcon,\n last: LastPageIcon,\n next: NavigateNextIcon,\n previous: NavigateBeforeIcon,\n}"
"default": "{}"
},
"disabled": { "type": { "name": "bool" } },
"page": { "type": { "name": "node" } },
Expand All @@ -30,6 +30,13 @@
},
"default": "'medium'"
},
"slots": {
"type": {
"name": "shape",
"description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }"
},
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/material-ui/api/step-label.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
"error": { "type": { "name": "bool" } },
"icon": { "type": { "name": "node" } },
"optional": { "type": { "name": "node" } },
"slotProps": {
"type": { "name": "shape", "description": "{ label?: object }" },
"default": "{}"
},
"StepIconComponent": { "type": { "name": "elementType" } },
"StepIconProps": { "type": { "name": "object" } },
"sx": {
Expand Down
14 changes: 14 additions & 0 deletions docs/pages/material-ui/api/tooltip.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,20 @@
},
"PopperComponent": { "type": { "name": "elementType" }, "default": "Popper" },
"PopperProps": { "type": { "name": "object" }, "default": "{}" },
"slotProps": {
"type": {
"name": "shape",
"description": "{ arrow?: object, popper?: object, tooltip?: object, transition?: object }"
},
"default": "{}"
},
"slots": {
"type": {
"name": "shape",
"description": "{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }"
},
"default": "{}"
},
"sx": {
"type": {
"name": "union",
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/autocomplete/autocomplete.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"renderTags": "Render the selected value.<br><br><strong>Signature:</strong><br><code>function(value: Array&lt;T&gt;, getTagProps: function, ownerState: object) =&gt; ReactNode</code><br><em>value:</em> The <code>value</code> provided to the component.<br><em>getTagProps:</em> A tag props getter.<br><em>ownerState:</em> The state of the Autocomplete component.",
"selectOnFocus": "If <code>true</code>, the input&#39;s text is selected on focus. It helps the user clear the selected value.",
"size": "The size of the component.",
"slotProps": "The props used for each slot inside.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"value": "The value of the autocomplete.<br>The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the <code>isOptionEqualToValue</code> prop."
},
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/avatar-group/avatar-group.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"component": "The component used for the root node. Either a string to use a HTML element or a component.",
"componentsProps": "The props used for each slot inside the AvatarGroup.",
"max": "Max avatars to show before +x.",
"slotProps": "The props used for each slot inside the AvatarGroup.",
"spacing": "Spacing between avatars.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"total": "The total number of avatars. Used for calculating the number of extra avatars.",
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/backdrop/backdrop.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"componentsProps": "The props used for each slot inside the Backdrop.",
"invisible": "If <code>true</code>, the backdrop is invisible. It can be used when rendering a popover or a custom select component.",
"open": "If <code>true</code>, the component is shown.",
"slotProps": "The props used for each slot inside the Backdrop.",
"slots": "The components used for each slot inside the Backdrop. Either a string to use a HTML element or a component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"transitionDuration": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object."
},
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/filled-input/filled-input.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
"readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).",
"required": "If <code>true</code>, the <code>input</code> element is required. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component.",
"rows": "Number of rows to display when multiline option is set to true.",
"slotProps": "The props used for each slot inside the Input.",
"slots": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.",
"startAdornment": "Start <code>InputAdornment</code> for this component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"type": "Type of the <code>input</code> element. It should be <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types\">a valid HTML5 input type</a>.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"label": "A text or an element to be used in an enclosing label element.",
"labelPlacement": "The position of the label.",
"onChange": "Callback fired when the state is changed.<br><br><strong>Signature:</strong><br><code>function(event: React.SyntheticEvent) =&gt; void</code><br><em>event:</em> The event source of the callback. You can pull out the new checked state by accessing <code>event.target.checked</code> (boolean).",
"slotProps": "The props used for each slot inside.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"value": "The value of the component."
},
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/input-base/input-base.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
"required": "If <code>true</code>, the <code>input</code> element is required. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component.",
"rows": "Number of rows to display when multiline option is set to true.",
"size": "The size of the component.",
"slotProps": "The props used for each slot inside the Input.",
"slots": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.",
"startAdornment": "Start <code>InputAdornment</code> for this component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"type": "Type of the <code>input</code> element. It should be <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types\">a valid HTML5 input type</a>.",
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/input/input.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
"readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).",
"required": "If <code>true</code>, the <code>input</code> element is required. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component.",
"rows": "Number of rows to display when multiline option is set to true.",
"slotProps": "The props used for each slot inside the Input.",
"slots": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.",
"startAdornment": "Start <code>InputAdornment</code> for this component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"type": "Type of the <code>input</code> element. It should be <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types\">a valid HTML5 input type</a>.",
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/list-item/list-item.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
"divider": "If <code>true</code>, a 1px light border is added to the bottom of the list item.",
"secondaryAction": "The element to display at the end of ListItem.",
"selected": "Use to apply selected styling.",
"slotProps": "The props used for each slot inside the Input.",
"slots": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details."
},
"classDescriptions": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).",
"required": "If <code>true</code>, the <code>input</code> element is required. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component.",
"rows": "Number of rows to display when multiline option is set to true.",
"slots": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.",
"startAdornment": "Start <code>InputAdornment</code> for this component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"type": "Type of the <code>input</code> element. It should be <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types\">a valid HTML5 input type</a>.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"selected": "If <code>true</code> the pagination item is selected.",
"shape": "The shape of the pagination item.",
"size": "The size of the component.",
"slots": "The components used for each slot inside the PaginationItem. Either a string to use a HTML element or a component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"type": "The type of pagination item.",
"variant": "The variant to use."
Expand Down
1 change: 1 addition & 0 deletions docs/translations/api-docs/step-label/step-label.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"error": "If <code>true</code>, the step is marked as failed.",
"icon": "Override the default label of the step icon.",
"optional": "The optional node to display.",
"slotProps": "The props used for each slot inside.",
"StepIconComponent": "The component to render in place of the <a href=\"/material-ui/api/step-icon/\"><code>StepIcon</code></a>.",
"StepIconProps": "Props applied to the <a href=\"/material-ui/api/step-icon/\"><code>StepIcon</code></a> element.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details."
Expand Down
2 changes: 2 additions & 0 deletions docs/translations/api-docs/tooltip/tooltip.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
"placement": "Tooltip placement.",
"PopperComponent": "The component used for the popper.",
"PopperProps": "Props applied to the <a href=\"/material-ui/api/popper/\"><code>Popper</code></a> element.",
"slotProps": "The props used for each slot inside the Tooltip. Note that <code>componentsProps.popper</code> prop values win over <code>PopperProps</code> and <code>componentsProps.transition</code> prop values win over <code>TransitionProps</code> if both are applied.",
"slots": "The components used for each slot inside the Tooltip. Either a string to use a HTML element or a component.",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/getting-started/the-sx-prop/\">`sx` page</a> for more details.",
"title": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed.",
"TransitionComponent": "The component used for the transition. <a href=\"/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component.",
Expand Down

0 comments on commit 601d64b

Please sign in to comment.