From bbabcc143fb4bae7e1b5bb29257e474d351c9539 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 26 May 2023 18:08:13 +0200 Subject: [PATCH 01/85] WIP --- docs/src/modules/components/ApiPage.js | 10 +- .../modules/components/ApiPage/ApiItem.tsx | 159 ++++++++++++++ .../modules/components/ApiPage/CSSList.tsx | 118 +++++++++++ .../src/modules/components/PropertiesTable.js | 194 ++++++++---------- 4 files changed, 370 insertions(+), 111 deletions(-) create mode 100644 docs/src/modules/components/ApiPage/ApiItem.tsx create mode 100644 docs/src/modules/components/ApiPage/CSSList.tsx diff --git a/docs/src/modules/components/ApiPage.js b/docs/src/modules/components/ApiPage.js index 448ddc0b4bbdfb..bb3ba8521e682e 100644 --- a/docs/src/modules/components/ApiPage.js +++ b/docs/src/modules/components/ApiPage.js @@ -11,6 +11,7 @@ import MarkdownElement from 'docs/src/modules/components/MarkdownElement'; import AppLayoutDocs from 'docs/src/modules/components/AppLayoutDocs'; import Ad from 'docs/src/modules/components/Ad'; import { sxChip } from './AppNavDrawerItem'; +import CSSList from './ApiPage/CSSList'; function CSSTable(props) { const { componentStyles, classDescriptions } = props; @@ -426,7 +427,7 @@ import { ${pageContent.name} } from '${source}';`}

- +

- - + + diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx new file mode 100644 index 00000000000000..2ecd3a67627145 --- /dev/null +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -0,0 +1,159 @@ +/* eslint-disable react/no-danger */ +import * as React from 'react'; +import PropTypes from 'prop-types'; +import { alpha, styled } from '@mui/material/styles'; +import { green, grey, lightBlue } from '@mui/material/colors'; +import { + brandingDarkTheme as darkTheme, + brandingLightTheme as lightTheme, +} from 'docs/src/modules/brandingTheme'; + +const Root = styled('div')( + ({ theme }) => ({ + '& .MuiApi-item-header': { + ...theme.typography.caption, + display: 'flex', + position: 'relative', + textDecoration: 'none', + marginBottom: '12px', + '& .MuiApi-item-link-visual': { + display: 'none', + border: 'solid 1px', + borderRadius: '4px', + borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + width: '24px', + height: '24px', + textAlign: 'center', + lineHeight: '24px', + position: 'absolute', + left: '-32px', + '& svg': { + fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + height: '11px', + width: '11px', + }, + }, + span: { + borderBottom: 'solid 1px', + borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, + padding: '2px 6px', + }, + '& .MuiApi-item-title': { + borderWidth: '1px', + borderStyle: 'solid', + borderTopLeftRadius: '4px', + borderTopRightRadius: '4px', + borderBottomLeftRadius: '4px', + color: `var(--muidocs-palette-primary-700, ${lightTheme.palette.primary[700]})`, + fontWeight: theme.typography.fontWeightSemiBold, + backgroundColor: grey[200], + }, + '& .MuiApi-item-description': { + flexGrow: 1, + color: `var(--muidocs-palette-text-primary, ${lightTheme.palette.text.primary})`, + }, + '& .MuiApi-item-note': { + padding: '2px 6px', + color: `var(--muidocs-palette-green-800, ${green[800]})`, + }, + '&:hover, &:target': { + '.MuiApi-item-link-visual': { display: 'inline-block' }, + }, + '&:hover': { + cursor: 'pointer', + span: { + borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + }, + '.MuiApi-item-title': { + backgroundColor: alpha(lightBlue[100], 0.5), + }, + '& .MuiApi-item-link-visual': {}, + }, + }, + marginBottom: 32, + }), + ({ theme }) => ({ + [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { + color: 'rgb(255, 255, 255)', + '& .MuiApi-item-header': { + '& span': { + borderColor: '#2F3A46', + }, + '& .MuiApi-item-title': { + color: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, + backgroundColor: '#1F262E', + }, + '& .MuiApi-item-link-visual': { + borderColor: '#2F3A46', + backgroundColor: '#1F262E', + '& svg': { + fill: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, + }, + }, + '&:hover': { + span: { + borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + }, + '.MuiApi-item-title': { + backgroundColor: `var(--muidocs-palette-primary-light-200, #0059B24D) / 30%`, + }, + '& .MuiApi-item-link-visual': { + borderColor: `var(--muidocs-palette-primary-400, ${lightTheme.palette.primary[400]})`, + backgroundColor: `var(--muidocs-palette-primary-light-200, #0059B24D) / 30%`, + }, + }, + '&:hover, &:target': { + '& .MuiApi-item-link-visual': { + display: 'inline-block', + }, + }, + '& .MuiApi-item-description': { + color: '#B2BAC2', + }, + '& .MuiApi-item-note': { + color: `var(--muidocs-palette-green-400, ${green[400]})`, + }, + }, + }, + }), +); + +export type ApiItemProps = { + id: string; + title: string; + description?: string; + note?: string; + children: React.ReactNode; +}; + +function ApiItem(props: ApiItemProps) { + const { title, description, note, children, id } = props; + return ( + + +

+ + + +
+ {title} + /g, ' '), + }} + /> + {note && {note}} + + {children} + + ); +} + +ApiItem.propTypes = { + description: PropTypes.string, + note: PropTypes.string, + title: PropTypes.string.isRequired, +}; + +export default ApiItem; diff --git a/docs/src/modules/components/ApiPage/CSSList.tsx b/docs/src/modules/components/ApiPage/CSSList.tsx new file mode 100644 index 00000000000000..21f3c755408f4f --- /dev/null +++ b/docs/src/modules/components/ApiPage/CSSList.tsx @@ -0,0 +1,118 @@ +/* eslint-disable react/no-danger */ +import * as React from 'react'; +import PropTypes from 'prop-types'; + +import { useTranslate } from 'docs/src/modules/utils/i18n'; +import ApiItem from './ApiItem'; + +export type CSSListProps = { + componentStyles: { + classes: string[]; + globalClasses: { [classeKey: string]: string }; + name: null | string; + }; + classDescriptions: { + [classeKey: string]: { + description: string; + nodeName?: string; + conditions?: string; + }; + }; +}; + +export default function CSSList(props: CSSListProps) { + const { componentStyles, classDescriptions } = props; + // const t = useTranslate(); + + return ( + + {/*
  • + Prop this is a class + Required +
    • + + + + + + + + + */} + {componentStyles.classes.map((className) => { + const isGlobalStateClass = !!componentStyles.globalClasses[className]; + return ( + +

    + + //

    + // + // + // + ); + })} + {/* +
    {t('api-docs.ruleName')}{t('api-docs.globalClass')}{t('api-docs.description')}
    + // + // {isGlobalStateClass ? ( + // + // {className} + // + // + // ) : ( + // className + // )} + // + // + // + // . + // {componentStyles.globalClasses[className] || + // `${componentStyles.name}-${className}`} + // + // + //
    */} +     + ); +} + +CSSList.propTypes = { + classDescriptions: PropTypes.object.isRequired, + componentStyles: PropTypes.object.isRequired, +}; diff --git a/docs/src/modules/components/PropertiesTable.js b/docs/src/modules/components/PropertiesTable.js index f36a97aa1e4a1c..805913c47c9259 100644 --- a/docs/src/modules/components/PropertiesTable.js +++ b/docs/src/modules/components/PropertiesTable.js @@ -1,125 +1,103 @@ /* eslint-disable react/no-danger */ import * as React from 'react'; import PropTypes from 'prop-types'; -import clsx from 'clsx'; -import Alert from '@mui/material/Alert'; -import { alpha, styled } from '@mui/material/styles'; +import { styled } from '@mui/material/styles'; import { useTranslate } from 'docs/src/modules/utils/i18n'; - -const Asterisk = styled('abbr')(({ theme }) => ({ color: theme.palette.error.main })); +import ApiItem from './ApiPage/ApiItem'; const Wrapper = styled('div')({ - overflow: 'hidden', -}); -const Table = styled('table')(({ theme }) => { - const contentColor = 'rgba(255, 255, 255, 1)'; - const contentColorDark = alpha(theme.palette.primaryDark[900], 1); - const contentColorTransparent = 'rgba(255, 255, 255, 0)'; - const contentColorTransparentDark = alpha(theme.palette.primaryDark[900], 0); - const shadowColor = 'rgba(0,0,0,0.2)'; - const shadowColorDark = 'rgba(0,0,0,0.7)'; - return { - borderRadius: 10, - background: ` - linear-gradient(to right, ${contentColor} 5%, ${contentColorTransparent}), - linear-gradient(to right, ${contentColorTransparent}, ${contentColor} 100%) 100%, - linear-gradient(to right, ${shadowColor}, rgba(0, 0, 0, 0) 5%), - linear-gradient(to left, ${shadowColor}, rgba(0, 0, 0, 0) 5%)`, - backgroundAttachment: 'local, local, scroll, scroll', - // the above background create thin line on the left and right sides of the table - // as a workaround, use negative margin with overflow `hidden` on the parent - marginLeft: -1, - marginRight: -1, - ...theme.applyDarkStyles({ - background: ` - linear-gradient(to right, ${contentColorDark} 5%, ${contentColorTransparentDark}), - linear-gradient(to right, ${contentColorTransparentDark}, ${contentColorDark} 100%) 100%, - linear-gradient(to right, ${shadowColorDark}, rgba(0, 0, 0, 0) 5%), - linear-gradient(to left, ${shadowColorDark}, rgba(0, 0, 0, 0) 5%)`, - }), - }; + // overflow: 'hidden', }); export default function PropertiesTable(props) { const { properties, propertiesDescriptions, showOptionalAbbr = false } = props; const t = useTranslate(); - const showDefaultPropColumn = Object.entries(properties).some( - ([, propData]) => propData.default != null, - ); - return ( - - - - - - {showDefaultPropColumn && } - - - - - {Object.entries(properties).map(([propName, propData]) => { - const typeName = propData.type.description || propData.type.name; - const propDefault = propData.default; - return ( - propData.description !== '@ignore' && ( - - - - {showDefaultPropColumn && ( - - )} - - - ) - ); - })} - -
    {t('api-docs.name')}{t('api-docs.type')}{t('api-docs.default')}{t('api-docs.description')}
    - - {propName} - {propData.required && !showOptionalAbbr && ( - - * - - )} - {!propData.required && showOptionalAbbr && ( - - ? - - )} - - - - - {propDefault && {propDefault}} - - {propData.deprecated && ( - - {t('api-docs.deprecated')} - {propData.deprecationInfo && ' - '} - {propData.deprecationInfo && ( - - )} - - )} -
    -
    + {Object.entries(properties) + .filter(([, propData]) => propData.description !== '@ignore') + .map(([propName, propData]) => { + // ApiItem + const typeName = propData.type.description || propData.type.name; + const propDefault = propData.default; + return ( + +

    + {propDefault && ( +

    + {t('api-docs.default')}: {propDefault} +

    + )} +     + ); + // + // + // + // {propName} + // {propData.required && !showOptionalAbbr && ( + // + // * + // + // )} + // {!propData.required && showOptionalAbbr && ( + // + // ? + // + // )} + // + // + // + // + // + // {showDefaultPropColumn && ( + // + // {propDefault && {propDefault}} + // + // )} + // + // {propData.deprecated && ( + // + // {t('api-docs.deprecated')} + // {propData.deprecationInfo && ' - '} + // {propData.deprecationInfo && ( + // + // )} + // + // )} + //
    + // + // + // ); + })} + {/* + */} ); } From 5e85fe41b06ef2d49c218281e69fe0dd9a0f1c22 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 26 May 2023 18:15:24 +0200 Subject: [PATCH 02/85] add alerts --- .../src/modules/components/PropertiesTable.js | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/src/modules/components/PropertiesTable.js b/docs/src/modules/components/PropertiesTable.js index 805913c47c9259..5986615ae0817f 100644 --- a/docs/src/modules/components/PropertiesTable.js +++ b/docs/src/modules/components/PropertiesTable.js @@ -2,6 +2,7 @@ import * as React from 'react'; import PropTypes from 'prop-types'; import { styled } from '@mui/material/styles'; +import Alert from '@mui/material/Alert'; import { useTranslate } from 'docs/src/modules/utils/i18n'; import ApiItem from './ApiPage/ApiItem'; @@ -42,6 +43,19 @@ export default function PropertiesTable(props) { {t('api-docs.default')}: {propDefault}

    )} + {propData.deprecated && ( + + {t('api-docs.deprecated')} + {propData.deprecationInfo && ' - '} + {propData.deprecationInfo && ( + + )} + + )} ); // @@ -74,19 +88,7 @@ export default function PropertiesTable(props) { // // )} // - // {propData.deprecated && ( - // - // {t('api-docs.deprecated')} - // {propData.deprecationInfo && ' - '} - // {propData.deprecationInfo && ( - // - // )} - // - // )} + //
    Date: Mon, 29 May 2023 10:40:43 +0200 Subject: [PATCH 03/85] use `
  • ` instead of `
    ` for listing props description --- .../api-docs-base/modal/modal.json | 2 +- .../api-docs-base/slider/slider.json | 8 +++--- .../api-docs-base/snackbar/snackbar.json | 2 +- .../api-docs-base/switch/switch.json | 2 +- .../table-pagination/table-pagination.json | 6 ++--- .../autocomplete/autocomplete.json | 26 +++++++++---------- .../api-docs-joy/checkbox/checkbox.json | 2 +- .../api-docs-joy/modal/modal.json | 2 +- .../api-docs-joy/radio-group/radio-group.json | 2 +- .../api-docs-joy/radio/radio.json | 2 +- .../api-docs-joy/slider/slider.json | 8 +++--- .../api-docs-joy/switch/switch.json | 2 +- .../api-docs-joy/tooltip/tooltip.json | 4 +-- .../api-docs/accordion/accordion.json | 2 +- docs/translations/api-docs/alert/alert.json | 2 +- .../api-docs/autocomplete/autocomplete.json | 26 +++++++++---------- .../bottom-navigation/bottom-navigation.json | 2 +- .../api-docs/checkbox/checkbox.json | 2 +- docs/translations/api-docs/dialog/dialog.json | 2 +- docs/translations/api-docs/drawer/drawer.json | 2 +- .../api-docs/filled-input/filled-input.json | 2 +- .../form-control-label.json | 2 +- .../api-docs/input-base/input-base.json | 2 +- docs/translations/api-docs/input/input.json | 2 +- docs/translations/api-docs/menu/menu.json | 2 +- docs/translations/api-docs/modal/modal.json | 2 +- .../api-docs/native-select/native-select.json | 2 +- .../outlined-input/outlined-input.json | 2 +- .../api-docs/pagination/pagination.json | 6 ++--- .../api-docs/radio-group/radio-group.json | 2 +- docs/translations/api-docs/radio/radio.json | 2 +- docs/translations/api-docs/rating/rating.json | 6 ++--- docs/translations/api-docs/select/select.json | 8 +++--- docs/translations/api-docs/slider/slider.json | 8 +++--- .../api-docs/snackbar/snackbar.json | 2 +- .../api-docs/speed-dial/speed-dial.json | 4 +-- .../swipeable-drawer/swipeable-drawer.json | 4 +-- docs/translations/api-docs/switch/switch.json | 2 +- .../table-pagination/table-pagination.json | 6 ++--- docs/translations/api-docs/tabs/tabs.json | 2 +- .../api-docs/text-field/text-field.json | 2 +- .../toggle-button-group.json | 2 +- .../api-docs/toggle-button/toggle-button.json | 4 +-- .../api-docs/tooltip/tooltip.json | 4 +-- .../api-docs/tree-view/tree-view.json | 6 ++--- .../utils/generatePropDescription.ts | 15 ++++++++--- 46 files changed, 107 insertions(+), 100 deletions(-) diff --git a/docs/translations/api-docs-base/modal/modal.json b/docs/translations/api-docs-base/modal/modal.json index 0ce4a100e2ce69..2b9d618ebd1f91 100644 --- a/docs/translations/api-docs-base/modal/modal.json +++ b/docs/translations/api-docs-base/modal/modal.json @@ -13,7 +13,7 @@ "hideBackdrop": "If true, the backdrop is not rendered.", "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "escapeKeyDown", "backdropClick".", + "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", "open": "If true, the component is shown.", "slotProps": "The props used for each slot inside the Modal.", "slots": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component. See Slots API below for more details." diff --git a/docs/translations/api-docs-base/slider/slider.json b/docs/translations/api-docs-base/slider/slider.json index 0feee17949c0d9..eb3a26a4f433ac 100644 --- a/docs/translations/api-docs-base/slider/slider.json +++ b/docs/translations/api-docs-base/slider/slider.json @@ -7,15 +7,15 @@ "defaultValue": "The default value. Use when the component is not controlled.", "disabled": "If true, the component is disabled.", "disableSwap": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    index: The thumb label's index to format.", - "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    value: The thumb label's value to format.
    index: The thumb label's index to format.", + "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    • index: The thumb label's index to format.
    ", + "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    • value: The thumb label's value to format.
    • index: The thumb label's index to format.
    ", "isRtl": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", "marks": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", "max": "The maximum allowed value of the slider. Should not be equal to min.", "min": "The minimum allowed value of the slider. Should not be equal to max.", "name": "Name attribute of the hidden input element.", - "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    value: The new value.
    activeThumb: Index of the currently moved thumb.", - "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    value: The new value.", + "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    • value: The new value.
    • activeThumb: Index of the currently moved thumb.
    ", + "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: The new value.
    ", "orientation": "The component orientation.", "scale": "A transformation function, to change the scale of the slider.

    Signature:
    function(x: any) => any
    ", "slotProps": "The props used for each slot inside the Slider.", diff --git a/docs/translations/api-docs-base/snackbar/snackbar.json b/docs/translations/api-docs-base/snackbar/snackbar.json index 256e9ea68748c1..36580b71397907 100644 --- a/docs/translations/api-docs-base/snackbar/snackbar.json +++ b/docs/translations/api-docs-base/snackbar/snackbar.json @@ -4,7 +4,7 @@ "autoHideDuration": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value.", "disableWindowBlurListener": "If true, the autoHideDuration timer will expire even if the window is not focused.", "exited": "The prop used to handle exited transition and unmount the component.", - "onClose": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

    Signature:
    function(event: React.SyntheticEvent<any> | Event, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown".", + "onClose": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

    Signature:
    function(event: React.SyntheticEvent<any> | Event, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown".
    ", "open": "If true, the component is shown.", "resumeHideDuration": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.", "slotProps": "The props used for each slot inside the Snackbar.", diff --git a/docs/translations/api-docs-base/switch/switch.json b/docs/translations/api-docs-base/switch/switch.json index 6b8dc299327fc0..663434e38131bc 100644 --- a/docs/translations/api-docs-base/switch/switch.json +++ b/docs/translations/api-docs-base/switch/switch.json @@ -4,7 +4,7 @@ "checked": "If true, the component is checked.", "defaultChecked": "The default checked state. Use when the component is not controlled.", "disabled": "If true, the component is disabled.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "readOnly": "If true, the component is read only.", "required": "If true, the input element is required.", "slotProps": "The props used for each slot inside the Switch.", diff --git a/docs/translations/api-docs-base/table-pagination/table-pagination.json b/docs/translations/api-docs-base/table-pagination/table-pagination.json index 2c1a32a8a168cf..ed6450b2309fe3 100644 --- a/docs/translations/api-docs-base/table-pagination/table-pagination.json +++ b/docs/translations/api-docs-base/table-pagination/table-pagination.json @@ -2,12 +2,12 @@ "componentDescription": "A pagination for tables.", "propDescriptions": { "count": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1.", - "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string) => string
    type: The link or button type to format ('first' | 'last' | 'next' | 'previous').", + "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string) => string
    • type: The link or button type to format ('first' | 'last' | 'next' | 'previous').
    ", "labelDisplayedRows": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations.", "labelId": "Id of the label element within the pagination.", "labelRowsPerPage": "Customize the rows per page label.
    For localization purposes, you can use the provided translations.", - "onPageChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
    event: The event source of the callback.
    page: The page selected.", - "onRowsPerPageChange": "Callback fired when the number of rows per page is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback.", + "onPageChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
    • event: The event source of the callback.
    • page: The page selected.
    ", + "onRowsPerPageChange": "Callback fired when the number of rows per page is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback.
    ", "page": "The zero-based index of the current page.", "rowsPerPage": "The number of rows per page.
    Set -1 to display all the rows.", "rowsPerPageOptions": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.", diff --git a/docs/translations/api-docs-joy/autocomplete/autocomplete.json b/docs/translations/api-docs-joy/autocomplete/autocomplete.json index ae572296547d1a..e033a9d0b7084e 100644 --- a/docs/translations/api-docs-joy/autocomplete/autocomplete.json +++ b/docs/translations/api-docs-joy/autocomplete/autocomplete.json @@ -14,36 +14,36 @@ "disabled": "If true, the component is disabled.", "endDecorator": "Trailing adornment for this input.", "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    options: The options to render.
    state: The state of the component.", + "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    • options: The options to render.
    • state: The state of the component.
    ", "forcePopupIcon": "Force the visibility display of the popup icon.", "freeSolo": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", - "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: string | number) => ReactNode
    more: The number of truncated tags.", - "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    option: The option to test.", + "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: string | number) => ReactNode
    • more: The number of truncated tags.
    ", + "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    • option: The option to test.
    ", "getOptionLabel": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.

    Signature:
    function(option: T) => string
    ", - "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    options: The options to group.", + "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    • options: The options to group.
    ", "id": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", "inputValue": "The input value.", - "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    option: The option to test.
    value: The value to test against.", + "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    • option: The option to test.
    • value: The value to test against.
    ", "limitTags": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", "loading": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", "loadingText": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", "multiple": "If true, value must be an array and the menu will support multiple selections.", "name": "Name attribute of the input element.", "noOptionsText": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    event: The event source of the callback.
    value: The new value of the component.
    reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".", - "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".", - "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    event: The event source of the callback.
    option: The highlighted option.
    reason: Can be: "keyboard", "auto", "mouse", "touch".", - "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    event: The event source of the callback.
    value: The new value of the text input.
    reason: Can be: "input" (user input), "reset" (programmatic change), "clear".", - "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    • event: The event source of the callback.
    • value: The new value of the component.
    • reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".
    ", + "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
    ", + "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    • event: The event source of the callback.
    • option: The highlighted option.
    • reason: Can be: "keyboard", "auto", "mouse", "touch".
    ", + "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    • event: The event source of the callback.
    • value: The new value of the text input.
    • reason: Can be: "input" (user input), "reset" (programmatic change), "clear".
    ", + "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "openText": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", "options": "Array of options.", "placeholder": "The input placeholder", "popupIcon": "The icon to display in place of the default popup icon.", "readOnly": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    params: The group to render.", - "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    props: The props to apply on the li element.
    option: The option to render.
    state: The state of the component.", - "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    value: The value provided to the component.
    getTagProps: A tag props getter.
    ownerState: The state of the Autocomplete component.", + "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    • params: The group to render.
    ", + "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    • props: The props to apply on the li element.
    • option: The option to render.
    • state: The state of the component.
    ", + "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    • value: The value provided to the component.
    • getTagProps: A tag props getter.
    • ownerState: The state of the Autocomplete component.
    ", "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", "slotProps": "The props used for each slot inside.", diff --git a/docs/translations/api-docs-joy/checkbox/checkbox.json b/docs/translations/api-docs-joy/checkbox/checkbox.json index a0368b267720c1..ccb675749ddac1 100644 --- a/docs/translations/api-docs-joy/checkbox/checkbox.json +++ b/docs/translations/api-docs-joy/checkbox/checkbox.json @@ -13,7 +13,7 @@ "indeterminateIcon": "The icon to display when the component is indeterminate.", "label": "The label element next to the checkbox.", "name": "The name attribute of the input.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "overlay": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component.", "readOnly": "If true, the component is read only.", "required": "If true, the input element is required.", diff --git a/docs/translations/api-docs-joy/modal/modal.json b/docs/translations/api-docs-joy/modal/modal.json index cab58d8e952fe4..4922e0ea35d15b 100644 --- a/docs/translations/api-docs-joy/modal/modal.json +++ b/docs/translations/api-docs-joy/modal/modal.json @@ -12,7 +12,7 @@ "disableScrollLock": "Disable the scroll lock behavior.", "hideBackdrop": "If true, the backdrop is not rendered.", "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "escapeKeyDown", "backdropClick", "closeClick".", + "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick", "closeClick".
    ", "open": "If true, the component is shown.", "slotProps": "The props used for each slot inside.", "slots": "The components used for each slot inside. See Slots API below for more details.", diff --git a/docs/translations/api-docs-joy/radio-group/radio-group.json b/docs/translations/api-docs-joy/radio-group/radio-group.json index eef957bb749b2b..85b10fb80de217 100644 --- a/docs/translations/api-docs-joy/radio-group/radio-group.json +++ b/docs/translations/api-docs-joy/radio-group/radio-group.json @@ -7,7 +7,7 @@ "defaultValue": "The default value. Use when the component is not controlled.", "disableIcon": "The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element.", "name": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.", - "onChange": "Callback fired when a radio button is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when a radio button is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "orientation": "The component orientation.", "overlay": "The radio's overlay prop. If specified, the value is passed down to every radios under this element.", "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", diff --git a/docs/translations/api-docs-joy/radio/radio.json b/docs/translations/api-docs-joy/radio/radio.json index e7824f297bfa91..ffd6290caafd08 100644 --- a/docs/translations/api-docs-joy/radio/radio.json +++ b/docs/translations/api-docs-joy/radio/radio.json @@ -11,7 +11,7 @@ "disableIcon": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", "label": "The label element at the end the radio.", "name": "The name attribute of the input.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "overlay": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component.", "readOnly": "If true, the component is read only.", "required": "If true, the input element is required.", diff --git a/docs/translations/api-docs-joy/slider/slider.json b/docs/translations/api-docs-joy/slider/slider.json index 117b0444126d4f..0d052120b8a766 100644 --- a/docs/translations/api-docs-joy/slider/slider.json +++ b/docs/translations/api-docs-joy/slider/slider.json @@ -9,15 +9,15 @@ "defaultValue": "The default value. Use when the component is not controlled.", "disabled": "If true, the component is disabled.", "disableSwap": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    index: The thumb label's index to format.", - "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    value: The thumb label's value to format.
    index: The thumb label's index to format.", + "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    • index: The thumb label's index to format.
    ", + "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    • value: The thumb label's value to format.
    • index: The thumb label's index to format.
    ", "isRtl": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", "marks": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", "max": "The maximum allowed value of the slider. Should not be equal to min.", "min": "The minimum allowed value of the slider. Should not be equal to max.", "name": "Name attribute of the hidden input element.", - "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    value: The new value.
    activeThumb: Index of the currently moved thumb.", - "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    value: The new value.", + "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    • value: The new value.
    • activeThumb: Index of the currently moved thumb.
    ", + "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: The new value.
    ", "orientation": "The component orientation.", "scale": "A transformation function, to change the scale of the slider.

    Signature:
    function(x: any) => any
    ", "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", diff --git a/docs/translations/api-docs-joy/switch/switch.json b/docs/translations/api-docs-joy/switch/switch.json index 96ddc47f9721cc..e196bbae3df290 100644 --- a/docs/translations/api-docs-joy/switch/switch.json +++ b/docs/translations/api-docs-joy/switch/switch.json @@ -7,7 +7,7 @@ "defaultChecked": "The default checked state. Use when the component is not controlled.", "disabled": "If true, the component is disabled.", "endDecorator": "The element that appears at the end of the switch.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "readOnly": "If true, the component is read only.", "required": "If true, the input element is required.", "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", diff --git a/docs/translations/api-docs-joy/tooltip/tooltip.json b/docs/translations/api-docs-joy/tooltip/tooltip.json index 1052515510406b..498699b273a463 100644 --- a/docs/translations/api-docs-joy/tooltip/tooltip.json +++ b/docs/translations/api-docs-joy/tooltip/tooltip.json @@ -21,8 +21,8 @@ "leaveDelay": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).", "leaveTouchDelay": "The number of milliseconds after the user stops touching an element before hiding the tooltip.", "modifiers": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", - "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", + "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "placement": "Tooltip placement.", "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", diff --git a/docs/translations/api-docs/accordion/accordion.json b/docs/translations/api-docs/accordion/accordion.json index 4b782464bc8f9f..b9964d97bb7c74 100644 --- a/docs/translations/api-docs/accordion/accordion.json +++ b/docs/translations/api-docs/accordion/accordion.json @@ -7,7 +7,7 @@ "disabled": "If true, the component is disabled.", "disableGutters": "If true, it removes the margin between two expanded accordion items and the increase of height.", "expanded": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", - "onChange": "Callback fired when the expand/collapse state is changed.

    Signature:
    function(event: React.SyntheticEvent, expanded: boolean) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    expanded: The expanded state of the accordion.", + "onChange": "Callback fired when the expand/collapse state is changed.

    Signature:
    function(event: React.SyntheticEvent, expanded: boolean) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • expanded: The expanded state of the accordion.
    ", "square": "If true, rounded corners are disabled.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "TransitionComponent": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", diff --git a/docs/translations/api-docs/alert/alert.json b/docs/translations/api-docs/alert/alert.json index ea1893da3a3810..e1219dd78ec0d4 100644 --- a/docs/translations/api-docs/alert/alert.json +++ b/docs/translations/api-docs/alert/alert.json @@ -10,7 +10,7 @@ "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", "icon": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", "iconMapping": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", - "onClose": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", + "onClose": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", "role": "The ARIA role attribute of the element.", "severity": "The severity of the alert. This defines the color and icon used.", "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", diff --git a/docs/translations/api-docs/autocomplete/autocomplete.json b/docs/translations/api-docs/autocomplete/autocomplete.json index 54ebd6ebd1aba9..10f66ff2ff3466 100644 --- a/docs/translations/api-docs/autocomplete/autocomplete.json +++ b/docs/translations/api-docs/autocomplete/autocomplete.json @@ -20,20 +20,20 @@ "disabledItemsFocusable": "If true, will allow focus on disabled items.", "disableListWrap": "If true, the list box in the popup will not wrap focus.", "disablePortal": "If true, the Popper content will be under the DOM hierarchy of the parent component.", - "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    options: The options to render.
    state: The state of the component.", + "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    • options: The options to render.
    • state: The state of the component.
    ", "filterSelectedOptions": "If true, hide the selected options from the list box.", "forcePopupIcon": "Force the visibility display of the popup icon.", "freeSolo": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", "fullWidth": "If true, the input will take up the full width of its container.", - "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: number) => ReactNode
    more: The number of truncated tags.", - "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    option: The option to test.", + "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: number) => ReactNode
    • more: The number of truncated tags.
    ", + "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    • option: The option to test.
    ", "getOptionLabel": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.

    Signature:
    function(option: T) => string
    ", - "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    options: The options to group.", + "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    • options: The options to group.
    ", "handleHomeEndKeys": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.", "id": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", "includeInputInList": "If true, the highlight can move to the input.", "inputValue": "The input value.", - "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    option: The option to test.
    value: The value to test against.", + "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    • option: The option to test.
    • value: The value to test against.
    ", "limitTags": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", "ListboxComponent": "The component used to render the listbox.", "ListboxProps": "Props applied to the Listbox element.", @@ -41,11 +41,11 @@ "loadingText": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", "multiple": "If true, value must be an array and the menu will support multiple selections.", "noOptionsText": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    event: The event source of the callback.
    value: The new value of the component.
    reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".", - "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".", - "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    event: The event source of the callback.
    option: The highlighted option.
    reason: Can be: "keyboard", "auto", "mouse", "touch".", - "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    event: The event source of the callback.
    value: The new value of the text input.
    reason: Can be: "input" (user input), "reset" (programmatic change), "clear".", - "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    • event: The event source of the callback.
    • value: The new value of the component.
    • reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".
    ", + "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
    ", + "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    • event: The event source of the callback.
    • option: The highlighted option.
    • reason: Can be: "keyboard", "auto", "mouse", "touch".
    ", + "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    • event: The event source of the callback.
    • value: The new value of the text input.
    • reason: Can be: "input" (user input), "reset" (programmatic change), "clear".
    ", + "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "openOnFocus": "If true, the popup will open on input focus.", "openText": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", @@ -54,10 +54,10 @@ "PopperComponent": "The component used to position the popup.", "popupIcon": "The icon to display in place of the default popup icon.", "readOnly": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    params: The group to render.", + "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    • params: The group to render.
    ", "renderInput": "Render the input.

    Signature:
    function(params: object) => ReactNode
    ", - "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    props: The props to apply on the li element.
    option: The option to render.
    state: The state of the component.", - "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    value: The value provided to the component.
    getTagProps: A tag props getter.
    ownerState: The state of the Autocomplete component.", + "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    • props: The props to apply on the li element.
    • option: The option to render.
    • state: The state of the component.
    ", + "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    • value: The value provided to the component.
    • getTagProps: A tag props getter.
    • ownerState: The state of the Autocomplete component.
    ", "selectOnFocus": "If true, the input'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.", diff --git a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json index 7d2ed3fd38fb9a..8f504f158a0eaf 100644 --- a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json +++ b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json @@ -4,7 +4,7 @@ "children": "The content of the component.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: any) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    value: We default to the index of the child.", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: any) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: We default to the index of the child.
    ", "showLabels": "If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "value": "The value of the currently selected BottomNavigationAction." diff --git a/docs/translations/api-docs/checkbox/checkbox.json b/docs/translations/api-docs/checkbox/checkbox.json index edd98e7b792b81..9e8b71173631a5 100644 --- a/docs/translations/api-docs/checkbox/checkbox.json +++ b/docs/translations/api-docs/checkbox/checkbox.json @@ -14,7 +14,7 @@ "indeterminateIcon": "The icon to display when the component is indeterminate.", "inputProps": "Attributes applied to the input element.", "inputRef": "Pass a ref to the input element.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "required": "If true, the input element is required.", "size": "The size of the component. small is equivalent to the dense checkbox styling.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/dialog/dialog.json b/docs/translations/api-docs/dialog/dialog.json index d466f858a04686..2e8228018b4700 100644 --- a/docs/translations/api-docs/dialog/dialog.json +++ b/docs/translations/api-docs/dialog/dialog.json @@ -11,7 +11,7 @@ "fullWidth": "If true, the dialog stretches to maxWidth.
    Notice that the dialog width grow is limited by the default margin.", "maxWidth": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.", "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "escapeKeyDown", "backdropClick".", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", "open": "If true, the component is shown.", "PaperComponent": "The component used to render the body of the dialog.", "PaperProps": "Props applied to the Paper element.", diff --git a/docs/translations/api-docs/drawer/drawer.json b/docs/translations/api-docs/drawer/drawer.json index 4c87a7db058b5b..40fbdd4e69eb1d 100644 --- a/docs/translations/api-docs/drawer/drawer.json +++ b/docs/translations/api-docs/drawer/drawer.json @@ -7,7 +7,7 @@ "elevation": "The elevation of the drawer.", "hideBackdrop": "If true, the backdrop is not rendered.", "ModalProps": "Props applied to the Modal element.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object) => void
    event: The event source of the callback.", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "PaperProps": "Props applied to the Paper element.", "SlideProps": "Props applied to the Slide element.", diff --git a/docs/translations/api-docs/filled-input/filled-input.json b/docs/translations/api-docs/filled-input/filled-input.json index d2d4688110a7ca..378a21f8ad728b 100644 --- a/docs/translations/api-docs/filled-input/filled-input.json +++ b/docs/translations/api-docs/filled-input/filled-input.json @@ -23,7 +23,7 @@ "minRows": "Minimum number of rows to display when multiline option is set to true.", "multiline": "If true, a TextareaAutosize element is rendered.", "name": "Name attribute of the input element.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "placeholder": "The short hint displayed in the input before the user enters a value.", "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", diff --git a/docs/translations/api-docs/form-control-label/form-control-label.json b/docs/translations/api-docs/form-control-label/form-control-label.json index dbc53fd9336d6b..012f6ca13aba8a 100644 --- a/docs/translations/api-docs/form-control-label/form-control-label.json +++ b/docs/translations/api-docs/form-control-label/form-control-label.json @@ -10,7 +10,7 @@ "inputRef": "Pass a ref to the input element.", "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.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "required": "If true, the label will indicate that the input is required.", "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 `sx` page for more details.", diff --git a/docs/translations/api-docs/input-base/input-base.json b/docs/translations/api-docs/input-base/input-base.json index 0a25a740b3f3e9..be46a905030b5d 100644 --- a/docs/translations/api-docs/input-base/input-base.json +++ b/docs/translations/api-docs/input-base/input-base.json @@ -23,7 +23,7 @@ "multiline": "If true, a TextareaAutosize element is rendered.", "name": "Name attribute of the input element.", "onBlur": "Callback fired when the input is blurred.
    Notice that the first argument (event) might be undefined.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "onInvalid": "Callback fired when the input doesn't satisfy its constraints.", "placeholder": "The short hint displayed in the input before the user enters a value.", "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", diff --git a/docs/translations/api-docs/input/input.json b/docs/translations/api-docs/input/input.json index 1e3d0cb5231d6a..9d66d2118fd08a 100644 --- a/docs/translations/api-docs/input/input.json +++ b/docs/translations/api-docs/input/input.json @@ -22,7 +22,7 @@ "minRows": "Minimum number of rows to display when multiline option is set to true.", "multiline": "If true, a TextareaAutosize element is rendered.", "name": "Name attribute of the input element.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "placeholder": "The short hint displayed in the input before the user enters a value.", "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", diff --git a/docs/translations/api-docs/menu/menu.json b/docs/translations/api-docs/menu/menu.json index 6880082fd0f57a..1eeaf54d5cba06 100644 --- a/docs/translations/api-docs/menu/menu.json +++ b/docs/translations/api-docs/menu/menu.json @@ -7,7 +7,7 @@ "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "disableAutoFocusItem": "When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications.", "MenuListProps": "Props applied to the MenuList element.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "escapeKeyDown", "backdropClick", "tabKeyDown".", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick", "tabKeyDown".
    ", "open": "If true, the component is shown.", "PopoverClasses": "classes prop applied to the Popover element.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index 97b62347bb30e4..3d961574b68eb6 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -19,7 +19,7 @@ "hideBackdrop": "If true, the backdrop is not rendered.", "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "escapeKeyDown", "backdropClick".", + "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", "open": "If true, the component is shown.", "slotProps": "The props used for each slot inside the Modal.", "slots": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component.", diff --git a/docs/translations/api-docs/native-select/native-select.json b/docs/translations/api-docs/native-select/native-select.json index 7e7314bfa92aa0..839cccb07ca32c 100644 --- a/docs/translations/api-docs/native-select/native-select.json +++ b/docs/translations/api-docs/native-select/native-select.json @@ -6,7 +6,7 @@ "IconComponent": "The icon that displays the arrow.", "input": "An Input element; does not have to be a material-ui specific Input.", "inputProps": "Attributes applied to the select element.", - "onChange": "Callback fired when a menu item is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLSelectElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when a menu item is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLSelectElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "value": "The input value. The DOM API casts this to a string.", "variant": "The variant to use." diff --git a/docs/translations/api-docs/outlined-input/outlined-input.json b/docs/translations/api-docs/outlined-input/outlined-input.json index ea097c684e62ce..fb499241bb3c36 100644 --- a/docs/translations/api-docs/outlined-input/outlined-input.json +++ b/docs/translations/api-docs/outlined-input/outlined-input.json @@ -22,7 +22,7 @@ "multiline": "If true, a TextareaAutosize element is rendered.", "name": "Name attribute of the input element.", "notched": "If true, the outline is notched to accommodate the label.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "placeholder": "The short hint displayed in the input before the user enters a value.", "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", diff --git a/docs/translations/api-docs/pagination/pagination.json b/docs/translations/api-docs/pagination/pagination.json index 4f27d3d9661b7e..2ca6eedae9076f 100644 --- a/docs/translations/api-docs/pagination/pagination.json +++ b/docs/translations/api-docs/pagination/pagination.json @@ -7,12 +7,12 @@ "count": "The total number of pages.", "defaultPage": "The page selected by default when the component is uncontrolled.", "disabled": "If true, the component is disabled.", - "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string, page: number, selected: bool) => string
    type: The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous'). Defaults to 'page'.
    page: The page number to format.
    selected: If true, the current page is selected.", + "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string, page: number, selected: bool) => string
    • type: The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous'). Defaults to 'page'.
    • page: The page number to format.
    • selected: If true, the current page is selected.
    ", "hideNextButton": "If true, hide the next-page button.", "hidePrevButton": "If true, hide the previous-page button.", - "onChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.ChangeEvent<unknown>, page: number) => void
    event: The event source of the callback.
    page: The page selected.", + "onChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.ChangeEvent<unknown>, page: number) => void
    • event: The event source of the callback.
    • page: The page selected.
    ", "page": "The current page.", - "renderItem": "Render the item.

    Signature:
    function(params: PaginationRenderItemParams) => ReactNode
    params: The props to spread on a PaginationItem.", + "renderItem": "Render the item.

    Signature:
    function(params: PaginationRenderItemParams) => ReactNode
    • params: The props to spread on a PaginationItem.
    ", "shape": "The shape of the pagination items.", "showFirstButton": "If true, show the first-page button.", "showLastButton": "If true, show the last-page button.", diff --git a/docs/translations/api-docs/radio-group/radio-group.json b/docs/translations/api-docs/radio-group/radio-group.json index f6aaf9b25f7001..8a9dbdcf8be1f1 100644 --- a/docs/translations/api-docs/radio-group/radio-group.json +++ b/docs/translations/api-docs/radio-group/radio-group.json @@ -4,7 +4,7 @@ "children": "The content of the component.", "defaultValue": "The default value. Use when the component is not controlled.", "name": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.", - "onChange": "Callback fired when a radio button is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>, value: string) => void
    event: The event source of the callback.
    value: The value of the selected radio button. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when a radio button is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>, value: string) => void
    • event: The event source of the callback.
    • value: The value of the selected radio button. You can pull out the new value by accessing event.target.value (string).
    ", "value": "Value of the selected radio button. The DOM API casts this to a string." }, "classDescriptions": { diff --git a/docs/translations/api-docs/radio/radio.json b/docs/translations/api-docs/radio/radio.json index a37b16ec49df88..434407c15eb3c1 100644 --- a/docs/translations/api-docs/radio/radio.json +++ b/docs/translations/api-docs/radio/radio.json @@ -12,7 +12,7 @@ "inputProps": "Attributes applied to the input element.", "inputRef": "Pass a ref to the input element.", "name": "Name attribute of the input element.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "required": "If true, the input element is required.", "size": "The size of the component. small is equivalent to the dense radio styling.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/rating/rating.json b/docs/translations/api-docs/rating/rating.json index 470222c2d7f0e1..73d083d6381228 100644 --- a/docs/translations/api-docs/rating/rating.json +++ b/docs/translations/api-docs/rating/rating.json @@ -6,14 +6,14 @@ "disabled": "If true, the component is disabled.", "emptyIcon": "The icon to display when empty.", "emptyLabelText": "The label read when the rating input is empty.", - "getLabelText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the rating. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(value: number) => string
    value: The rating label's value to format.", + "getLabelText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the rating. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(value: number) => string
    • value: The rating label's value to format.
    ", "highlightSelectedOnly": "If true, only the selected icon will be highlighted.", "icon": "The icon to display.", "IconContainerComponent": "The component containing the icon.", "max": "Maximum rating.", "name": "The name attribute of the radio input elements. This input name should be unique within the page. Being unique within a form is insufficient since the name is used to generated IDs.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: number | null) => void
    event: The event source of the callback.
    value: The new value.", - "onChangeActive": "Callback function that is fired when the hover state changes.

    Signature:
    function(event: React.SyntheticEvent, value: number) => void
    event: The event source of the callback.
    value: The new value.", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: number | null) => void
    • event: The event source of the callback.
    • value: The new value.
    ", + "onChangeActive": "Callback function that is fired when the hover state changes.

    Signature:
    function(event: React.SyntheticEvent, value: number) => void
    • event: The event source of the callback.
    • value: The new value.
    ", "precision": "The minimum increment value change allowed.", "readOnly": "Removes all hover effects and pointer events.", "size": "The size of the component.", diff --git a/docs/translations/api-docs/select/select.json b/docs/translations/api-docs/select/select.json index 0e09fe6d4805dd..e54e2f3dfb3f91 100644 --- a/docs/translations/api-docs/select/select.json +++ b/docs/translations/api-docs/select/select.json @@ -16,11 +16,11 @@ "MenuProps": "Props applied to the Menu element.", "multiple": "If true, value must be an array and the menu will support multiple selections.", "native": "If true, the component uses a native select element.", - "onChange": "Callback fired when a menu item is selected.

    Signature:
    function(event: SelectChangeEvent<T>, child?: object) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event, not a change event, unless the change event is caused by browser autofill.
    child: The react element that was selected when native is false (default).", - "onClose": "Callback fired when the component requests to be closed. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select collapses).

    Signature:
    function(event: object) => void
    event: The event source of the callback.", - "onOpen": "Callback fired when the component requests to be opened. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select expands).

    Signature:
    function(event: object) => void
    event: The event source of the callback.", + "onChange": "Callback fired when a menu item is selected.

    Signature:
    function(event: SelectChangeEvent<T>, child?: object) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event, not a change event, unless the change event is caused by browser autofill.
    • child: The react element that was selected when native is false (default).
    ", + "onClose": "Callback fired when the component requests to be closed. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select collapses).

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", + "onOpen": "Callback fired when the component requests to be opened. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select expands).

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown. You can only use it when the native prop is false (default).", - "renderValue": "Render the selected value. You can only use it when the native prop is false (default).

    Signature:
    function(value: any) => ReactNode
    value: The value provided to the component.", + "renderValue": "Render the selected value. You can only use it when the native prop is false (default).

    Signature:
    function(value: any) => ReactNode
    • value: The value provided to the component.
    ", "SelectDisplayProps": "Props applied to the clickable div element.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "value": "The input value. Providing an empty string will select no options. Set to an empty string '' if you don't want any of the available options to be selected.
    If the value is an object it must have reference equality with the option in order to be selected. If the value is not an object, the string representation must match with the string representation of the option in order to be selected.", diff --git a/docs/translations/api-docs/slider/slider.json b/docs/translations/api-docs/slider/slider.json index e7e7dce95d28cc..31918027966b51 100644 --- a/docs/translations/api-docs/slider/slider.json +++ b/docs/translations/api-docs/slider/slider.json @@ -11,14 +11,14 @@ "defaultValue": "The default value. Use when the component is not controlled.", "disabled": "If true, the component is disabled.", "disableSwap": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    index: The thumb label's index to format.", - "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    value: The thumb label's value to format.
    index: The thumb label's index to format.", + "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    • index: The thumb label's index to format.
    ", + "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    • value: The thumb label's value to format.
    • index: The thumb label's index to format.
    ", "marks": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", "max": "The maximum allowed value of the slider. Should not be equal to min.", "min": "The minimum allowed value of the slider. Should not be equal to max.", "name": "Name attribute of the hidden input element.", - "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    value: The new value.
    activeThumb: Index of the currently moved thumb.", - "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    value: The new value.", + "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    • value: The new value.
    • activeThumb: Index of the currently moved thumb.
    ", + "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: The new value.
    ", "orientation": "The component orientation.", "scale": "A transformation function, to change the scale of the slider.

    Signature:
    function(x: any) => any
    ", "size": "The size of the slider.", diff --git a/docs/translations/api-docs/snackbar/snackbar.json b/docs/translations/api-docs/snackbar/snackbar.json index f711f727361f42..1d4bf7a534845d 100644 --- a/docs/translations/api-docs/snackbar/snackbar.json +++ b/docs/translations/api-docs/snackbar/snackbar.json @@ -11,7 +11,7 @@ "disableWindowBlurListener": "If true, the autoHideDuration timer will expire even if the window is not focused.", "key": "When displaying multiple consecutive Snackbars from a parent rendering a single <Snackbar/>, add the key prop to ensure independent treatment of each message. e.g. <Snackbar key={message} />, otherwise, the message may update-in-place and features such as autoHideDuration may be canceled.", "message": "The message to display.", - "onClose": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

    Signature:
    function(event: React.SyntheticEvent<any> | Event, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown".", + "onClose": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

    Signature:
    function(event: React.SyntheticEvent<any> | Event, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown".
    ", "open": "If true, the component is shown.", "resumeHideDuration": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/speed-dial/speed-dial.json b/docs/translations/api-docs/speed-dial/speed-dial.json index 9c0e8bc7326686..1f37485af3c9de 100644 --- a/docs/translations/api-docs/speed-dial/speed-dial.json +++ b/docs/translations/api-docs/speed-dial/speed-dial.json @@ -8,8 +8,8 @@ "FabProps": "Props applied to the Fab element.", "hidden": "If true, the SpeedDial is hidden.", "icon": "The icon to display in the SpeedDial Fab. The SpeedDialIcon component provides a default Icon with animation.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "toggle", "blur", "mouseLeave", "escapeKeyDown".", - "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: object, reason: string) => void
    event: The event source of the callback.
    reason: Can be: "toggle", "focus", "mouseEnter".", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggle", "blur", "mouseLeave", "escapeKeyDown".
    ", + "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggle", "focus", "mouseEnter".
    ", "open": "If true, the component is shown.", "openIcon": "The icon to display in the SpeedDial Fab when the SpeedDial is open.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json b/docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json index 32544a759b2fcd..d08a15c97ebdd3 100644 --- a/docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json +++ b/docs/translations/api-docs/swipeable-drawer/swipeable-drawer.json @@ -8,8 +8,8 @@ "disableSwipeToOpen": "If true, swipe to open is disabled. This is useful in browsers where swiping triggers navigation actions. Swipe to open is disabled on iOS browsers by default.", "hysteresis": "Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer", "minFlingVelocity": "Defines, from which (average) velocity on, the swipe is defined as complete although hysteresis isn't reached. Good threshold is between 250 - 1000 px/s", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object) => void
    event: The event source of the callback.", - "onOpen": "Callback fired when the component requests to be opened.

    Signature:
    function(event: object) => void
    event: The event source of the callback.", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", + "onOpen": "Callback fired when the component requests to be opened.

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "SwipeAreaProps": "The element is used to intercept the touch events on the edge.", "swipeAreaWidth": "The width of the left most (or right most) area in px that the drawer can be swiped open from.", diff --git a/docs/translations/api-docs/switch/switch.json b/docs/translations/api-docs/switch/switch.json index 1e5c6b7daab8ad..d785fe37592a13 100644 --- a/docs/translations/api-docs/switch/switch.json +++ b/docs/translations/api-docs/switch/switch.json @@ -13,7 +13,7 @@ "id": "The id of the input element.", "inputProps": "Attributes applied to the input element.", "inputRef": "Pass a ref to the input element.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).", + "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", "required": "If true, the input element is required.", "size": "The size of the component. small is equivalent to the dense switch styling.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/table-pagination/table-pagination.json b/docs/translations/api-docs/table-pagination/table-pagination.json index cff49eb2a8cacb..58409aac78f0da 100644 --- a/docs/translations/api-docs/table-pagination/table-pagination.json +++ b/docs/translations/api-docs/table-pagination/table-pagination.json @@ -6,12 +6,12 @@ "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "component": "The component used for the root node. Either a string to use a HTML element or a component.", "count": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1.", - "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string) => string
    type: The link or button type to format ('first' | 'last' | 'next' | 'previous').", + "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string) => string
    • type: The link or button type to format ('first' | 'last' | 'next' | 'previous').
    ", "labelDisplayedRows": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations.", "labelRowsPerPage": "Customize the rows per page label.
    For localization purposes, you can use the provided translations.", "nextIconButtonProps": "Props applied to the next arrow IconButton element.", - "onPageChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
    event: The event source of the callback.
    page: The page selected.", - "onRowsPerPageChange": "Callback fired when the number of rows per page is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    event: The event source of the callback.", + "onPageChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
    • event: The event source of the callback.
    • page: The page selected.
    ", + "onRowsPerPageChange": "Callback fired when the number of rows per page is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback.
    ", "page": "The zero-based index of the current page.", "rowsPerPage": "The number of rows per page.
    Set -1 to display all the rows.", "rowsPerPageOptions": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.", diff --git a/docs/translations/api-docs/tabs/tabs.json b/docs/translations/api-docs/tabs/tabs.json index 4fae2073b12685..6fab5c1f74a770 100644 --- a/docs/translations/api-docs/tabs/tabs.json +++ b/docs/translations/api-docs/tabs/tabs.json @@ -10,7 +10,7 @@ "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "component": "The component used for the root node. Either a string to use a HTML element or a component.", "indicatorColor": "Determines the color of the indicator.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: any) => void
    event: The event source of the callback. Warning: This is a generic event not a change event.
    value: We default to the index of the child (number)", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: any) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: We default to the index of the child (number)
    ", "orientation": "The component orientation (layout flow direction).", "ScrollButtonComponent": "The component used to render the scroll buttons.", "scrollButtons": "Determine behavior of scroll buttons when tabs are set to scroll:
    - auto will only present them when not all the items are visible. - true will always present them. - false will never present them.
    By default the scroll buttons are hidden on mobile. This behavior can be disabled with allowScrollButtonsMobile.", diff --git a/docs/translations/api-docs/text-field/text-field.json b/docs/translations/api-docs/text-field/text-field.json index 09ecfed469edde..cd4e416f6070e9 100644 --- a/docs/translations/api-docs/text-field/text-field.json +++ b/docs/translations/api-docs/text-field/text-field.json @@ -22,7 +22,7 @@ "minRows": "Minimum number of rows to display when multiline option is set to true.", "multiline": "If true, a textarea element is rendered instead of an input.", "name": "Name attribute of the input element.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: object) => void
    event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).", + "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: object) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", "placeholder": "The short hint displayed in the input before the user enters a value.", "required": "If true, the label is displayed as required and the input element is required.", "rows": "Number of rows to display when multiline option is set to true.", diff --git a/docs/translations/api-docs/toggle-button-group/toggle-button-group.json b/docs/translations/api-docs/toggle-button-group/toggle-button-group.json index 70cb3623648de6..21b112ef25bbc7 100644 --- a/docs/translations/api-docs/toggle-button-group/toggle-button-group.json +++ b/docs/translations/api-docs/toggle-button-group/toggle-button-group.json @@ -7,7 +7,7 @@ "disabled": "If true, the component is disabled. This implies that all ToggleButton children will be disabled.", "exclusive": "If true, only allow one of the child ToggleButton values to be selected.", "fullWidth": "If true, the button group will take up the full width of its container.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    event: The event source of the callback.
    value: of the selected buttons. When exclusive is true this is a single value; when false an array of selected values. If no value is selected and exclusive is true the value is null; when false an empty array.", + "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    • event: The event source of the callback.
    • value: of the selected buttons. When exclusive is true this is a single value; when false an array of selected values. If no value is selected and exclusive is true the value is null; when false an empty array.
    ", "orientation": "The component orientation (layout flow direction).", "size": "The size of the component.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/toggle-button/toggle-button.json b/docs/translations/api-docs/toggle-button/toggle-button.json index 089289c3ca3f9f..e1be7d469e3cb5 100644 --- a/docs/translations/api-docs/toggle-button/toggle-button.json +++ b/docs/translations/api-docs/toggle-button/toggle-button.json @@ -8,8 +8,8 @@ "disableFocusRipple": "If true, the keyboard focus ripple is disabled.", "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", "fullWidth": "If true, the button will take up the full width of its container.", - "onChange": "Callback fired when the state changes.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    event: The event source of the callback.
    value: of the selected button.", - "onClick": "Callback fired when the button is clicked.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    event: The event source of the callback.
    value: of the selected button.", + "onChange": "Callback fired when the state changes.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    • event: The event source of the callback.
    • value: of the selected button.
    ", + "onClick": "Callback fired when the button is clicked.

    Signature:
    function(event: React.MouseEvent<HTMLElement>, value: any) => void
    • event: The event source of the callback.
    • value: of the selected button.
    ", "selected": "If true, the button is rendered in an active state.", "size": "The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", diff --git a/docs/translations/api-docs/tooltip/tooltip.json b/docs/translations/api-docs/tooltip/tooltip.json index 410fdec86caacf..a2cca5ffab1fc5 100644 --- a/docs/translations/api-docs/tooltip/tooltip.json +++ b/docs/translations/api-docs/tooltip/tooltip.json @@ -18,8 +18,8 @@ "id": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.", "leaveDelay": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).", "leaveTouchDelay": "The number of milliseconds after the user stops touching an element before hiding the tooltip.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", - "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: React.SyntheticEvent) => void
    event: The event source of the callback.", + "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", + "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", "open": "If true, the component is shown.", "placement": "Tooltip placement.", "PopperComponent": "The component used for the popper.", diff --git a/docs/translations/api-docs/tree-view/tree-view.json b/docs/translations/api-docs/tree-view/tree-view.json index 6a006b03ad8f84..d9ad627219a773 100644 --- a/docs/translations/api-docs/tree-view/tree-view.json +++ b/docs/translations/api-docs/tree-view/tree-view.json @@ -14,9 +14,9 @@ "expanded": "Expanded node ids. (Controlled)", "id": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.", "multiSelect": "If true ctrl and shift will trigger multiselect.", - "onNodeFocus": "Callback fired when tree items are focused.

    Signature:
    function(event: React.SyntheticEvent, value: string) => void
    event: The event source of the callback Warning: This is a generic event not a focus event.
    value: of the focused node.", - "onNodeSelect": "Callback fired when tree items are selected/unselected.

    Signature:
    function(event: React.SyntheticEvent, nodeIds: Array<string> | string) => void
    event: The event source of the callback
    nodeIds: Ids of the selected nodes. When multiSelect is true this is an array of strings; when false (default) a string.", - "onNodeToggle": "Callback fired when tree items are expanded/collapsed.

    Signature:
    function(event: React.SyntheticEvent, nodeIds: array) => void
    event: The event source of the callback.
    nodeIds: The ids of the expanded nodes.", + "onNodeFocus": "Callback fired when tree items are focused.

    Signature:
    function(event: React.SyntheticEvent, value: string) => void
    • event: The event source of the callback Warning: This is a generic event not a focus event.
    • value: of the focused node.
    ", + "onNodeSelect": "Callback fired when tree items are selected/unselected.

    Signature:
    function(event: React.SyntheticEvent, nodeIds: Array<string> | string) => void
    • event: The event source of the callback
    • nodeIds: Ids of the selected nodes. When multiSelect is true this is an array of strings; when false (default) a string.
    ", + "onNodeToggle": "Callback fired when tree items are expanded/collapsed.

    Signature:
    function(event: React.SyntheticEvent, nodeIds: array) => void
    • event: The event source of the callback.
    • nodeIds: The ids of the expanded nodes.
    ", "selected": "Selected node ids. (Controlled) When multiSelect is true this takes an array of strings; when false (default) a string.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." }, diff --git a/packages/api-docs-builder/utils/generatePropDescription.ts b/packages/api-docs-builder/utils/generatePropDescription.ts index 3fd2b93fd24a44..5cdaa9fbac65c5 100644 --- a/packages/api-docs-builder/utils/generatePropDescription.ts +++ b/packages/api-docs-builder/utils/generatePropDescription.ts @@ -137,10 +137,17 @@ export default function generatePropDescription( const returnTypeName = resolveType(returnType); signature += `) => ${returnTypeName}\`
    `; - signature += parsedArgs - .filter((tag) => tag.description) - .map((tag) => `*${tag.name}:* ${tag.description}`) - .join('
    '); + + const argsWithDescription = parsedArgs.filter((tag) => tag.description); + + if (argsWithDescription.length > 0) { + signature += '
      '; + signature += parsedArgs + .filter((tag) => tag.description) + .map((tag) => `
    • ${tag.name}: ${tag.description}
      • `) + .join(''); + signature += '
    '; + } if (parsedReturns.description) { signature += `
    *returns* (${returnTypeName}): ${parsedReturns.description}`; } From 39e113724db1391870eced9c302f35829763f2cb Mon Sep 17 00:00:00 2001 From: alexandre Date: Mon, 29 May 2023 11:56:55 +0200 Subject: [PATCH 04/85] few style imrovement --- docs/src/modules/components/ApiPage.js | 5 +- .../modules/components/ApiPage/ApiItem.tsx | 75 ++++++++++++++++--- .../src/modules/components/PropertiesTable.js | 36 +++++++-- 3 files changed, 94 insertions(+), 22 deletions(-) diff --git a/docs/src/modules/components/ApiPage.js b/docs/src/modules/components/ApiPage.js index bb3ba8521e682e..a86f6dff54647b 100644 --- a/docs/src/modules/components/ApiPage.js +++ b/docs/src/modules/components/ApiPage.js @@ -482,10 +482,7 @@ import { ${pageContent.name} } from '${source}';`} - + diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 2ecd3a67627145..6f28c887fd4689 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -16,11 +16,13 @@ const Root = styled('div')( position: 'relative', textDecoration: 'none', marginBottom: '12px', + lineHeight: '18px', + fontFamily: theme.typography.fontFamilyCode, '& .MuiApi-item-link-visual': { display: 'none', border: 'solid 1px', borderRadius: '4px', - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, width: '24px', height: '24px', textAlign: 'center', @@ -28,13 +30,16 @@ const Root = styled('div')( position: 'absolute', left: '-32px', '& svg': { + borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, height: '11px', width: '11px', }, }, span: { + color: '#2D3843', borderBottom: 'solid 1px', + fontWeight: 400, borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, padding: '2px 6px', }, @@ -50,14 +55,15 @@ const Root = styled('div')( }, '& .MuiApi-item-description': { flexGrow: 1, - color: `var(--muidocs-palette-text-primary, ${lightTheme.palette.text.primary})`, }, '& .MuiApi-item-note': { padding: '2px 6px', color: `var(--muidocs-palette-green-800, ${green[800]})`, }, '&:hover, &:target': { - '.MuiApi-item-link-visual': { display: 'inline-block' }, + '.MuiApi-item-link-visual': { + display: 'inline-block', + }, }, '&:hover': { cursor: 'pointer', @@ -67,14 +73,44 @@ const Root = styled('div')( '.MuiApi-item-title': { backgroundColor: alpha(lightBlue[100], 0.5), }, - '& .MuiApi-item-link-visual': {}, + '& .MuiApi-item-link-visual': { + backgroundColor: alpha(lightBlue[100], 0.5), + borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + '& svg': { + fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + }, + }, + }, + }, + '& .MuiAlert-standardWarning': { + border: 'solid #FFF3C1 1px', + backgroundColor: '#FFF9EBB2', + color: '#5A3600', + + fontFamily: theme.typography.fontFamilyCode, + '.MuiAlert-icon': { + display: 'flex', + alignItems: 'center', + fill: '#AB6800', + }, + }, + '& .default-props': { + display: 'flex', + alignItems: 'center', + span: { + marginRight: 8, + whiteSpace: 'nowrap', + }, + code: { + border: 'solid #E0E3E7 1px', + backgroundColor: '#F3F6F9', + padding: '2px 6px', }, }, marginBottom: 32, }), ({ theme }) => ({ [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { - color: 'rgb(255, 255, 255)', '& .MuiApi-item-header': { '& span': { borderColor: '#2F3A46', @@ -92,14 +128,18 @@ const Root = styled('div')( }, '&:hover': { span: { - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + borderColor: `#3399FF`, }, '.MuiApi-item-title': { - backgroundColor: `var(--muidocs-palette-primary-light-200, #0059B24D) / 30%`, + color: '#99CCF3', + backgroundColor: `#0059B24D`, }, '& .MuiApi-item-link-visual': { - borderColor: `var(--muidocs-palette-primary-400, ${lightTheme.palette.primary[400]})`, - backgroundColor: `var(--muidocs-palette-primary-light-200, #0059B24D) / 30%`, + borderColor: `#3399FF`, + backgroundColor: `#0059B24D`, + '& svg': { + fill: '#99CCF3', + }, }, }, '&:hover, &:target': { @@ -111,7 +151,22 @@ const Root = styled('div')( color: '#B2BAC2', }, '& .MuiApi-item-note': { - color: `var(--muidocs-palette-green-400, ${green[400]})`, + color: `var(--muidocs-palette-green-400, #3EE07F)`, + }, + }, + '& .MuiAlert-standardWarning': { + borderColor: '#5A3600', + backgroundColor: '#F4C0001A', + color: '#FFDC48', + '.MuiAlert-icon svg': { + fill: '#FFDC48', + }, + }, + '& .default-props': { + color: '#A0AAB4', + code: { + borderColor: '#1F262E', + backgroundColor: '#141A1F', }, }, }, diff --git a/docs/src/modules/components/PropertiesTable.js b/docs/src/modules/components/PropertiesTable.js index 5986615ae0817f..09bb12b6b40252 100644 --- a/docs/src/modules/components/PropertiesTable.js +++ b/docs/src/modules/components/PropertiesTable.js @@ -38,24 +38,44 @@ export default function PropertiesTable(props) { __html: propertiesDescriptions[propName] || '', }} /> - {propDefault && ( -

    - {t('api-docs.default')}: {propDefault} -

    - )} + {propData.deprecated && ( - - {t('api-docs.deprecated')} + + + + ), + }} + > + {t('api-docs.deprecated')} {propData.deprecationInfo && ' - '} {propData.deprecationInfo && ( /g, '') + .replace(/<\/code>/g, ''), }} /> )} )} + + {propDefault && ( +

    + {t('api-docs.default')}: + {propDefault} +

    + )} ); // From 16c640ad1b58fb2831b7d578fe65979669a0dc95 Mon Sep 17 00:00:00 2001 From: alexandre Date: Mon, 29 May 2023 14:40:34 +0200 Subject: [PATCH 05/85] test new interactions --- .../modules/components/ApiPage/ApiItem.tsx | 74 +++++++++++-------- 1 file changed, 45 insertions(+), 29 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 6f28c887fd4689..124f2f11aa5cc8 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -14,10 +14,10 @@ const Root = styled('div')( ...theme.typography.caption, display: 'flex', position: 'relative', - textDecoration: 'none', marginBottom: '12px', lineHeight: '18px', fontFamily: theme.typography.fontFamilyCode, + marginLeft: -32, '& .MuiApi-item-link-visual': { display: 'none', border: 'solid 1px', @@ -27,8 +27,6 @@ const Root = styled('div')( height: '24px', textAlign: 'center', lineHeight: '24px', - position: 'absolute', - left: '-32px', '& svg': { borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, @@ -52,6 +50,8 @@ const Root = styled('div')( color: `var(--muidocs-palette-primary-700, ${lightTheme.palette.primary[700]})`, fontWeight: theme.typography.fontWeightSemiBold, backgroundColor: grey[200], + + marginLeft: 32, }, '& .MuiApi-item-description': { flexGrow: 1, @@ -64,16 +64,11 @@ const Root = styled('div')( '.MuiApi-item-link-visual': { display: 'inline-block', }, - }, - '&:hover': { - cursor: 'pointer', - span: { - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, - }, '.MuiApi-item-title': { - backgroundColor: alpha(lightBlue[100], 0.5), + marginLeft: '8px', }, - '& .MuiApi-item-link-visual': { + '.MuiApi-item-link-visual:hover': { + cursor: 'pointer', backgroundColor: alpha(lightBlue[100], 0.5), borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, '& svg': { @@ -81,6 +76,22 @@ const Root = styled('div')( }, }, }, + // '&:hover': { + // cursor: 'pointer', + // span: { + // borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + // }, + // '.MuiApi-item-title': { + // backgroundColor: alpha(lightBlue[100], 0.5), + // }, + // '& .MuiApi-item-link-visual': { + // backgroundColor: alpha(lightBlue[100], 0.5), + // borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + // '& svg': { + // fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + // }, + // }, + // }, }, '& .MuiAlert-standardWarning': { border: 'solid #FFF3C1 1px', @@ -126,15 +137,24 @@ const Root = styled('div')( fill: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, }, }, - '&:hover': { - span: { - borderColor: `#3399FF`, - }, - '.MuiApi-item-title': { - color: '#99CCF3', - backgroundColor: `#0059B24D`, - }, - '& .MuiApi-item-link-visual': { + // '&:hover': { + // span: { + // borderColor: `#3399FF`, + // }, + // '.MuiApi-item-title': { + // color: '#99CCF3', + // backgroundColor: `#0059B24D`, + // }, + // '& .MuiApi-item-link-visual': { + // borderColor: `#3399FF`, + // backgroundColor: `#0059B24D`, + // '& svg': { + // fill: '#99CCF3', + // }, + // }, + // }, + '&:hover, &:target': { + '.MuiApi-item-link-visual:hover': { borderColor: `#3399FF`, backgroundColor: `#0059B24D`, '& svg': { @@ -142,11 +162,6 @@ const Root = styled('div')( }, }, }, - '&:hover, &:target': { - '& .MuiApi-item-link-visual': { - display: 'inline-block', - }, - }, '& .MuiApi-item-description': { color: '#B2BAC2', }, @@ -185,12 +200,13 @@ function ApiItem(props: ApiItemProps) { const { title, description, note, children, id } = props; return ( - -
    + + + {title} {note && {note}} - +
    {children}     ); From 6ed87f29568a7a0e2a5baff7ac437f1487b86a7c Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 10:20:37 -0300 Subject: [PATCH 06/85] light mode color adjustments --- .../modules/components/ApiPage/ApiItem.tsx | 67 ++++++++++--------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 6f28c887fd4689..5324a8ccb1a296 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -16,21 +16,22 @@ const Root = styled('div')( position: 'relative', textDecoration: 'none', marginBottom: '12px', - lineHeight: '18px', fontFamily: theme.typography.fontFamilyCode, + '& .MuiApi-item-link-visual': { display: 'none', - border: 'solid 1px', - borderRadius: '4px', - borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, + border: '1px solid', + borderColor: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, + borderRadius: '6px', + backgroundColor: alpha(lightBlue[100], 0.5), width: '24px', height: '24px', - textAlign: 'center', lineHeight: '24px', + textAlign: 'center', position: 'absolute', left: '-32px', '& svg': { - borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.primary[500]})`, fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, height: '11px', width: '11px', @@ -40,18 +41,18 @@ const Root = styled('div')( color: '#2D3843', borderBottom: 'solid 1px', fontWeight: 400, - borderColor: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, padding: '2px 6px', }, '& .MuiApi-item-title': { borderWidth: '1px', borderStyle: 'solid', - borderTopLeftRadius: '4px', - borderTopRightRadius: '4px', - borderBottomLeftRadius: '4px', - color: `var(--muidocs-palette-primary-700, ${lightTheme.palette.primary[700]})`, + borderTopLeftRadius: '6px', + borderTopRightRadius: '6px', + borderBottomLeftRadius: '6px', fontWeight: theme.typography.fontWeightSemiBold, - backgroundColor: grey[200], + color: `var(--muidocs-palette-primary-600, ${lightTheme.palette.primary[600]})`, + backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, }, '& .MuiApi-item-description': { flexGrow: 1, @@ -68,43 +69,43 @@ const Root = styled('div')( '&:hover': { cursor: 'pointer', span: { - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + borderColor: `var(--muidocs-palette-blue-500, ${lightTheme.palette.primary[500]})`, }, '.MuiApi-item-title': { backgroundColor: alpha(lightBlue[100], 0.5), }, - '& .MuiApi-item-link-visual': { - backgroundColor: alpha(lightBlue[100], 0.5), - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, - '& svg': { - fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, - }, - }, }, }, '& .MuiAlert-standardWarning': { - border: 'solid #FFF3C1 1px', - backgroundColor: '#FFF9EBB2', - color: '#5A3600', - - fontFamily: theme.typography.fontFamilyCode, + fontWeight: theme.typography.fontWeightMedium, + border: '1px solid', + borderColor: `var(--muidocs-palette-grey-100, ${lightTheme.palette.grey[100]})`, + backgroundColor: `var(--muidocs-palette-warning-50, ${lightTheme.palette.warning[50]})`, + color: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, + marginBottom: '16px', '.MuiAlert-icon': { display: 'flex', alignItems: 'center', - fill: '#AB6800', + fill: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, }, }, '& .default-props': { + ...theme.typography.body2, + fontWeight: theme.typography.fontWeightMedium, display: 'flex', alignItems: 'center', span: { - marginRight: 8, + marginRight: 6, whiteSpace: 'nowrap', }, code: { - border: 'solid #E0E3E7 1px', - backgroundColor: '#F3F6F9', + ...theme.typography.caption, + fontFamily: theme.typography.fontFamilyCode, + fontWeight: theme.typography.fontWeightRegular, padding: '2px 6px', + border: '1px solid', + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + backgroundColor: `var(--muidocs-palette-grey-50, ${lightTheme.palette.grey[50]})`, }, }, marginBottom: 32, @@ -113,15 +114,15 @@ const Root = styled('div')( [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { '& .MuiApi-item-header': { '& span': { - borderColor: '#2F3A46', + borderColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, }, '& .MuiApi-item-title': { - color: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, - backgroundColor: '#1F262E', + color: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-800, ${darkTheme.palette.primaryDark[800]})`, }, '& .MuiApi-item-link-visual': { borderColor: '#2F3A46', - backgroundColor: '#1F262E', + backgroundColor: '#00baff', '& svg': { fill: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, }, From 71f8a8957ca45f9d85f3899a0f6db275b065ea84 Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 10:44:58 -0300 Subject: [PATCH 07/85] dark mode color adjustments --- .../modules/components/ApiPage/ApiItem.tsx | 31 +++++++++---------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 829f266b877fd2..f062e47f685e35 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -26,7 +26,7 @@ const Root = styled('div')( width: '24px', height: '24px', lineHeight: '24px', - textAlignment: 'center', + textAlign: 'center', '& svg': { borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.primary[500]})`, fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, @@ -35,11 +35,10 @@ const Root = styled('div')( }, }, span: { - color: '#2D3843', + padding: '2px 6px', + fontWeight: theme.typography.fontWeightRegular, borderBottom: 'solid 1px', - fontWeight: 400, borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, - padding: '2px 6px', }, '& .MuiApi-item-title': { marginLeft: 32, @@ -117,12 +116,12 @@ const Root = styled('div')( borderColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, }, '& .MuiApi-item-title': { - color: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, + color: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, backgroundColor: `var(--muidocs-palette-primaryDark-800, ${darkTheme.palette.primaryDark[800]})`, }, '& .MuiApi-item-link-visual': { - borderColor: '#2F3A46', - backgroundColor: '#00baff', + borderColor: `var(--muidocs-palette-primaryDark-400, ${darkTheme.palette.primaryDark[400]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, '& svg': { fill: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, }, @@ -137,25 +136,25 @@ const Root = styled('div')( }, }, '& .MuiApi-item-description': { - color: '#B2BAC2', + color: `var(--muidocs-palette-grey-500, ${darkTheme.palette.grey[500]})`, }, '& .MuiApi-item-note': { - color: `var(--muidocs-palette-green-400, #3EE07F)`, + color: `var(--muidocs-palette-success-500, ${darkTheme.palette.success[400]})`, }, }, '& .MuiAlert-standardWarning': { - borderColor: '#5A3600', - backgroundColor: '#F4C0001A', - color: '#FFDC48', + borderColor: alpha(darkTheme.palette.warning[600], 0.2), + backgroundColor: alpha(darkTheme.palette.warning[800], 0.2), + color: `var(--muidocs-palette-warning-300, ${darkTheme.palette.warning[300]})`, '.MuiAlert-icon svg': { - fill: '#FFDC48', + fill: `var(--muidocs-palette-warning-400, ${darkTheme.palette.warning[400]})`, }, }, '& .default-props': { - color: '#A0AAB4', + color: `var(--muidocs-palette-grey-300, ${darkTheme.palette.grey[300]})`, code: { - borderColor: '#1F262E', - backgroundColor: '#141A1F', + borderColor: `var(--muidocs-palette-grey-800, ${darkTheme.palette.grey[800]})`, + backgroundColor: alpha(darkTheme.palette.grey[900], 0.5), }, }, }, From a78301bde5cb67ea75792e7ded6b88b5e5263da0 Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 10:54:54 -0300 Subject: [PATCH 08/85] more color adjusments --- .../modules/components/ApiPage/ApiItem.tsx | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index f062e47f685e35..ba9da190224590 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -20,16 +20,16 @@ const Root = styled('div')( '& .MuiApi-item-link-visual': { display: 'none', border: '1px solid', - borderColor: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, + borderColor: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, borderRadius: '6px', - backgroundColor: alpha(lightBlue[100], 0.5), + backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, width: '24px', height: '24px', lineHeight: '24px', textAlign: 'center', '& svg': { borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.primary[500]})`, - fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + fill: `var(--muidocs-palette-primary-600, ${lightTheme.palette.primary[600]})`, height: '11px', width: '11px', }, @@ -68,9 +68,9 @@ const Root = styled('div')( '.MuiApi-item-link-visual:hover': { cursor: 'pointer', backgroundColor: alpha(lightBlue[100], 0.5), - borderColor: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + borderColor: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, '& svg': { - fill: `var(--muidocs-palette-blue-700, ${lightTheme.palette.primary[700]})`, + fill: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, }, }, }, @@ -78,7 +78,7 @@ const Root = styled('div')( '& .MuiAlert-standardWarning': { fontWeight: theme.typography.fontWeightMedium, border: '1px solid', - borderColor: `var(--muidocs-palette-grey-100, ${lightTheme.palette.grey[100]})`, + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, backgroundColor: `var(--muidocs-palette-warning-50, ${lightTheme.palette.warning[50]})`, color: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, marginBottom: '16px', @@ -107,7 +107,7 @@ const Root = styled('div')( backgroundColor: `var(--muidocs-palette-grey-50, ${lightTheme.palette.grey[50]})`, }, }, - marginBottom: 32, + marginBottom: 40, }), ({ theme }) => ({ [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { @@ -123,15 +123,15 @@ const Root = styled('div')( borderColor: `var(--muidocs-palette-primaryDark-400, ${darkTheme.palette.primaryDark[400]})`, backgroundColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, '& svg': { - fill: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, + fill: `var(--muidocs-palette-primary-200, ${darkTheme.palette.primary[200]})`, }, }, '&:hover, &:target': { '.MuiApi-item-link-visual:hover': { - borderColor: `#3399FF`, - backgroundColor: `#0059B24D`, + borderColor: `var(--muidocs-palette-primary-300, ${darkTheme.palette.primary[300]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, '& svg': { - fill: '#99CCF3', + fill: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, }, }, }, From 88197c9fb7dd57120674bb316198c523112f9273 Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 10:58:38 -0300 Subject: [PATCH 09/85] minor tweaks --- docs/src/modules/components/ApiPage/ApiItem.tsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index ba9da190224590..e3088aee1355a3 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -12,10 +12,10 @@ const Root = styled('div')( ({ theme }) => ({ '& .MuiApi-item-header': { ...theme.typography.caption, + fontFamily: theme.typography.fontFamilyCode, display: 'flex', position: 'relative', - marginBottom: '12px', - fontFamily: theme.typography.fontFamilyCode, + marginBottom: 12, marginLeft: -32, '& .MuiApi-item-link-visual': { display: 'none', @@ -63,7 +63,7 @@ const Root = styled('div')( display: 'inline-block', }, '.MuiApi-item-title': { - marginLeft: '8px', + marginLeft: 8, }, '.MuiApi-item-link-visual:hover': { cursor: 'pointer', From d05a93acddd5e2129ca10e71132380cf057fbdbe Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 17:29:17 -0300 Subject: [PATCH 10/85] fix lint --- docs/src/modules/components/ApiPage/ApiItem.tsx | 2 +- docs/src/modules/components/ApiPage/CSSList.tsx | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index e3088aee1355a3..84253a6132c24e 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -2,7 +2,7 @@ import * as React from 'react'; import PropTypes from 'prop-types'; import { alpha, styled } from '@mui/material/styles'; -import { green, grey, lightBlue } from '@mui/material/colors'; +import { green, lightBlue } from '@mui/material/colors'; import { brandingDarkTheme as darkTheme, brandingLightTheme as lightTheme, diff --git a/docs/src/modules/components/ApiPage/CSSList.tsx b/docs/src/modules/components/ApiPage/CSSList.tsx index 21f3c755408f4f..472bf9417bd668 100644 --- a/docs/src/modules/components/ApiPage/CSSList.tsx +++ b/docs/src/modules/components/ApiPage/CSSList.tsx @@ -1,8 +1,6 @@ /* eslint-disable react/no-danger */ import * as React from 'react'; import PropTypes from 'prop-types'; - -import { useTranslate } from 'docs/src/modules/utils/i18n'; import ApiItem from './ApiItem'; export type CSSListProps = { From 420a443c3031f04e41ff8d1c8cab871a8b65a41a Mon Sep 17 00:00:00 2001 From: danilo leal <67129314+danilo-leal@users.noreply.github.com> Date: Mon, 29 May 2023 18:33:13 -0300 Subject: [PATCH 11/85] further customizations + anchor link consistency between API & Markdown --- .../modules/components/ApiPage/ApiItem.tsx | 54 ++++++++++--------- .../src/modules/components/MarkdownElement.js | 14 +++-- 2 files changed, 38 insertions(+), 30 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 84253a6132c24e..7694d1747d53a7 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -2,7 +2,6 @@ import * as React from 'react'; import PropTypes from 'prop-types'; import { alpha, styled } from '@mui/material/styles'; -import { green, lightBlue } from '@mui/material/colors'; import { brandingDarkTheme as darkTheme, brandingLightTheme as lightTheme, @@ -11,66 +10,71 @@ import { const Root = styled('div')( ({ theme }) => ({ '& .MuiApi-item-header': { - ...theme.typography.caption, + fontSize: 13, fontFamily: theme.typography.fontFamilyCode, display: 'flex', + alignItems: 'flex-end', position: 'relative', marginBottom: 12, marginLeft: -32, '& .MuiApi-item-link-visual': { display: 'none', + flexShrink: 0, border: '1px solid', - borderColor: `var(--muidocs-palette-primary-200, ${lightTheme.palette.primary[200]})`, - borderRadius: '6px', + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + borderRadius: 8, backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, - width: '24px', - height: '24px', - lineHeight: '24px', + height: 26, + width: 26, + lineHeight: '30px', textAlign: 'center', '& svg': { - borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.primary[500]})`, - fill: `var(--muidocs-palette-primary-600, ${lightTheme.palette.primary[600]})`, - height: '11px', - width: '11px', + fill: `var(--muidocs-palette-text-secondary, ${lightTheme.palette.text.secondary})`, + height: '14px', + width: '14px', }, }, span: { - padding: '2px 6px', fontWeight: theme.typography.fontWeightRegular, borderBottom: 'solid 1px', borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, }, '& .MuiApi-item-title': { + flexShrink: 0, + padding: '2px 6px', + height: 'fit-content', marginLeft: 32, borderWidth: '1px', borderStyle: 'solid', - borderTopLeftRadius: '6px', - borderTopRightRadius: '6px', - borderBottomLeftRadius: '6px', + borderTopLeftRadius: 8, + borderTopRightRadius: 8, + borderBottomLeftRadius: 8, fontWeight: theme.typography.fontWeightSemiBold, color: `var(--muidocs-palette-primary-600, ${lightTheme.palette.primary[600]})`, backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, }, '& .MuiApi-item-description': { + padding: 6, + paddingBottom: 3, flexGrow: 1, }, '& .MuiApi-item-note': { padding: '2px 6px', - color: `var(--muidocs-palette-green-800, ${green[800]})`, + color: `var(--muidocs-palette-success-800, ${lightTheme.palette.success[800]})`, }, '&:hover, &:target': { '.MuiApi-item-link-visual': { display: 'inline-block', }, '.MuiApi-item-title': { - marginLeft: 8, + marginLeft: 6, }, '.MuiApi-item-link-visual:hover': { cursor: 'pointer', - backgroundColor: alpha(lightBlue[100], 0.5), - borderColor: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, + backgroundColor: alpha(lightTheme.palette.primary[100], 0.4), + borderColor: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, '& svg': { - fill: `var(--muidocs-palette-primary-500, ${lightTheme.palette.primary[500]})`, + fill: `var(--muidocs-palette-primary-main, ${lightTheme.palette.primary.main})`, }, }, }, @@ -81,7 +85,7 @@ const Root = styled('div')( borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, backgroundColor: `var(--muidocs-palette-warning-50, ${lightTheme.palette.warning[50]})`, color: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, - marginBottom: '16px', + marginBottom: 16, '.MuiAlert-icon': { display: 'flex', alignItems: 'center', @@ -101,13 +105,13 @@ const Root = styled('div')( ...theme.typography.caption, fontFamily: theme.typography.fontFamilyCode, fontWeight: theme.typography.fontWeightRegular, - padding: '2px 6px', + padding: '2px 4px', border: '1px solid', borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, backgroundColor: `var(--muidocs-palette-grey-50, ${lightTheme.palette.grey[50]})`, }, }, - marginBottom: 40, + marginBottom: 32, }), ({ theme }) => ({ [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { @@ -120,7 +124,7 @@ const Root = styled('div')( backgroundColor: `var(--muidocs-palette-primaryDark-800, ${darkTheme.palette.primaryDark[800]})`, }, '& .MuiApi-item-link-visual': { - borderColor: `var(--muidocs-palette-primaryDark-400, ${darkTheme.palette.primaryDark[400]})`, + borderColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, backgroundColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, '& svg': { fill: `var(--muidocs-palette-primary-200, ${darkTheme.palette.primary[200]})`, @@ -128,7 +132,7 @@ const Root = styled('div')( }, '&:hover, &:target': { '.MuiApi-item-link-visual:hover': { - borderColor: `var(--muidocs-palette-primary-300, ${darkTheme.palette.primary[300]})`, + borderColor: `var(--muidocs-palette-primaryDark-400, ${darkTheme.palette.primaryDark[400]})`, backgroundColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, '& svg': { fill: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, diff --git a/docs/src/modules/components/MarkdownElement.js b/docs/src/modules/components/MarkdownElement.js index 0aa77f7d6583b6..9ac63d6d06fc02 100644 --- a/docs/src/modules/components/MarkdownElement.js +++ b/docs/src/modules/components/MarkdownElement.js @@ -144,7 +144,9 @@ const Root = styled('div')( cursor: 'pointer', display: 'inline-block', '&:hover': { - color: `var(--muidocs-palette-text-primary, ${lightTheme.palette.text.primary})`, + backgroundColor: alpha(lightTheme.palette.primary[100], 0.4), + borderColor: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, + color: `var(--muidocs-palette-primary-main, ${lightTheme.palette.primary.main})`, }, '& svg': { width: '0.875rem', @@ -488,11 +490,13 @@ const Root = styled('div')( }, '& h1, & h2, & h3, & h4': { '&:hover .anchor-link, & .comment-link': { - color: `var(--muidocs-palette-text-secondary, ${darkTheme.palette.text.secondary})`, - backgroundColor: alpha(darkTheme.palette.primaryDark[800], 0.3), - borderColor: `var(--muidocs-palette-primaryDark-500, ${darkTheme.palette.primaryDark[500]})`, + color: `var(--muidocs-palette-primary-200, ${darkTheme.palette.primary[200]})`, + borderColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, '&:hover': { - color: `var(--muidocs-palette-text-primary, ${darkTheme.palette.text.primary})`, + borderColor: `var(--muidocs-palette-primaryDark-400, ${darkTheme.palette.primaryDark[400]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, + color: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, }, }, }, From a65d4732f80451e2d6ec82938240756b8e669587 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 30 May 2023 09:10:38 +0200 Subject: [PATCH 12/85] remove comments --- .../modules/components/ApiPage/CSSList.tsx | 52 ------------------- 1 file changed, 52 deletions(-) diff --git a/docs/src/modules/components/ApiPage/CSSList.tsx b/docs/src/modules/components/ApiPage/CSSList.tsx index 472bf9417bd668..a15e3ce1151efe 100644 --- a/docs/src/modules/components/ApiPage/CSSList.tsx +++ b/docs/src/modules/components/ApiPage/CSSList.tsx @@ -24,19 +24,6 @@ export default function CSSList(props: CSSListProps) { return ( - {/*
  • - Prop this is a class - Required -
    • - - - - - - - - - */} {componentStyles.classes.map((className) => { const isGlobalStateClass = !!componentStyles.globalClasses[className]; return ( @@ -65,47 +52,8 @@ export default function CSSList(props: CSSListProps) { }} /> - // - // - // - // ); })} - {/* -
    {t('api-docs.ruleName')}{t('api-docs.globalClass')}{t('api-docs.description')}
    - // - // {isGlobalStateClass ? ( - // - // {className} - // - // - // ) : ( - // className - // )} - // - // - // - // . - // {componentStyles.globalClasses[className] || - // `${componentStyles.name}-${className}`} - // - // - //
    */} ); } From ab76fa40f7777957267d7bf4bd75408715190b94 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 30 May 2023 10:03:49 +0200 Subject: [PATCH 13/85] make hash works on base pages too --- .../modules/components/ApiPage/CSSList.tsx | 6 +- .../components/ComponentsApiContent.js | 75 +++---------------- .../src/modules/components/PropertiesTable.js | 11 ++- 3 files changed, 24 insertions(+), 68 deletions(-) diff --git a/docs/src/modules/components/ApiPage/CSSList.tsx b/docs/src/modules/components/ApiPage/CSSList.tsx index a15e3ce1151efe..5f6c387388ae86 100644 --- a/docs/src/modules/components/ApiPage/CSSList.tsx +++ b/docs/src/modules/components/ApiPage/CSSList.tsx @@ -16,19 +16,21 @@ export type CSSListProps = { conditions?: string; }; }; + componentName?: string; }; export default function CSSList(props: CSSListProps) { - const { componentStyles, classDescriptions } = props; + const { componentStyles, classDescriptions, componentName } = props; // const t = useTranslate(); + const hashPrefix = componentName ? `${componentName}-` : ''; return ( {componentStyles.classes.map((className) => { const isGlobalStateClass = !!componentStyles.globalClasses[className]; return ( - - - {t('api-docs.ruleName')} - {t('api-docs.globalClass')} - {t('api-docs.description')} - - - - {componentStyles.classes.map((className) => { - const isGlobalStateClass = !!componentStyles.globalClasses[className]; - return ( - - - - {isGlobalStateClass ? ( - - {className} - - - ) : ( - className - )} - - - - - . - {componentStyles.globalClasses[className] || - `${componentStyles.name}-${className}`} - - - - - ); - })} - - - ); -} - -CSSTable.propTypes = { - classDescriptions: PropTypes.object.isRequired, - componentStyles: PropTypes.object.isRequired, -}; +import CSSList from './ApiPage/CSSList'; function getTranslatedHeader(t, header, text) { const translations = { @@ -214,7 +153,11 @@ import { ${pageContent.name} } from '${source}';`}

    - +
    {cssComponent && ( @@ -265,7 +208,11 @@ import { ${pageContent.name} } from '${source}';`} {Object.keys(componentStyles.classes).length ? ( - +

    {Object.entries(properties) @@ -25,7 +31,7 @@ export default function PropertiesTable(props) { return ( Date: Tue, 30 May 2023 10:03:57 +0200 Subject: [PATCH 14/85] remove comments --- .../src/modules/components/PropertiesTable.js | 41 ------------------- 1 file changed, 41 deletions(-) diff --git a/docs/src/modules/components/PropertiesTable.js b/docs/src/modules/components/PropertiesTable.js index 626aec32084fe3..7e0758c4f11820 100644 --- a/docs/src/modules/components/PropertiesTable.js +++ b/docs/src/modules/components/PropertiesTable.js @@ -84,48 +84,7 @@ export default function PropertiesTable(props) { )} ); - // - // - // - // {propName} - // {propData.required && !showOptionalAbbr && ( - // - // * - // - // )} - // {!propData.required && showOptionalAbbr && ( - // - // ? - // - // )} - // - // - // - // - // - // {showDefaultPropColumn && ( - // - // {propDefault && {propDefault}} - // - // )} - // - - //

    - // - // - // ); })} - {/* - */} ); } From afde5e2d5d538bd66a0d58d213ee6f057d31eb73 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 30 May 2023 10:04:19 +0200 Subject: [PATCH 15/85] simplify --- docs/src/modules/components/PropertiesTable.js | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/src/modules/components/PropertiesTable.js b/docs/src/modules/components/PropertiesTable.js index 7e0758c4f11820..6d9bfdbe521605 100644 --- a/docs/src/modules/components/PropertiesTable.js +++ b/docs/src/modules/components/PropertiesTable.js @@ -1,15 +1,10 @@ /* eslint-disable react/no-danger */ import * as React from 'react'; import PropTypes from 'prop-types'; -import { styled } from '@mui/material/styles'; import Alert from '@mui/material/Alert'; import { useTranslate } from 'docs/src/modules/utils/i18n'; import ApiItem from './ApiPage/ApiItem'; -const Wrapper = styled('div')({ - // overflow: 'hidden', -}); - export default function PropertiesTable(props) { const { properties, @@ -21,7 +16,7 @@ export default function PropertiesTable(props) { const hashPrefix = componentName ? `${componentName}-` : ''; return ( - +
    {Object.entries(properties) .filter(([, propData]) => propData.description !== '@ignore') .map(([propName, propData]) => { @@ -85,7 +80,7 @@ export default function PropertiesTable(props) { ); })} - +
    ); } From 0dc7b550d69efedb16444ab4aa62f2ed792b8dd1 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 30 May 2023 10:24:46 +0200 Subject: [PATCH 16/85] move slots --- docs/src/modules/components/ApiPage.js | 113 +----------------- .../modules/components/ApiPage/SlotsList.tsx | 48 ++++++++ .../components/ComponentsApiContent.js | 9 +- 3 files changed, 57 insertions(+), 113 deletions(-) create mode 100644 docs/src/modules/components/ApiPage/SlotsList.tsx diff --git a/docs/src/modules/components/ApiPage.js b/docs/src/modules/components/ApiPage.js index a86f6dff54647b..111a9658333b43 100644 --- a/docs/src/modules/components/ApiPage.js +++ b/docs/src/modules/components/ApiPage.js @@ -12,116 +12,7 @@ import AppLayoutDocs from 'docs/src/modules/components/AppLayoutDocs'; import Ad from 'docs/src/modules/components/Ad'; import { sxChip } from './AppNavDrawerItem'; import CSSList from './ApiPage/CSSList'; - -function CSSTable(props) { - const { componentStyles, classDescriptions } = props; - const t = useTranslate(); - - return ( - - - - - - - - - - {componentStyles.classes.map((className) => { - const isGlobalStateClass = !!componentStyles.globalClasses[className]; - return ( - - - - - ); - })} - -
    {t('api-docs.ruleName')}{t('api-docs.globalClass')}{t('api-docs.description')}
    - - {isGlobalStateClass ? ( - - {className} - - - ) : ( - className - )} - - - - . - {componentStyles.globalClasses[className] || - `${componentStyles.name}-${className}`} - - -
    - ); -} - -CSSTable.propTypes = { - classDescriptions: PropTypes.object.isRequired, - componentStyles: PropTypes.object.isRequired, -}; - -export function SlotsTable(props) { - const { componentSlots, slotDescriptions } = props; - const t = useTranslate(); - - return ( - - - - - - - - - - - {componentSlots.map(({ class: className, name, default: defaultValue }) => { - return ( - - - - - - ); - })} - -
    {t('api-docs.name')}{t('api-docs.defaultClass')}{t('api-docs.defaultHTMLTag')}{t('api-docs.description')}
    - {name} - - - - {defaultValue && {defaultValue}} - -
    - ); -} - -SlotsTable.propTypes = { - componentSlots: PropTypes.array.isRequired, - slotDescriptions: PropTypes.object.isRequired, -}; +import { SlotsList } from './ApiPage/SlotsList'; export function ClassesTable(props) { const { componentClasses, classDescriptions, componentName } = props; @@ -450,7 +341,7 @@ import { ${pageContent.name} } from '${source}';`} }} /> )} - +

    + {componentSlots.map(({ class: className, name, default: defaultValue }) => { + return ( + + {className && ( +

    + {t('api-docs.globalClass')}:{' '} + +

    + )} + {slotDescriptions[name] && ( +

    + {t('api-docs.description')}:{' '} + +

    + )} + + ); + })} +
    + ); +} diff --git a/docs/src/modules/components/ComponentsApiContent.js b/docs/src/modules/components/ComponentsApiContent.js index 514818f0b7b221..18a30480d78103 100644 --- a/docs/src/modules/components/ComponentsApiContent.js +++ b/docs/src/modules/components/ComponentsApiContent.js @@ -5,12 +5,13 @@ import kebabCase from 'lodash/kebabCase'; import { useRouter } from 'next/router'; import { exactProp } from '@mui/utils'; import { useTranslate, useUserLanguage } from 'docs/src/modules/utils/i18n'; -import { SlotsTable, ClassesTable } from 'docs/src/modules/components/ApiPage'; +import { ClassesTable } from 'docs/src/modules/components/ApiPage'; import Divider from 'docs/src/modules/components/ApiDivider'; import PropertiesTable from 'docs/src/modules/components/PropertiesTable'; import HighlightedCode from 'docs/src/modules/components/HighlightedCode'; import MarkdownElement from 'docs/src/modules/components/MarkdownElement'; import CSSList from './ApiPage/CSSList'; +import SlotsList from './ApiPage/SlotsList'; function getTranslatedHeader(t, header, text) { const translations = { @@ -238,7 +239,11 @@ import { ${pageContent.name} } from '${source}';`} }} /> )} - +

    Date: Tue, 30 May 2023 10:56:59 +0200 Subject: [PATCH 17/85] fix --- docs/src/modules/components/ApiPage.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/modules/components/ApiPage.js b/docs/src/modules/components/ApiPage.js index 111a9658333b43..fc809afedf8d61 100644 --- a/docs/src/modules/components/ApiPage.js +++ b/docs/src/modules/components/ApiPage.js @@ -12,7 +12,7 @@ import AppLayoutDocs from 'docs/src/modules/components/AppLayoutDocs'; import Ad from 'docs/src/modules/components/Ad'; import { sxChip } from './AppNavDrawerItem'; import CSSList from './ApiPage/CSSList'; -import { SlotsList } from './ApiPage/SlotsList'; +import SlotsList from './ApiPage/SlotsList'; export function ClassesTable(props) { const { componentClasses, classDescriptions, componentName } = props; From 0269b3fb7332365ccc731e12b2b00175e76fbf2f Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 31 May 2023 08:42:55 -0300 Subject: [PATCH 18/85] add typography spread back so we don't lose scroll anchoring --- docs/src/modules/components/ApiPage/ApiItem.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 7694d1747d53a7..7816a394d15a59 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -10,6 +10,7 @@ import { const Root = styled('div')( ({ theme }) => ({ '& .MuiApi-item-header': { + ...theme.typography.caption, fontSize: 13, fontFamily: theme.typography.fontFamilyCode, display: 'flex', From f419de720161d081102c338ae81e77eedcbdbb6c Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 31 May 2023 08:44:59 -0300 Subject: [PATCH 19/85] switch border color to divider --- docs/src/modules/components/ApiPage/ApiItem.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 7816a394d15a59..b01ebf332b3cbe 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -22,7 +22,7 @@ const Root = styled('div')( display: 'none', flexShrink: 0, border: '1px solid', - borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + borderColor: `var(--muidocs-palette-divider, ${lightTheme.palette.divider})`, borderRadius: 8, backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, height: 26, @@ -118,7 +118,7 @@ const Root = styled('div')( [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { '& .MuiApi-item-header': { '& span': { - borderColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, + borderColor: `var(--muidocs-palette-divider, ${darkTheme.palette.divider})`, }, '& .MuiApi-item-title': { color: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, From c4e4b04470832124039c5cf8fa3c650c6da3db73 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 2 Jun 2023 12:32:54 +0200 Subject: [PATCH 20/85] update docs:api --- .../ApiBuilders/ComponentApiBuilder.ts | 105 +++++++++++++----- .../utils/generatePropDescription.ts | 62 ++++++----- 2 files changed, 109 insertions(+), 58 deletions(-) diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts index a61f12ae12ca76..aca7e5a09e2c9a 100644 --- a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts +++ b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts @@ -24,6 +24,15 @@ import parseStyles, { Classes, Styles } from '../utils/parseStyles'; import { TypeScriptProject } from '../utils/createTypeScriptProject'; import parseSlotsAndClasses, { Slot } from '../utils/parseSlotsAndClasses'; +export type AdditionalPropsInfo = { + cssApi?: boolean; + sx?: boolean; + slotsApi?: boolean; + 'joy-size'?: boolean; + 'joy-color'?: boolean; + 'joy-variant'?: boolean; +}; + export interface ReactApi extends ReactDocgenApi { demos: ReturnType; EOL: string; @@ -58,10 +67,19 @@ export interface ReactApi extends ReactDocgenApi { type: { name: string | undefined; description: string | undefined }; deprecated: true | undefined; deprecationInfo: string | undefined; + signature: undefined | { type: string; describedArgs?: string[]; returned?: string }; + additionalInfo?: AdditionalPropsInfo; }>; translations: { componentDescription: string; - propDescriptions: { [key: string]: string | undefined }; + propDescriptions: { + [key: string]: { + description: string; + notes?: string; + deprecated?: string; + typeDescriptions?: { [t: string]: string }; + }; + }; classDescriptions: { [key: string]: { description: string; conditions?: string } }; slotDescriptions?: { [key: string]: string }; }; @@ -419,36 +437,23 @@ const attachTranslations = (reactApi: ReactApi) => { prop = null; } if (prop) { - let description = generatePropDescription(prop, propName); - description = renderMarkdownInline(description); - - const normalizedApiPathname = reactApi.apiPathname.replace(/\\/g, '/'); + const { deprecated, jsDocText, signatureArgs, signatureReturn, notes } = + generatePropDescription(prop, propName); + // description = renderMarkdownInline(`${description}`); + + const typeDescriptions: { [t: string]: string } = {}; + [...(signatureArgs ?? []), ...(signatureReturn ? [signatureReturn] : [])].forEach( + ({ name, description }) => { + typeDescriptions[name] = renderMarkdownInline(description); + }, + ); - if (propName === 'classes') { - description += ' See CSS API below for more details.'; - } else if (propName === 'sx') { - description += - ' See the `sx` page for more details.'; - } else if (propName === 'slots' && !normalizedApiPathname.startsWith('/material-ui')) { - description += ' See Slots API below for more details.'; - } else if (normalizedApiPathname.startsWith('/joy-ui')) { - switch (propName) { - case 'size': - description += - ' To learn how to add custom sizes to the component, check out Themed components—Extend sizes.'; - break; - case 'color': - description += - ' To learn how to add your own colors, check out Themed components—Extend colors.'; - break; - case 'variant': - description += - ' To learn how to add your own variants, check out Themed components—Extend variants.'; - break; - default: - } - } - translations.propDescriptions[propName] = description.replace(/\n@default.*$/, ''); + translations.propDescriptions[propName] = { + description: renderMarkdownInline(jsDocText), + notes: renderMarkdownInline(notes), + deprecated: renderMarkdownInline(deprecated), + typeDescriptions, + }; } }); @@ -493,6 +498,11 @@ const attachPropsTable = (reactApi: ReactApi) => { const defaultValue = propDescriptor.jsdocDefaultValue?.value; + const { + signature: signatureType, + signatureArgs, + signatureReturn, + } = generatePropDescription(prop, propName); const propTypeDescription = generatePropTypeDescription(propDescriptor.type); const chainedPropType = getChained(prop.type); @@ -503,6 +513,39 @@ const attachPropsTable = (reactApi: ReactApi) => { const deprecation = (propDescriptor.description || '').match(/@deprecated(\s+(?.*))?/); + const additionalPropsInfo: AdditionalPropsInfo = {}; + + const normalizedApiPathname = reactApi.apiPathname.replace(/\\/g, '/'); + + if (propName === 'classes') { + additionalPropsInfo.cssApi = true; + } else if (propName === 'sx') { + additionalPropsInfo.sx = true; + } else if (propName === 'slots' && !normalizedApiPathname.startsWith('/material-ui')) { + additionalPropsInfo.slotsApi = true; + } else if (normalizedApiPathname.startsWith('/joy-ui')) { + switch (propName) { + case 'size': + additionalPropsInfo['joy-size'] = true; + break; + case 'color': + additionalPropsInfo['joy-color'] = true; + break; + case 'variant': + additionalPropsInfo['joy-variant'] = true; + break; + default: + } + } + + let signature; + if (signatureType !== undefined) { + signature = { + type: signatureType, + describedArgs: signatureArgs?.map((arg) => arg.name), + returned: signatureReturn?.name, + }; + } return [ propName, { @@ -517,6 +560,8 @@ const attachPropsTable = (reactApi: ReactApi) => { deprecated: !!deprecation || undefined, deprecationInfo: renderMarkdownInline(deprecation?.groups?.info || '').trim() || undefined, + signature, + additionalPropsInfo, }, ]; }), diff --git a/packages/api-docs-builder/utils/generatePropDescription.ts b/packages/api-docs-builder/utils/generatePropDescription.ts index 5cdaa9fbac65c5..12a4f930f3b536 100644 --- a/packages/api-docs-builder/utils/generatePropDescription.ts +++ b/packages/api-docs-builder/utils/generatePropDescription.ts @@ -74,7 +74,14 @@ function getDeprecatedInfo(type: PropTypeDescriptor) { export default function generatePropDescription( prop: DescribeablePropDescriptor, propName: string, -): string { +): { + deprecated: string; + jsDocText: string; + signature?: string; + signatureArgs?: { name: string; description: string }[]; + signatureReturn?: { name: string; description: string }; + notes: string; +} { const { annotation } = prop; const type = prop.type; let deprecated = ''; @@ -92,8 +99,6 @@ export default function generatePropDescription( .replace(/(\r?\n){2}/g, '
    ') .replace(/\r?\n/g, ' '); - let signature = ''; - // Split up the parsed tags into 'arguments' and 'returns' parsed objects. If there's no // 'returns' parsed object (i.e., one with title being 'returns'), make one of type 'void'. const parsedArgs: readonly doctrine.Tag[] = annotation.tags.filter( @@ -101,6 +106,10 @@ export default function generatePropDescription( ); let parsedReturns: { description?: string | null; type?: doctrine.Type | null } | undefined = annotation.tags.find((tag) => tag.title === 'returns'); + + let signature; + let signatureArgs; + let signatureReturn; if (type.name === 'func' && (parsedArgs.length > 0 || parsedReturns !== undefined)) { parsedReturns = parsedReturns ?? { type: { type: 'VoidLiteral' } }; @@ -111,8 +120,15 @@ export default function generatePropDescription( } }); - signature += '

    **Signature:**
    `function('; - signature += parsedArgs + const returnType = parsedReturns.type; + if (returnType == null) { + throw new TypeError( + `Function signature for prop '${propName}' has no return type. Try \`@returns void\`. Otherwise it might be a bug with doctrine.`, + ); + } + const returnTypeName = resolveType(returnType); + + signature = `function(${parsedArgs .map((tag, index) => { if (tag.type != null && tag.type.type === 'OptionalType') { return `${tag.name}?: ${(tag.type.expression as any).name}`; @@ -125,31 +141,14 @@ export default function generatePropDescription( } return `${tag.name}: ${resolveType(tag.type!)}`; }) - .join(', '); + .join(', ')}) => ${returnTypeName}`; - const returnType = parsedReturns.type; - if (returnType == null) { - throw new TypeError( - `Function signature for prop '${propName}' has no return type. Try \`@returns void\`. Otherwise it might be a bug with doctrine.`, - ); - } + signatureArgs = parsedArgs + .filter((tag) => tag.description && tag.name) + .map((tag) => ({ name: tag.name!, description: tag.description! })); - const returnTypeName = resolveType(returnType); - - signature += `) => ${returnTypeName}\`
    `; - - const argsWithDescription = parsedArgs.filter((tag) => tag.description); - - if (argsWithDescription.length > 0) { - signature += '

      '; - signature += parsedArgs - .filter((tag) => tag.description) - .map((tag) => `
    • ${tag.name}: ${tag.description}
      • `) - .join(''); - signature += '
    '; - } if (parsedReturns.description) { - signature += `
    *returns* (${returnTypeName}): ${parsedReturns.description}`; + signatureReturn = { name: returnTypeName, description: parsedReturns.description }; } } @@ -159,5 +158,12 @@ export default function generatePropDescription( '
    ⚠️ [Needs to be able to hold a ref](/material-ui/guides/composition/#caveat-with-refs).'; } - return `${deprecated}${jsDocText}${signature}${notes}`; + return { + deprecated, + jsDocText, + signature, + signatureArgs, + signatureReturn, + notes, + }; } From 019e15c24283696ba2c3a7aec6d985ddb3575bcb Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 2 Jun 2023 12:33:48 +0200 Subject: [PATCH 21/85] run script --- docs/pages/base/api/badge.json | 16 +- docs/pages/base/api/button.json | 17 +- docs/pages/base/api/click-away-listener.json | 20 +- docs/pages/base/api/focus-trap.json | 34 +- docs/pages/base/api/form-control.json | 21 +- docs/pages/base/api/input.json | 45 +- docs/pages/base/api/menu-item.json | 8 +- docs/pages/base/api/menu.json | 15 +- docs/pages/base/api/modal.json | 73 ++- docs/pages/base/api/no-ssr.json | 6 +- docs/pages/base/api/option-group.json | 10 +- docs/pages/base/api/option.json | 12 +- docs/pages/base/api/popper.json | 41 +- docs/pages/base/api/portal.json | 9 +- docs/pages/base/api/select.json | 46 +- docs/pages/base/api/slider.json | 92 +++- docs/pages/base/api/snackbar.json | 33 +- docs/pages/base/api/switch.json | 25 +- docs/pages/base/api/tab-panel.json | 13 +- docs/pages/base/api/tab.json | 18 +- docs/pages/base/api/table-pagination.json | 59 ++- docs/pages/base/api/tabs-list.json | 8 +- docs/pages/base/api/tabs.json | 28 +- docs/pages/base/api/textarea-autosize.json | 8 +- docs/pages/joy-ui/api/alert.json | 28 +- docs/pages/joy-ui/api/aspect-ratio.json | 35 +- .../joy-ui/api/autocomplete-listbox.json | 20 +- .../pages/joy-ui/api/autocomplete-option.json | 17 +- docs/pages/joy-ui/api/autocomplete.json | 224 +++++++-- docs/pages/joy-ui/api/avatar-group.json | 22 +- docs/pages/joy-ui/api/avatar.json | 28 +- docs/pages/joy-ui/api/badge.json | 36 +- docs/pages/joy-ui/api/breadcrumbs.json | 18 +- docs/pages/joy-ui/api/button.json | 42 +- docs/pages/joy-ui/api/card-content.json | 13 +- docs/pages/joy-ui/api/card-cover.json | 13 +- docs/pages/joy-ui/api/card-overflow.json | 19 +- docs/pages/joy-ui/api/card.json | 27 +- docs/pages/joy-ui/api/checkbox.json | 68 ++- docs/pages/joy-ui/api/chip-delete.json | 23 +- docs/pages/joy-ui/api/chip.json | 30 +- docs/pages/joy-ui/api/circular-progress.json | 30 +- docs/pages/joy-ui/api/css-baseline.json | 8 +- docs/pages/joy-ui/api/divider.json | 19 +- docs/pages/joy-ui/api/form-control.json | 28 +- docs/pages/joy-ui/api/form-helper-text.json | 13 +- docs/pages/joy-ui/api/form-label.json | 15 +- docs/pages/joy-ui/api/icon-button.json | 27 +- docs/pages/joy-ui/api/input.json | 22 +- docs/pages/joy-ui/api/linear-progress.json | 30 +- docs/pages/joy-ui/api/link.json | 35 +- docs/pages/joy-ui/api/list-divider.json | 19 +- docs/pages/joy-ui/api/list-item-button.json | 33 +- docs/pages/joy-ui/api/list-item-content.json | 13 +- .../pages/joy-ui/api/list-item-decorator.json | 13 +- docs/pages/joy-ui/api/list-item.json | 27 +- docs/pages/joy-ui/api/list-subheader.json | 21 +- docs/pages/joy-ui/api/list.json | 27 +- docs/pages/joy-ui/api/menu-item.json | 19 +- docs/pages/joy-ui/api/menu-list.json | 23 +- docs/pages/joy-ui/api/menu.json | 40 +- docs/pages/joy-ui/api/modal-close.json | 20 +- docs/pages/joy-ui/api/modal-dialog.json | 25 +- docs/pages/joy-ui/api/modal-overflow.json | 3 +- docs/pages/joy-ui/api/modal.json | 69 ++- docs/pages/joy-ui/api/option.json | 28 +- docs/pages/joy-ui/api/radio-group.json | 44 +- docs/pages/joy-ui/api/radio.json | 55 ++- .../pages/joy-ui/api/scoped-css-baseline.json | 19 +- docs/pages/joy-ui/api/select.json | 54 +- docs/pages/joy-ui/api/sheet.json | 21 +- docs/pages/joy-ui/api/slider.json | 103 ++-- docs/pages/joy-ui/api/stack.json | 17 +- docs/pages/joy-ui/api/svg-icon.json | 29 +- docs/pages/joy-ui/api/switch.json | 49 +- docs/pages/joy-ui/api/tab-list.json | 22 +- docs/pages/joy-ui/api/tab-panel.json | 19 +- docs/pages/joy-ui/api/tab.json | 32 +- docs/pages/joy-ui/api/table.json | 36 +- docs/pages/joy-ui/api/tabs.json | 42 +- docs/pages/joy-ui/api/textarea.json | 28 +- docs/pages/joy-ui/api/tooltip.json | 109 +++-- docs/pages/joy-ui/api/typography.json | 35 +- .../material-ui/api/accordion-actions.json | 9 +- .../material-ui/api/accordion-details.json | 7 +- .../material-ui/api/accordion-summary.json | 11 +- docs/pages/material-ui/api/accordion.json | 42 +- docs/pages/material-ui/api/alert-title.json | 7 +- docs/pages/material-ui/api/alert.json | 48 +- docs/pages/material-ui/api/app-bar.json | 19 +- docs/pages/material-ui/api/autocomplete.json | 296 ++++++++--- docs/pages/material-ui/api/avatar-group.json | 33 +- docs/pages/material-ui/api/avatar.json | 22 +- docs/pages/material-ui/api/backdrop.json | 34 +- docs/pages/material-ui/api/badge.json | 41 +- .../api/bottom-navigation-action.json | 18 +- .../material-ui/api/bottom-navigation.json | 22 +- docs/pages/material-ui/api/box.json | 5 +- docs/pages/material-ui/api/breadcrumbs.json | 35 +- docs/pages/material-ui/api/button-base.json | 43 +- docs/pages/material-ui/api/button-group.json | 39 +- docs/pages/material-ui/api/button.json | 42 +- .../material-ui/api/card-action-area.json | 7 +- docs/pages/material-ui/api/card-actions.json | 9 +- docs/pages/material-ui/api/card-content.json | 9 +- docs/pages/material-ui/api/card-header.json | 25 +- docs/pages/material-ui/api/card-media.json | 13 +- docs/pages/material-ui/api/card.json | 13 +- docs/pages/material-ui/api/checkbox.json | 58 ++- docs/pages/material-ui/api/chip.json | 41 +- .../material-ui/api/circular-progress.json | 24 +- docs/pages/material-ui/api/collapse.json | 28 +- docs/pages/material-ui/api/container.json | 14 +- docs/pages/material-ui/api/css-baseline.json | 8 +- .../pages/material-ui/api/dialog-actions.json | 9 +- .../material-ui/api/dialog-content-text.json | 7 +- .../pages/material-ui/api/dialog-content.json | 9 +- docs/pages/material-ui/api/dialog-title.json | 7 +- docs/pages/material-ui/api/dialog.json | 63 ++- docs/pages/material-ui/api/divider.json | 24 +- docs/pages/material-ui/api/drawer.json | 38 +- docs/pages/material-ui/api/fab.json | 30 +- docs/pages/material-ui/api/fade.json | 18 +- docs/pages/material-ui/api/filled-input.json | 95 ++-- .../material-ui/api/form-control-label.json | 39 +- docs/pages/material-ui/api/form-control.json | 33 +- docs/pages/material-ui/api/form-group.json | 9 +- .../material-ui/api/form-helper-text.json | 24 +- docs/pages/material-ui/api/form-label.json | 22 +- docs/pages/material-ui/api/global-styles.json | 3 +- docs/pages/material-ui/api/grid.json | 48 +- docs/pages/material-ui/api/grow.json | 18 +- docs/pages/material-ui/api/hidden.json | 31 +- docs/pages/material-ui/api/icon-button.json | 26 +- docs/pages/material-ui/api/icon.json | 21 +- .../material-ui/api/image-list-item-bar.json | 17 +- .../material-ui/api/image-list-item.json | 21 +- docs/pages/material-ui/api/image-list.json | 23 +- .../material-ui/api/input-adornment.json | 27 +- docs/pages/material-ui/api/input-base.json | 101 ++-- docs/pages/material-ui/api/input-label.json | 34 +- docs/pages/material-ui/api/input.json | 93 ++-- .../material-ui/api/linear-progress.json | 15 +- docs/pages/material-ui/api/link.json | 22 +- .../material-ui/api/list-item-avatar.json | 7 +- .../material-ui/api/list-item-button.json | 26 +- .../pages/material-ui/api/list-item-icon.json | 7 +- .../api/list-item-secondary-action.json | 7 +- .../pages/material-ui/api/list-item-text.json | 23 +- docs/pages/material-ui/api/list-item.json | 56 ++- .../pages/material-ui/api/list-subheader.json | 18 +- docs/pages/material-ui/api/list.json | 15 +- .../pages/material-ui/api/loading-button.json | 20 +- docs/pages/material-ui/api/masonry.json | 21 +- docs/pages/material-ui/api/menu-item.json | 21 +- docs/pages/material-ui/api/menu-list.json | 21 +- docs/pages/material-ui/api/menu.json | 43 +- .../pages/material-ui/api/mobile-stepper.json | 29 +- docs/pages/material-ui/api/modal.json | 94 +++- docs/pages/material-ui/api/native-select.json | 35 +- .../pages/material-ui/api/outlined-input.json | 89 ++-- .../material-ui/api/pagination-item.json | 34 +- docs/pages/material-ui/api/pagination.json | 82 +++- docs/pages/material-ui/api/paper.json | 20 +- docs/pages/material-ui/api/popover.json | 57 ++- docs/pages/material-ui/api/popper.json | 49 +- docs/pages/material-ui/api/radio-group.json | 17 +- docs/pages/material-ui/api/radio.json | 50 +- docs/pages/material-ui/api/rating.json | 75 ++- .../material-ui/api/scoped-css-baseline.json | 11 +- docs/pages/material-ui/api/select.json | 80 ++- docs/pages/material-ui/api/skeleton.json | 25 +- docs/pages/material-ui/api/slide.json | 24 +- docs/pages/material-ui/api/slider.json | 110 +++-- .../material-ui/api/snackbar-content.json | 11 +- docs/pages/material-ui/api/snackbar.json | 56 ++- .../material-ui/api/speed-dial-action.json | 24 +- .../material-ui/api/speed-dial-icon.json | 9 +- docs/pages/material-ui/api/speed-dial.json | 51 +- docs/pages/material-ui/api/stack.json | 17 +- docs/pages/material-ui/api/step-button.json | 11 +- .../pages/material-ui/api/step-connector.json | 5 +- docs/pages/material-ui/api/step-content.json | 18 +- docs/pages/material-ui/api/step-icon.json | 13 +- docs/pages/material-ui/api/step-label.json | 23 +- docs/pages/material-ui/api/step.json | 21 +- docs/pages/material-ui/api/stepper.json | 32 +- docs/pages/material-ui/api/svg-icon.json | 25 +- .../material-ui/api/swipeable-drawer.json | 51 +- docs/pages/material-ui/api/switch.json | 45 +- docs/pages/material-ui/api/tab-context.json | 4 +- docs/pages/material-ui/api/tab-list.json | 2 +- docs/pages/material-ui/api/tab-panel.json | 9 +- .../material-ui/api/tab-scroll-button.json | 21 +- docs/pages/material-ui/api/tab.json | 34 +- docs/pages/material-ui/api/table-body.json | 9 +- docs/pages/material-ui/api/table-cell.json | 26 +- .../material-ui/api/table-container.json | 9 +- docs/pages/material-ui/api/table-footer.json | 9 +- docs/pages/material-ui/api/table-head.json | 9 +- .../material-ui/api/table-pagination.json | 80 ++- docs/pages/material-ui/api/table-row.json | 13 +- .../material-ui/api/table-sort-label.json | 20 +- docs/pages/material-ui/api/table.json | 17 +- docs/pages/material-ui/api/tabs.json | 81 ++- docs/pages/material-ui/api/text-field.json | 82 ++-- .../material-ui/api/timeline-connector.json | 7 +- .../material-ui/api/timeline-content.json | 7 +- docs/pages/material-ui/api/timeline-dot.json | 13 +- docs/pages/material-ui/api/timeline-item.json | 12 +- .../api/timeline-opposite-content.json | 7 +- .../material-ui/api/timeline-separator.json | 7 +- docs/pages/material-ui/api/timeline.json | 12 +- .../material-ui/api/toggle-button-group.json | 33 +- docs/pages/material-ui/api/toggle-button.json | 47 +- docs/pages/material-ui/api/toolbar.json | 14 +- docs/pages/material-ui/api/tooltip.json | 116 +++-- docs/pages/material-ui/api/tree-item.json | 39 +- docs/pages/material-ui/api/tree-view.json | 74 ++- docs/pages/material-ui/api/typography.json | 24 +- docs/pages/material-ui/api/zoom.json | 18 +- docs/pages/system/api/box.json | 5 +- docs/pages/system/api/container.json | 14 +- docs/pages/system/api/grid.json | 79 ++- docs/pages/system/api/stack.json | 17 +- .../api-docs-base/badge/badge.json | 49 +- .../api-docs-base/button/button.json | 35 +- .../click-away-listener.json | 35 +- .../api-docs-base/focus-trap/focus-trap.json | 49 +- .../form-control/form-control.json | 56 ++- .../api-docs-base/input/input.json | 147 +++++- .../api-docs-base/menu-item/menu-item.json | 21 +- .../translations/api-docs-base/menu/menu.json | 42 +- .../api-docs-base/modal/modal.json | 115 ++++- .../api-docs-base/no-ssr/no-ssr.json | 21 +- .../option-group/option-group.json | 28 +- .../api-docs-base/option/option.json | 35 +- .../api-docs-base/popper/popper.json | 98 +++- .../api-docs-base/portal/portal.json | 21 +- .../api-docs-base/select/select.json | 112 ++++- .../api-docs-base/slider/slider.json | 178 ++++++- .../api-docs-base/snackbar/snackbar.json | 59 ++- .../api-docs-base/switch/switch.json | 58 ++- .../api-docs-base/tab-panel/tab-panel.json | 28 +- docs/translations/api-docs-base/tab/tab.json | 42 +- .../table-pagination/table-pagination.json | 96 +++- .../api-docs-base/tabs-list/tabs-list.json | 21 +- .../translations/api-docs-base/tabs/tabs.json | 63 ++- .../textarea-autosize/textarea-autosize.json | 14 +- .../api-docs-joy/alert/alert.json | 77 ++- .../aspect-ratio/aspect-ratio.json | 77 ++- .../autocomplete-listbox.json | 49 +- .../autocomplete-option.json | 42 +- .../autocomplete/autocomplete.json | 390 +++++++++++++-- .../avatar-group/avatar-group.json | 56 ++- .../api-docs-joy/avatar/avatar.json | 77 ++- .../api-docs-joy/badge/badge.json | 98 +++- .../api-docs-joy/breadcrumbs/breadcrumbs.json | 49 +- .../api-docs-joy/button/button.json | 105 +++- .../card-content/card-content.json | 35 +- .../api-docs-joy/card-cover/card-cover.json | 35 +- .../card-overflow/card-overflow.json | 49 +- docs/translations/api-docs-joy/card/card.json | 70 ++- .../api-docs-joy/checkbox/checkbox.json | 163 ++++++- .../api-docs-joy/chip-delete/chip-delete.json | 63 ++- docs/translations/api-docs-joy/chip/chip.json | 84 +++- .../circular-progress/circular-progress.json | 70 ++- .../css-baseline/css-baseline.json | 14 +- .../api-docs-joy/divider/divider.json | 49 +- .../form-control/form-control.json | 77 ++- .../form-helper-text/form-helper-text.json | 35 +- .../api-docs-joy/form-label/form-label.json | 42 +- .../api-docs-joy/icon-button/icon-button.json | 70 ++- .../api-docs-joy/input/input.json | 63 ++- .../linear-progress/linear-progress.json | 70 ++- docs/translations/api-docs-joy/link/link.json | 98 +++- .../list-divider/list-divider.json | 49 +- .../list-item-button/list-item-button.json | 91 +++- .../list-item-content/list-item-content.json | 35 +- .../list-item-decorator.json | 35 +- .../api-docs-joy/list-item/list-item.json | 77 ++- .../list-subheader/list-subheader.json | 56 ++- docs/translations/api-docs-joy/list/list.json | 70 ++- .../api-docs-joy/menu-item/menu-item.json | 49 +- .../api-docs-joy/menu-list/menu-list.json | 56 ++- docs/translations/api-docs-joy/menu/menu.json | 105 +++- .../api-docs-joy/modal-close/modal-close.json | 49 +- .../modal-dialog/modal-dialog.json | 63 ++- .../modal-overflow/modal-overflow.json | 7 +- .../api-docs-joy/modal/modal.json | 115 ++++- .../api-docs-joy/option/option.json | 70 ++- .../api-docs-joy/radio-group/radio-group.json | 107 +++- .../api-docs-joy/radio/radio.json | 149 +++++- .../scoped-css-baseline.json | 42 +- .../api-docs-joy/select/select.json | 168 ++++++- .../api-docs-joy/sheet/sheet.json | 56 ++- .../api-docs-joy/slider/slider.json | 220 +++++++-- .../api-docs-joy/stack/stack.json | 49 +- .../api-docs-joy/svg-icon/svg-icon.json | 84 +++- .../api-docs-joy/switch/switch.json | 107 +++- .../api-docs-joy/tab-list/tab-list.json | 56 ++- .../api-docs-joy/tab-panel/tab-panel.json | 49 +- docs/translations/api-docs-joy/tab/tab.json | 77 ++- .../api-docs-joy/table/table.json | 98 +++- docs/translations/api-docs-joy/tabs/tabs.json | 98 +++- .../api-docs-joy/textarea/textarea.json | 63 ++- .../api-docs-joy/tooltip/tooltip.json | 210 ++++++-- .../api-docs-joy/typography/typography.json | 98 +++- .../accordion-actions/accordion-actions.json | 28 +- .../accordion-details/accordion-details.json | 21 +- .../accordion-summary/accordion-summary.json | 35 +- .../api-docs/accordion/accordion.json | 80 ++- .../api-docs/alert-title/alert-title.json | 21 +- docs/translations/api-docs/alert/alert.json | 112 ++++- .../api-docs/app-bar/app-bar.json | 42 +- .../api-docs/autocomplete/autocomplete.json | 460 +++++++++++++++--- .../api-docs/avatar-group/avatar-group.json | 70 ++- docs/translations/api-docs/avatar/avatar.json | 70 ++- .../api-docs/backdrop/backdrop.json | 84 +++- docs/translations/api-docs/badge/badge.json | 112 ++++- .../bottom-navigation-action.json | 49 +- .../bottom-navigation/bottom-navigation.json | 52 +- docs/translations/api-docs/box/box.json | 14 +- .../api-docs/breadcrumbs/breadcrumbs.json | 77 ++- .../api-docs/button-base/button-base.json | 105 +++- .../api-docs/button-group/button-group.json | 91 +++- docs/translations/api-docs/button/button.json | 105 +++- .../card-action-area/card-action-area.json | 21 +- .../api-docs/card-actions/card-actions.json | 28 +- .../api-docs/card-content/card-content.json | 28 +- .../api-docs/card-header/card-header.json | 70 ++- .../api-docs/card-media/card-media.json | 42 +- docs/translations/api-docs/card/card.json | 28 +- .../api-docs/checkbox/checkbox.json | 128 ++++- docs/translations/api-docs/chip/chip.json | 105 +++- .../circular-progress/circular-progress.json | 56 ++- .../api-docs/collapse/collapse.json | 70 ++- .../api-docs/container/container.json | 42 +- .../api-docs/css-baseline/css-baseline.json | 14 +- .../dialog-actions/dialog-actions.json | 28 +- .../dialog-content-text.json | 21 +- .../dialog-content/dialog-content.json | 28 +- .../api-docs/dialog-title/dialog-title.json | 21 +- docs/translations/api-docs/dialog/dialog.json | 136 +++++- .../api-docs/divider/divider.json | 70 ++- docs/translations/api-docs/drawer/drawer.json | 91 +++- docs/translations/api-docs/fab/fab.json | 77 ++- docs/translations/api-docs/fade/fade.json | 42 +- .../api-docs/filled-input/filled-input.json | 233 +++++++-- .../form-control-label.json | 100 +++- .../api-docs/form-control/form-control.json | 98 +++- .../api-docs/form-group/form-group.json | 28 +- .../form-helper-text/form-helper-text.json | 77 ++- .../api-docs/form-label/form-label.json | 70 ++- .../api-docs/global-styles/global-styles.json | 9 +- docs/translations/api-docs/grid/grid.json | 133 ++++- docs/translations/api-docs/grow/grow.json | 42 +- docs/translations/api-docs/hidden/hidden.json | 98 +++- .../api-docs/icon-button/icon-button.json | 63 ++- docs/translations/api-docs/icon/icon.json | 49 +- .../image-list-item-bar.json | 49 +- .../image-list-item/image-list-item.json | 42 +- .../api-docs/image-list/image-list.json | 56 ++- .../input-adornment/input-adornment.json | 56 ++- .../api-docs/input-base/input-base.json | 247 ++++++++-- .../api-docs/input-label/input-label.json | 91 +++- docs/translations/api-docs/input/input.json | 226 +++++++-- .../linear-progress/linear-progress.json | 42 +- docs/translations/api-docs/link/link.json | 56 ++- .../list-item-avatar/list-item-avatar.json | 21 +- .../list-item-button/list-item-button.json | 84 +++- .../list-item-icon/list-item-icon.json | 21 +- .../list-item-secondary-action.json | 21 +- .../list-item-text/list-item-text.json | 63 ++- .../api-docs/list-item/list-item.json | 140 +++++- .../list-subheader/list-subheader.json | 56 ++- docs/translations/api-docs/list/list.json | 49 +- .../loading-button/loading-button.json | 56 ++- .../api-docs/masonry/masonry.json | 63 ++- .../api-docs/menu-item/menu-item.json | 70 ++- .../api-docs/menu-list/menu-list.json | 42 +- docs/translations/api-docs/menu/menu.json | 94 +++- .../mobile-stepper/mobile-stepper.json | 63 ++- docs/translations/api-docs/modal/modal.json | 164 ++++++- .../api-docs/native-select/native-select.json | 65 ++- .../outlined-input/outlined-input.json | 219 +++++++-- .../pagination-item/pagination-item.json | 91 +++- .../api-docs/pagination/pagination.json | 140 +++++- docs/translations/api-docs/paper/paper.json | 49 +- .../api-docs/popover/popover.json | 126 ++++- docs/translations/api-docs/popper/popper.json | 119 ++++- .../api-docs/radio-group/radio-group.json | 38 +- docs/translations/api-docs/radio/radio.json | 114 ++++- docs/translations/api-docs/rating/rating.json | 132 ++++- .../scoped-css-baseline.json | 35 +- docs/translations/api-docs/select/select.json | 171 ++++++- .../api-docs/skeleton/skeleton.json | 56 ++- docs/translations/api-docs/slide/slide.json | 56 ++- docs/translations/api-docs/slider/slider.json | 220 +++++++-- .../snackbar-content/snackbar-content.json | 35 +- .../api-docs/snackbar/snackbar.json | 122 ++++- .../speed-dial-action/speed-dial-action.json | 77 ++- .../speed-dial-icon/speed-dial-icon.json | 28 +- .../api-docs/speed-dial/speed-dial.json | 111 ++++- docs/translations/api-docs/stack/stack.json | 49 +- .../api-docs/step-button/step-button.json | 35 +- .../step-connector/step-connector.json | 14 +- .../api-docs/step-content/step-content.json | 42 +- .../api-docs/step-icon/step-icon.json | 42 +- .../api-docs/step-label/step-label.json | 70 ++- docs/translations/api-docs/step/step.json | 70 ++- .../api-docs/stepper/stepper.json | 63 ++- .../api-docs/svg-icon/svg-icon.json | 77 ++- .../swipeable-drawer/swipeable-drawer.json | 91 +++- docs/translations/api-docs/switch/switch.json | 121 ++++- .../api-docs/tab-context/tab-context.json | 14 +- .../api-docs/tab-list/tab-list.json | 9 +- .../api-docs/tab-panel/tab-panel.json | 28 +- .../tab-scroll-button/tab-scroll-button.json | 56 ++- docs/translations/api-docs/tab/tab.json | 77 ++- .../api-docs/table-body/table-body.json | 28 +- .../api-docs/table-cell/table-cell.json | 70 ++- .../table-container/table-container.json | 28 +- .../api-docs/table-footer/table-footer.json | 28 +- .../api-docs/table-head/table-head.json | 28 +- .../table-pagination/table-pagination.json | 131 ++++- .../api-docs/table-row/table-row.json | 42 +- .../table-sort-label/table-sort-label.json | 49 +- docs/translations/api-docs/table/table.json | 49 +- docs/translations/api-docs/tabs/tabs.json | 164 ++++++- .../api-docs/text-field/text-field.json | 226 +++++++-- .../timeline-connector.json | 21 +- .../timeline-content/timeline-content.json | 21 +- .../api-docs/timeline-dot/timeline-dot.json | 35 +- .../api-docs/timeline-item/timeline-item.json | 28 +- .../timeline-opposite-content.json | 21 +- .../timeline-separator.json | 21 +- .../api-docs/timeline/timeline.json | 35 +- .../toggle-button-group.json | 80 ++- .../api-docs/toggle-button/toggle-button.json | 97 +++- .../api-docs/toolbar/toolbar.json | 42 +- .../api-docs/tooltip/tooltip.json | 203 ++++++-- .../api-docs/tree-item/tree-item.json | 105 +++- .../api-docs/tree-view/tree-view.json | 135 ++++- .../api-docs/typography/typography.json | 70 ++- docs/translations/api-docs/zoom/zoom.json | 42 +- 446 files changed, 18936 insertions(+), 4697 deletions(-) diff --git a/docs/pages/base/api/badge.json b/docs/pages/base/api/badge.json index 92b68784d9ec9a..550ce024d7b4b2 100644 --- a/docs/pages/base/api/badge.json +++ b/docs/pages/base/api/badge.json @@ -1,20 +1,22 @@ { "props": { - "badgeContent": { "type": { "name": "node" } }, - "children": { "type": { "name": "node" } }, - "invisible": { "type": { "name": "bool" }, "default": "false" }, - "max": { "type": { "name": "number" }, "default": "99" }, - "showZero": { "type": { "name": "bool" }, "default": "false" }, + "badgeContent": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "invisible": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "max": { "type": { "name": "number" }, "default": "99", "additionalPropsInfo": {} }, + "showZero": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ badge?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ badge?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Badge", diff --git a/docs/pages/base/api/button.json b/docs/pages/base/api/button.json index 767f019b519b52..cb93782b1c1cbc 100644 --- a/docs/pages/base/api/button.json +++ b/docs/pages/base/api/button.json @@ -4,17 +4,24 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusableWhenDisabled": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "focusableWhenDisabled": { "type": { "name": "bool" }, "default": "false" }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Button", diff --git a/docs/pages/base/api/click-away-listener.json b/docs/pages/base/api/click-away-listener.json index b0ee82dd927c87..8b0b56cf996032 100644 --- a/docs/pages/base/api/click-away-listener.json +++ b/docs/pages/base/api/click-away-listener.json @@ -1,21 +1,31 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "onClickAway": { "type": { "name": "func" }, "required": true }, - "disableReactTree": { "type": { "name": "bool" }, "default": "false" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "onClickAway": { "type": { "name": "func" }, "required": true, "additionalPropsInfo": {} }, + "disableReactTree": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, "mouseEvent": { "type": { "name": "enum", "description": "'onClick'
    | 'onMouseDown'
    | 'onMouseUp'
    | 'onPointerDown'
    | 'onPointerUp'
    | false" }, - "default": "'onClick'" + "default": "'onClick'", + "additionalPropsInfo": {} }, "touchEvent": { "type": { "name": "enum", "description": "'onTouchEnd'
    | 'onTouchStart'
    | false" }, - "default": "'onTouchEnd'" + "default": "'onTouchEnd'", + "additionalPropsInfo": {} } }, "name": "ClickAwayListener", diff --git a/docs/pages/base/api/focus-trap.json b/docs/pages/base/api/focus-trap.json index 054d8b7f1da870..65b4488afa89f6 100644 --- a/docs/pages/base/api/focus-trap.json +++ b/docs/pages/base/api/focus-trap.json @@ -1,14 +1,34 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, - "children": { "type": { "name": "custom", "description": "element" } }, - "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" }, - "getTabbable": { "type": { "name": "func" } }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "children": { + "type": { "name": "custom", "description": "element" }, + "additionalPropsInfo": {} + }, + "disableAutoFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEnforceFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRestoreFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "getTabbable": { + "type": { "name": "func" }, + "signature": { "type": "function(root: HTMLElement) => void", "describedArgs": [] }, + "additionalPropsInfo": {} + }, "isEnabled": { "type": { "name": "func" }, - "default": "function defaultIsEnabled(): boolean {\n return true;\n}" + "default": "function defaultIsEnabled(): boolean {\n return true;\n}", + "additionalPropsInfo": {} } }, "name": "FocusTrap", diff --git a/docs/pages/base/api/form-control.json b/docs/pages/base/api/form-control.json index 2e4d3df59273b4..cef7220dc1f4e7 100644 --- a/docs/pages/base/api/form-control.json +++ b/docs/pages/base/api/form-control.json @@ -1,19 +1,24 @@ { "props": { - "children": { "type": { "name": "union", "description": "node
    | func" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "children": { + "type": { "name": "union", "description": "node
    | func" }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "FormControl", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/input.json b/docs/pages/base/api/input.json index 980af136f07548..ab0c478ae0d6a7 100644 --- a/docs/pages/base/api/input.json +++ b/docs/pages/base/api/input.json @@ -1,44 +1,47 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "endAdornment": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "id": { "type": { "name": "string" } }, - "maxRows": { "type": { "name": "number" } }, - "minRows": { "type": { "name": "number" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "placeholder": { "type": { "name": "string" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, - "rows": { "type": { "name": "number" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "maxRows": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "minRows": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "rows": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType, textarea?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startAdornment": { "type": { "name": "node" } }, + "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "type": { "type": { "name": "enum", "description": "'button'
    | 'checkbox'
    | 'color'
    | 'date'
    | 'datetime-local'
    | 'email'
    | 'file'
    | 'hidden'
    | 'image'
    | 'month'
    | 'number'
    | 'password'
    | 'radio'
    | 'range'
    | 'reset'
    | 'search'
    | 'submit'
    | 'tel'
    | 'text'
    | 'time'
    | 'url'
    | 'week'" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Input", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/menu-item.json b/docs/pages/base/api/menu-item.json index 7a56472ba90e64..816a27303a99d0 100644 --- a/docs/pages/base/api/menu-item.json +++ b/docs/pages/base/api/menu-item.json @@ -1,13 +1,15 @@ { "props": { - "label": { "type": { "name": "string" } }, + "label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "MenuItem", diff --git a/docs/pages/base/api/menu.json b/docs/pages/base/api/menu.json index ce527b89a2f5a8..dd3350275142af 100644 --- a/docs/pages/base/api/menu.json +++ b/docs/pages/base/api/menu.json @@ -1,24 +1,27 @@ { "props": { - "actions": { "type": { "name": "custom", "description": "ref" } }, + "actions": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, "anchorEl": { "type": { "name": "union", "description": "HTML element
    | object
    | func" - } + }, + "additionalPropsInfo": {} }, - "onOpenChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" }, "default": "false" }, + "onOpenChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ listbox?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ listbox?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Menu", diff --git a/docs/pages/base/api/modal.json b/docs/pages/base/api/modal.json index 2993d0ee3210bf..7d17a6d9754557 100644 --- a/docs/pages/base/api/modal.json +++ b/docs/pages/base/api/modal.json @@ -1,33 +1,74 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "open": { "type": { "name": "bool" }, "required": true }, - "closeAfterTransition": { "type": { "name": "bool" }, "default": "false" }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableScrollLock": { "type": { "name": "bool" }, "default": "false" }, - "hideBackdrop": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "closeAfterTransition": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "disableAutoFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEnforceFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEscapeKeyDown": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableRestoreFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableScrollLock": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "hideBackdrop": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "onBackdropClick": { "type": { "name": "func" }, "deprecated": true, - "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events." + "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events.", + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, "slotProps": { "type": { "name": "shape", "description": "{ backdrop?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Modal", diff --git a/docs/pages/base/api/no-ssr.json b/docs/pages/base/api/no-ssr.json index 562916091866d0..79df4556d531d3 100644 --- a/docs/pages/base/api/no-ssr.json +++ b/docs/pages/base/api/no-ssr.json @@ -1,8 +1,8 @@ { "props": { - "children": { "type": { "name": "node" } }, - "defer": { "type": { "name": "bool" }, "default": "false" }, - "fallback": { "type": { "name": "node" }, "default": "null" } + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defer": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fallback": { "type": { "name": "node" }, "default": "null", "additionalPropsInfo": {} } }, "name": "NoSsr", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/option-group.json b/docs/pages/base/api/option-group.json index f3d65de7f53eb5..89762f15fd0136 100644 --- a/docs/pages/base/api/option-group.json +++ b/docs/pages/base/api/option-group.json @@ -1,20 +1,22 @@ { "props": { - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "label": { "type": { "name": "node" } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ label?: func
    | object, list?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ label?: elementType, list?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "OptionGroup", diff --git a/docs/pages/base/api/option.json b/docs/pages/base/api/option.json index 3c5bfc442c44e2..30dbec92185479 100644 --- a/docs/pages/base/api/option.json +++ b/docs/pages/base/api/option.json @@ -1,15 +1,17 @@ { "props": { - "value": { "type": { "name": "any" }, "required": true }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "label": { "type": { "name": "string" } }, + "value": { "type": { "name": "any" }, "required": true, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Option", diff --git a/docs/pages/base/api/popper.json b/docs/pages/base/api/popper.json index d4d16e695b21fd..72371918fd326c 100644 --- a/docs/pages/base/api/popper.json +++ b/docs/pages/base/api/popper.json @@ -1,50 +1,63 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, "anchorEl": { "type": { "name": "custom", "description": "HTML element
    | object
    | func" - } + }, + "additionalPropsInfo": {} + }, + "children": { + "type": { "name": "union", "description": "node
    | func" }, + "additionalPropsInfo": {} + }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} }, - "children": { "type": { "name": "union", "description": "node
    | func" } }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, "direction": { "type": { "name": "enum", "description": "'ltr'
    | 'rtl'" }, - "default": "'ltr'" + "default": "'ltr'", + "additionalPropsInfo": {} }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "modifiers": { "type": { "name": "arrayOf", "description": "Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
    | 'afterRead'
    | 'afterWrite'
    | 'beforeMain'
    | 'beforeRead'
    | 'beforeWrite'
    | 'main'
    | 'read'
    | 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>" - } + }, + "additionalPropsInfo": {} }, "placement": { "type": { "name": "enum", "description": "'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, "popperOptions": { "type": { "name": "shape", "description": "{ modifiers?: array, onFirstUpdate?: func, placement?: 'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top', strategy?: 'absolute'
    | 'fixed' }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "popperRef": { "type": { "name": "custom", "description": "ref" } }, + "popperRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "transition": { "type": { "name": "bool" }, "default": "false" } + "transition": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Popper", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/portal.json b/docs/pages/base/api/portal.json index c6919b9c5059c2..7418c88869622f 100644 --- a/docs/pages/base/api/portal.json +++ b/docs/pages/base/api/portal.json @@ -1,8 +1,11 @@ { "props": { - "children": { "type": { "name": "node" } }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" } + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Portal", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/select.json b/docs/pages/base/api/select.json index 93ce757158b52b..7be741fc68e42e 100644 --- a/docs/pages/base/api/select.json +++ b/docs/pages/base/api/select.json @@ -1,33 +1,47 @@ { "props": { - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "defaultListboxOpen": { "type": { "name": "bool" }, "default": "false" }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "getOptionAsString": { "type": { "name": "func" }, "default": "defaultOptionStringifier" }, - "getSerializedValue": { "type": { "name": "func" } }, - "listboxId": { "type": { "name": "string" } }, - "listboxOpen": { "type": { "name": "bool" }, "default": "undefined" }, - "multiple": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onListboxOpenChange": { "type": { "name": "func" } }, - "renderValue": { "type": { "name": "func" } }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "defaultListboxOpen": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getOptionAsString": { + "type": { "name": "func" }, + "default": "defaultOptionStringifier", + "additionalPropsInfo": {} + }, + "getSerializedValue": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "listboxId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "listboxOpen": { + "type": { "name": "bool" }, + "default": "undefined", + "additionalPropsInfo": {} + }, + "multiple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "onListboxOpenChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "renderValue": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ listbox?: func
    | object, popper?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ listbox?: elementType, popper?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Select", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/slider.json b/docs/pages/base/api/slider.json index 780c2b61cbeac1..6a9ba8ffcbc048 100644 --- a/docs/pages/base/api/slider.json +++ b/docs/pages/base/api/slider.json @@ -1,62 +1,106 @@ { "props": { - "aria-label": { "type": { "name": "custom", "description": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "aria-valuetext": { "type": { "name": "custom", "description": "string" } }, + "aria-label": { + "type": { "name": "custom", "description": "string" }, + "additionalPropsInfo": {} + }, + "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-valuetext": { + "type": { "name": "custom", "description": "string" }, + "additionalPropsInfo": {} + }, "defaultValue": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableSwap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getAriaLabel": { + "type": { "name": "func" }, + "signature": { "type": "function(index: number) => string", "describedArgs": ["index"] }, + "additionalPropsInfo": {} + }, + "getAriaValueText": { + "type": { "name": "func" }, + "signature": { + "type": "function(value: number, index: number) => string", + "describedArgs": ["value", "index"] + }, + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableSwap": { "type": { "name": "bool" }, "default": "false" }, - "getAriaLabel": { "type": { "name": "func" } }, - "getAriaValueText": { "type": { "name": "func" } }, - "isRtl": { "type": { "name": "bool" }, "default": "false" }, + "isRtl": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "marks": { "type": { "name": "union", "description": "Array<{ label?: node, value: number }>
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} + }, + "max": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, + "min": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: Event, value: number | Array, activeThumb: number) => void", + "describedArgs": ["event", "value", "activeThumb"] + }, + "additionalPropsInfo": {} + }, + "onChangeCommitted": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent | Event, value: number | Array) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} }, - "max": { "type": { "name": "number" }, "default": "100" }, - "min": { "type": { "name": "number" }, "default": "0" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onChangeCommitted": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} + }, + "scale": { + "type": { "name": "func" }, + "default": "function Identity(x) {\n return x;\n}", + "signature": { "type": "function(x: any) => any", "describedArgs": [] }, + "additionalPropsInfo": {} }, - "scale": { "type": { "name": "func" }, "default": "function Identity(x) {\n return x;\n}" }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: any
    | func }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "step": { "type": { "name": "number" }, "default": "1" }, - "tabIndex": { "type": { "name": "number" } }, + "step": { "type": { "name": "number" }, "default": "1", "additionalPropsInfo": {} }, + "tabIndex": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "track": { "type": { "name": "enum", "description": "'inverted'
    | 'normal'
    | false" }, - "default": "'normal'" + "default": "'normal'", + "additionalPropsInfo": {} }, "value": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} }, "valueLabelFormat": { "type": { "name": "union", "description": "func
    | string" }, - "default": "function Identity(x) {\n return x;\n}" + "default": "function Identity(x) {\n return x;\n}", + "additionalPropsInfo": {} } }, "name": "Slider", diff --git a/docs/pages/base/api/snackbar.json b/docs/pages/base/api/snackbar.json index a0b22480955a9c..720630d7de6ee3 100644 --- a/docs/pages/base/api/snackbar.json +++ b/docs/pages/base/api/snackbar.json @@ -1,21 +1,38 @@ { "props": { - "autoHideDuration": { "type": { "name": "number" }, "default": "null" }, - "disableWindowBlurListener": { "type": { "name": "bool" }, "default": "false" }, - "exited": { "type": { "name": "bool" }, "default": "true" }, - "onClose": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "resumeHideDuration": { "type": { "name": "number" } }, + "autoHideDuration": { + "type": { "name": "number" }, + "default": "null", + "additionalPropsInfo": {} + }, + "disableWindowBlurListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "exited": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent | Event, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "resumeHideDuration": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ clickAwayListener?: func
    | { children: element, disableReactTree?: bool, mouseEvent?: 'onClick'
    | 'onMouseDown'
    | 'onMouseUp'
    | 'onPointerDown'
    | 'onPointerUp'
    | false, onClickAway?: func, touchEvent?: 'onTouchEnd'
    | 'onTouchStart'
    | false }, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Snackbar", diff --git a/docs/pages/base/api/switch.json b/docs/pages/base/api/switch.json index 8c47ea4c85e2a2..6ade77bcbfe689 100644 --- a/docs/pages/base/api/switch.json +++ b/docs/pages/base/api/switch.json @@ -1,24 +1,33 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" } }, - "onChange": { "type": { "name": "func" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType, thumb?: elementType, track?: elementType
    | null }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "Switch", diff --git a/docs/pages/base/api/tab-panel.json b/docs/pages/base/api/tab-panel.json index 004d16c071c94d..b9d60be2713738 100644 --- a/docs/pages/base/api/tab-panel.json +++ b/docs/pages/base/api/tab-panel.json @@ -1,15 +1,20 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "value": { "type": { "name": "union", "description": "number
    | string" } } + "value": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + } }, "name": "TabPanel", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/tab.json b/docs/pages/base/api/tab.json index 8bff7bbd848cc0..e9c784ecf2f765 100644 --- a/docs/pages/base/api/tab.json +++ b/docs/pages/base/api/tab.json @@ -4,19 +4,25 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "value": { "type": { "name": "union", "description": "number
    | string" } } + "value": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + } }, "name": "Tab", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/table-pagination.json b/docs/pages/base/api/table-pagination.json index 1ef6b789fb9033..f25e449c5fb8d0 100644 --- a/docs/pages/base/api/table-pagination.json +++ b/docs/pages/base/api/table-pagination.json @@ -1,41 +1,74 @@ { "props": { - "count": { "type": { "name": "number" }, "required": true }, - "onPageChange": { "type": { "name": "func" }, "required": true }, - "page": { "type": { "name": "custom", "description": "integer" }, "required": true }, - "rowsPerPage": { "type": { "name": "custom", "description": "integer" }, "required": true }, + "count": { "type": { "name": "number" }, "required": true, "additionalPropsInfo": {} }, + "onPageChange": { + "type": { "name": "func" }, + "required": true, + "signature": { + "type": "function(event: React.MouseEvent | null, page: number) => void", + "describedArgs": ["event", "page"] + }, + "additionalPropsInfo": {} + }, + "page": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, + "rowsPerPage": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, "getItemAriaLabel": { "type": { "name": "func" }, - "default": "function defaultGetAriaLabel(type: ItemAriaLabelType) {\n return `Go to ${type} page`;\n}" + "default": "function defaultGetAriaLabel(type: ItemAriaLabelType) {\n return `Go to ${type} page`;\n}", + "signature": { "type": "function(type: string) => string", "describedArgs": ["type"] }, + "additionalPropsInfo": {} }, "labelDisplayedRows": { "type": { "name": "func" }, - "default": "function defaultLabelDisplayedRows({ from, to, count }: LabelDisplayedRowsArgs) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}" + "default": "function defaultLabelDisplayedRows({ from, to, count }: LabelDisplayedRowsArgs) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}", + "additionalPropsInfo": {} + }, + "labelId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "labelRowsPerPage": { + "type": { "name": "node" }, + "default": "'Rows per page:'", + "additionalPropsInfo": {} + }, + "onRowsPerPageChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "labelId": { "type": { "name": "string" } }, - "labelRowsPerPage": { "type": { "name": "node" }, "default": "'Rows per page:'" }, - "onRowsPerPageChange": { "type": { "name": "func" } }, "rowsPerPageOptions": { "type": { "name": "arrayOf", "description": "Array<number
    | { label: string, value: number }>" }, - "default": "[10, 25, 50, 100]" + "default": "[10, 25, 50, 100]", + "additionalPropsInfo": {} }, - "selectId": { "type": { "name": "string" } }, + "selectId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ actions?: func
    | object, displayedRows?: func
    | object, menuItem?: func
    | object, root?: func
    | object, select?: func
    | object, selectLabel?: func
    | object, spacer?: func
    | object, toolbar?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ actions?: elementType, displayedRows?: elementType, menuItem?: elementType, root?: elementType, select?: elementType, selectLabel?: elementType, spacer?: elementType, toolbar?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "TablePagination", diff --git a/docs/pages/base/api/tabs-list.json b/docs/pages/base/api/tabs-list.json index 44664ef547e1de..d758a488bd8eb5 100644 --- a/docs/pages/base/api/tabs-list.json +++ b/docs/pages/base/api/tabs-list.json @@ -1,13 +1,15 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } } }, "name": "TabsList", diff --git a/docs/pages/base/api/tabs.json b/docs/pages/base/api/tabs.json index d615a62fc12d7a..f69fc728fc41cc 100644 --- a/docs/pages/base/api/tabs.json +++ b/docs/pages/base/api/tabs.json @@ -1,26 +1,36 @@ { "props": { - "children": { "type": { "name": "node" } }, - "defaultValue": { "type": { "name": "union", "description": "number
    | string" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultValue": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, "direction": { "type": { "name": "enum", "description": "'ltr'
    | 'rtl'" }, - "default": "'ltr'" + "default": "'ltr'", + "additionalPropsInfo": {} }, - "onChange": { "type": { "name": "func" } }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, - "selectionFollowsFocus": { "type": { "name": "bool" } }, + "selectionFollowsFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "value": { "type": { "name": "union", "description": "number
    | string" } } + "value": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + } }, "name": "Tabs", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/base/api/textarea-autosize.json b/docs/pages/base/api/textarea-autosize.json index b248a0e1d4d473..3d999a8139b1d6 100644 --- a/docs/pages/base/api/textarea-autosize.json +++ b/docs/pages/base/api/textarea-autosize.json @@ -1,9 +1,13 @@ { "props": { - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, "minRows": { "type": { "name": "union", "description": "number
    | string" }, - "default": "1" + "default": "1", + "additionalPropsInfo": {} } }, "name": "TextareaAutosize", diff --git a/docs/pages/joy-ui/api/alert.json b/docs/pages/joy-ui/api/alert.json index 29fc4a44a9f77b..495f815f4dff2e 100644 --- a/docs/pages/joy-ui/api/alert.json +++ b/docs/pages/joy-ui/api/alert.json @@ -5,46 +5,52 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "endDecorator": { "type": { "name": "node" } }, - "invertedColors": { "type": { "name": "bool" }, "default": "false" }, - "role": { "type": { "name": "string" }, "default": "'alert'" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "invertedColors": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "role": { "type": { "name": "string" }, "default": "'alert'", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ endDecorator?: func
    | object, root?: func
    | object, startDecorator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Alert", diff --git a/docs/pages/joy-ui/api/aspect-ratio.json b/docs/pages/joy-ui/api/aspect-ratio.json index 7e093334eaeb4e..fb0daf1e52044e 100644 --- a/docs/pages/joy-ui/api/aspect-ratio.json +++ b/docs/pages/joy-ui/api/aspect-ratio.json @@ -1,50 +1,63 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "enum", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "maxHeight": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minHeight": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "maxHeight": { "type": { "name": "union", "description": "number
    | string" } }, - "minHeight": { "type": { "name": "union", "description": "number
    | string" } }, "objectFit": { "type": { "name": "enum", "description": "'-moz-initial'
    | 'contain'
    | 'cover'
    | 'fill'
    | 'inherit'
    | 'initial'
    | 'none'
    | 'revert-layer'
    | 'revert'
    | 'scale-down'
    | 'unset'" }, - "default": "'cover'" + "default": "'cover'", + "additionalPropsInfo": {} }, "ratio": { "type": { "name": "union", "description": "number
    | string" }, - "default": "'16 / 9'" + "default": "'16 / 9'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ content?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ content?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "AspectRatio", diff --git a/docs/pages/joy-ui/api/autocomplete-listbox.json b/docs/pages/joy-ui/api/autocomplete-listbox.json index 2bf3dcfb4a3ad8..9780c3922b2409 100644 --- a/docs/pages/joy-ui/api/autocomplete-listbox.json +++ b/docs/pages/joy-ui/api/autocomplete-listbox.json @@ -5,33 +5,39 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "enum", "description": "'sm'
    | 'md'
    | 'lg'" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'light'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "AutocompleteListbox", diff --git a/docs/pages/joy-ui/api/autocomplete-option.json b/docs/pages/joy-ui/api/autocomplete-option.json index 9bfe8af15f1cdc..e3683586340470 100644 --- a/docs/pages/joy-ui/api/autocomplete-option.json +++ b/docs/pages/joy-ui/api/autocomplete-option.json @@ -5,29 +5,34 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'light'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "AutocompleteOption", diff --git a/docs/pages/joy-ui/api/autocomplete.json b/docs/pages/joy-ui/api/autocomplete.json index 68d0bc295616a9..a8d0038b315d60 100644 --- a/docs/pages/joy-ui/api/autocomplete.json +++ b/docs/pages/joy-ui/api/autocomplete.json @@ -1,103 +1,221 @@ { "props": { - "options": { "type": { "name": "array" }, "required": true }, - "aria-describedby": { "type": { "name": "string" } }, - "aria-label": { "type": { "name": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "clearIcon": { "type": { "name": "node" }, "default": "" }, - "clearText": { "type": { "name": "string" }, "default": "'Clear'" }, - "closeText": { "type": { "name": "string" }, "default": "'Close'" }, + "options": { "type": { "name": "array" }, "required": true, "additionalPropsInfo": {} }, + "aria-describedby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "clearIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "clearText": { "type": { "name": "string" }, "default": "'Clear'", "additionalPropsInfo": {} }, + "closeText": { "type": { "name": "string" }, "default": "'Close'", "additionalPropsInfo": {} }, "color": { "type": { "name": "enum", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, "defaultValue": { "type": { "name": "custom", "description": "any" }, - "default": "props.multiple ? [] : null" + "default": "props.multiple ? [] : null", + "additionalPropsInfo": {} + }, + "disableClearable": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "filterOptions": { + "type": { "name": "func" }, + "default": "createFilterOptions()", + "signature": { + "type": "function(options: Array, state: object) => Array", + "describedArgs": ["options", "state"] + }, + "additionalPropsInfo": {} }, - "disableClearable": { "type": { "name": "bool" }, "default": "false" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "endDecorator": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "filterOptions": { "type": { "name": "func" }, "default": "createFilterOptions()" }, "forcePopupIcon": { "type": { "name": "union", "description": "'auto'
    | bool" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, - "freeSolo": { "type": { "name": "bool" }, "default": "false" }, + "freeSolo": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "getLimitTagsText": { "type": { "name": "func" }, - "default": "(more: string | number) => `+${more}`" + "default": "(more: string | number) => `+${more}`", + "signature": { + "type": "function(more: string | number) => ReactNode", + "describedArgs": ["more"] + }, + "additionalPropsInfo": {} + }, + "getOptionDisabled": { + "type": { "name": "func" }, + "signature": { "type": "function(option: T) => boolean", "describedArgs": ["option"] }, + "additionalPropsInfo": {} }, - "getOptionDisabled": { "type": { "name": "func" } }, "getOptionLabel": { "type": { "name": "func" }, - "default": "(option) => option.label ?? option" - }, - "groupBy": { "type": { "name": "func" } }, - "id": { "type": { "name": "string" } }, - "inputValue": { "type": { "name": "string" } }, - "isOptionEqualToValue": { "type": { "name": "func" } }, - "limitTags": { "type": { "name": "custom", "description": "integer" }, "default": "-1" }, - "loading": { "type": { "name": "bool" }, "default": "false" }, - "loadingText": { "type": { "name": "node" }, "default": "'Loading…'" }, - "multiple": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "noOptionsText": { "type": { "name": "node" }, "default": "'No options'" }, - "onChange": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onHighlightChange": { "type": { "name": "func" } }, - "onInputChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "openText": { "type": { "name": "string" }, "default": "'Open'" }, - "placeholder": { "type": { "name": "string" } }, - "popupIcon": { "type": { "name": "node" }, "default": "" }, - "readOnly": { "type": { "name": "bool" }, "default": "false" }, - "renderGroup": { "type": { "name": "func" } }, - "renderOption": { "type": { "name": "func" } }, - "renderTags": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" } }, + "default": "(option) => option.label ?? option", + "signature": { "type": "function(option: T) => string", "describedArgs": [] }, + "additionalPropsInfo": {} + }, + "groupBy": { + "type": { "name": "func" }, + "signature": { "type": "function(options: T) => string", "describedArgs": ["options"] }, + "additionalPropsInfo": {} + }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputValue": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "isOptionEqualToValue": { + "type": { "name": "func" }, + "signature": { + "type": "function(option: T, value: T) => boolean", + "describedArgs": ["option", "value"] + }, + "additionalPropsInfo": {} + }, + "limitTags": { + "type": { "name": "custom", "description": "integer" }, + "default": "-1", + "additionalPropsInfo": {} + }, + "loading": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "loadingText": { + "type": { "name": "node" }, + "default": "'Loading…'", + "additionalPropsInfo": {} + }, + "multiple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "noOptionsText": { + "type": { "name": "node" }, + "default": "'No options'", + "additionalPropsInfo": {} + }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: T | Array, reason: string, details?: string) => void", + "describedArgs": ["event", "value", "reason"] + }, + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "onHighlightChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, option: T, reason: string) => void", + "describedArgs": ["event", "option", "reason"] + }, + "additionalPropsInfo": {} + }, + "onInputChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: string, reason: string) => void", + "describedArgs": ["event", "value", "reason"] + }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "openText": { "type": { "name": "string" }, "default": "'Open'", "additionalPropsInfo": {} }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "popupIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "readOnly": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "renderGroup": { + "type": { "name": "func" }, + "signature": { + "type": "function(params: AutocompleteRenderGroupParams) => ReactNode", + "describedArgs": ["params"] + }, + "additionalPropsInfo": {} + }, + "renderOption": { + "type": { "name": "func" }, + "signature": { + "type": "function(props: object, option: T, state: object) => ReactNode", + "describedArgs": ["props", "option", "state"] + }, + "additionalPropsInfo": {} + }, + "renderTags": { + "type": { "name": "func" }, + "signature": { + "type": "function(value: Array, getTagProps: function, ownerState: object) => ReactNode", + "describedArgs": ["value", "getTagProps", "ownerState"] + }, + "additionalPropsInfo": {} + }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ clearIndicator?: func
    | object, endDecorator?: func
    | object, input?: func
    | object, limitTag?: func
    | object, listbox?: func
    | object, loading?: func
    | object, noOptions?: func
    | object, option?: func
    | object, popupIndicator?: func
    | object, root?: func
    | object, startDecorator?: func
    | object, wrapper?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ clearIndicator?: elementType, endDecorator?: elementType, input?: elementType, limitTag?: elementType, listbox?: elementType, loading?: elementType, noOptions?: elementType, option?: elementType, popupIndicator?: elementType, root?: elementType, startDecorator?: elementType, wrapper?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" } }, - "value": { "type": { "name": "custom", "description": "any" } }, + "type": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "custom", "description": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Autocomplete", diff --git a/docs/pages/joy-ui/api/avatar-group.json b/docs/pages/joy-ui/api/avatar-group.json index a8f7a547ffcd6d..a3471934bdb07a 100644 --- a/docs/pages/joy-ui/api/avatar-group.json +++ b/docs/pages/joy-ui/api/avatar-group.json @@ -1,41 +1,47 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'lg'
    | 'md'
    | 'sm'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "AvatarGroup", diff --git a/docs/pages/joy-ui/api/avatar.json b/docs/pages/joy-ui/api/avatar.json index 97c9962b20f494..cce9f10c1fe717 100644 --- a/docs/pages/joy-ui/api/avatar.json +++ b/docs/pages/joy-ui/api/avatar.json @@ -1,50 +1,56 @@ { "props": { - "alt": { "type": { "name": "string" } }, - "children": { "type": { "name": "node" } }, + "alt": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'lg'
    | 'md'
    | 'sm'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ fallback?: func
    | object, img?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ fallback?: elementType, img?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "src": { "type": { "name": "string" } }, - "srcSet": { "type": { "name": "string" } }, + "src": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "srcSet": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Avatar", diff --git a/docs/pages/joy-ui/api/badge.json b/docs/pages/joy-ui/api/badge.json index d6753aded2fb85..1dcb4dec32c35b 100644 --- a/docs/pages/joy-ui/api/badge.json +++ b/docs/pages/joy-ui/api/badge.json @@ -5,55 +5,63 @@ "name": "shape", "description": "{ horizontal: 'left'
    | 'right', vertical: 'bottom'
    | 'top' }" }, - "default": "{\n vertical: 'top',\n horizontal: 'right',\n}" + "default": "{\n vertical: 'top',\n horizontal: 'right',\n}", + "additionalPropsInfo": {} }, - "badgeContent": { "type": { "name": "node" }, "default": "''" }, + "badgeContent": { "type": { "name": "node" }, "default": "''", "additionalPropsInfo": {} }, "badgeInset": { "type": { "name": "union", "description": "number
    | string" }, - "default": "0" + "default": "0", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "invisible": { "type": { "name": "bool" }, "default": "false" }, - "max": { "type": { "name": "number" }, "default": "99" }, - "showZero": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "invisible": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "max": { "type": { "name": "number" }, "default": "99", "additionalPropsInfo": {} }, + "showZero": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ badge?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ badge?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Badge", diff --git a/docs/pages/joy-ui/api/breadcrumbs.json b/docs/pages/joy-ui/api/breadcrumbs.json index 1f5713351f4d38..0458e4a9f15452 100644 --- a/docs/pages/joy-ui/api/breadcrumbs.json +++ b/docs/pages/joy-ui/api/breadcrumbs.json @@ -1,34 +1,38 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, - "separator": { "type": { "name": "node" }, "default": "'/'" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "separator": { "type": { "name": "node" }, "default": "'/'", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ li?: func
    | object, ol?: func
    | object, root?: func
    | object, separator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ li?: elementType, ol?: elementType, root?: elementType, separator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Breadcrumbs", diff --git a/docs/pages/joy-ui/api/button.json b/docs/pages/joy-ui/api/button.json index 5cff82c4bbe0e8..4f0e6896484408 100644 --- a/docs/pages/joy-ui/api/button.json +++ b/docs/pages/joy-ui/api/button.json @@ -4,62 +4,74 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "loading": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "loadingIndicator": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "endDecorator": { "type": { "name": "node" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "loading": { "type": { "name": "bool" }, "default": "false" }, - "loadingIndicator": { "type": { "name": "node" }, "default": "" }, "loadingPosition": { "type": { "name": "enum", "description": "'center'
    | 'end'
    | 'start'" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ endDecorator?: func
    | object, loadingIndicatorCenter?: func
    | object, root?: func
    | object, startDecorator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Button", diff --git a/docs/pages/joy-ui/api/card-content.json b/docs/pages/joy-ui/api/card-content.json index 2b72e3d55f6f68..9c1a9f158657f1 100644 --- a/docs/pages/joy-ui/api/card-content.json +++ b/docs/pages/joy-ui/api/card-content.json @@ -1,20 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardContent", diff --git a/docs/pages/joy-ui/api/card-cover.json b/docs/pages/joy-ui/api/card-cover.json index f851a8cebd7d37..a16ba90e784393 100644 --- a/docs/pages/joy-ui/api/card-cover.json +++ b/docs/pages/joy-ui/api/card-cover.json @@ -1,20 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardCover", diff --git a/docs/pages/joy-ui/api/card-overflow.json b/docs/pages/joy-ui/api/card-overflow.json index bc18d8e7e93718..e90197fa5e9f2d 100644 --- a/docs/pages/joy-ui/api/card-overflow.json +++ b/docs/pages/joy-ui/api/card-overflow.json @@ -1,34 +1,39 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "CardOverflow", diff --git a/docs/pages/joy-ui/api/card.json b/docs/pages/joy-ui/api/card.json index 8ca5d9d7f2fee0..f2f5da18d423a7 100644 --- a/docs/pages/joy-ui/api/card.json +++ b/docs/pages/joy-ui/api/card.json @@ -1,46 +1,53 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "invertedColors": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "invertedColors": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'vertical'" + "default": "'vertical'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'lg'
    | 'md'
    | 'sm'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Card", diff --git a/docs/pages/joy-ui/api/checkbox.json b/docs/pages/joy-ui/api/checkbox.json index 28fbe9d7399100..4685177968ec70 100644 --- a/docs/pages/joy-ui/api/checkbox.json +++ b/docs/pages/joy-ui/api/checkbox.json @@ -1,64 +1,86 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "checkedIcon": { "type": { "name": "node" }, "default": "" }, - "className": { "type": { "name": "string" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "checkedIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableIcon": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "indeterminate": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "indeterminateIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" } }, - "disableIcon": { "type": { "name": "bool" }, "default": "false" }, - "indeterminate": { "type": { "name": "bool" }, "default": "false" }, - "indeterminateIcon": { "type": { "name": "node" }, "default": "" }, - "label": { "type": { "name": "node" } }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "overlay": { "type": { "name": "bool" }, "default": "false" }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, + "overlay": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "enum", "description": "'sm'
    | 'md'
    | 'lg'" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ action?: func
    | object, checkbox?: func
    | object, input?: func
    | object, label?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ action?: elementType, checkbox?: elementType, input?: elementType, label?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "uncheckedIcon": { "type": { "name": "node" } }, + "uncheckedIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "value": { "type": { "name": "union", "description": "Array<string>
    | number
    | string" - } + }, + "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Checkbox", diff --git a/docs/pages/joy-ui/api/chip-delete.json b/docs/pages/joy-ui/api/chip-delete.json index 8a9e02a3a9bb73..4fd08ff88a0886 100644 --- a/docs/pages/joy-ui/api/chip-delete.json +++ b/docs/pages/joy-ui/api/chip-delete.json @@ -1,36 +1,41 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" } }, - "onDelete": { "type": { "name": "func" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "onDelete": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ChipDelete", diff --git a/docs/pages/joy-ui/api/chip.json b/docs/pages/joy-ui/api/chip.json index 05655f40b3e3eb..8374d65d36708f 100644 --- a/docs/pages/joy-ui/api/chip.json +++ b/docs/pages/joy-ui/api/chip.json @@ -1,51 +1,57 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "endDecorator": { "type": { "name": "node" } }, - "onClick": { "type": { "name": "func" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "onClick": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'lg'
    | 'md'
    | 'sm'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ action?: func
    | object, endDecorator?: func
    | object, label?: func
    | object, root?: func
    | object, startDecorator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ action?: elementType, endDecorator?: elementType, label?: elementType, root?: elementType, startDecorator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Chip", diff --git a/docs/pages/joy-ui/api/circular-progress.json b/docs/pages/joy-ui/api/circular-progress.json index aad6406e3b1ec8..4c4ea769e983aa 100644 --- a/docs/pages/joy-ui/api/circular-progress.json +++ b/docs/pages/joy-ui/api/circular-progress.json @@ -5,45 +5,55 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "determinate": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "determinate": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ progress?: func
    | object, root?: func
    | object, svg?: func
    | object, track?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ progress?: elementType, root?: elementType, svg?: elementType, track?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "thickness": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "value": { + "type": { "name": "number" }, + "default": "determinate ? 0 : 25", + "additionalPropsInfo": {} }, - "thickness": { "type": { "name": "number" } }, - "value": { "type": { "name": "number" }, "default": "determinate ? 0 : 25" }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "CircularProgress", diff --git a/docs/pages/joy-ui/api/css-baseline.json b/docs/pages/joy-ui/api/css-baseline.json index 800e8954e500f0..c26297969c0238 100644 --- a/docs/pages/joy-ui/api/css-baseline.json +++ b/docs/pages/joy-ui/api/css-baseline.json @@ -1,7 +1,11 @@ { "props": { - "children": { "type": { "name": "node" } }, - "disableColorScheme": { "type": { "name": "bool" }, "default": "false" } + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "disableColorScheme": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + } }, "name": "CssBaseline", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/joy-ui/api/divider.json b/docs/pages/joy-ui/api/divider.json index b2721f0f4d2cf1..e4d3c22e43b3f4 100644 --- a/docs/pages/joy-ui/api/divider.json +++ b/docs/pages/joy-ui/api/divider.json @@ -1,30 +1,35 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "inset": { "type": { "name": "union", "description": "'none'
    | 'context'
    | string" - } + }, + "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Divider", diff --git a/docs/pages/joy-ui/api/form-control.json b/docs/pages/joy-ui/api/form-control.json index a17e97abd77b3e..3d4553363e3e9f 100644 --- a/docs/pages/joy-ui/api/form-control.json +++ b/docs/pages/joy-ui/api/form-control.json @@ -1,40 +1,46 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "error": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'vertical'" + "default": "'vertical'", + "additionalPropsInfo": {} }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "FormControl", diff --git a/docs/pages/joy-ui/api/form-helper-text.json b/docs/pages/joy-ui/api/form-helper-text.json index ac6f2cef69ed24..8bbb3df4e1998d 100644 --- a/docs/pages/joy-ui/api/form-helper-text.json +++ b/docs/pages/joy-ui/api/form-helper-text.json @@ -1,20 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "FormHelperText", diff --git a/docs/pages/joy-ui/api/form-label.json b/docs/pages/joy-ui/api/form-label.json index a7da6f3d7f39b4..1eee31f6a4ff34 100644 --- a/docs/pages/joy-ui/api/form-label.json +++ b/docs/pages/joy-ui/api/form-label.json @@ -1,24 +1,27 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, - "required": { "type": { "name": "bool" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ asterisk?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ asterisk?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "FormLabel", diff --git a/docs/pages/joy-ui/api/icon-button.json b/docs/pages/joy-ui/api/icon-button.json index d56392b4fd4d80..4cb274b81354bf 100644 --- a/docs/pages/joy-ui/api/icon-button.json +++ b/docs/pages/joy-ui/api/icon-button.json @@ -4,45 +4,52 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "focusVisibleClassName": { "type": { "name": "string" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "IconButton", diff --git a/docs/pages/joy-ui/api/input.json b/docs/pages/joy-ui/api/input.json index 6f36a1da614855..b1815761eba776 100644 --- a/docs/pages/joy-ui/api/input.json +++ b/docs/pages/joy-ui/api/input.json @@ -1,33 +1,37 @@ { "props": { - "className": { "type": { "name": "string" } }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } }, - "endDecorator": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" } }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" - } + }, + "additionalPropsInfo": { "joy-size": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" - } + }, + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Input", diff --git a/docs/pages/joy-ui/api/linear-progress.json b/docs/pages/joy-ui/api/linear-progress.json index a28d43271675e8..37efe85f6d4ed6 100644 --- a/docs/pages/joy-ui/api/linear-progress.json +++ b/docs/pages/joy-ui/api/linear-progress.json @@ -5,39 +5,49 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "determinate": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "determinate": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "thickness": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "value": { + "type": { "name": "number" }, + "default": "determinate ? 0 : 25", + "additionalPropsInfo": {} }, - "thickness": { "type": { "name": "number" } }, - "value": { "type": { "name": "number" }, "default": "determinate ? 0 : 25" }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "LinearProgress", diff --git a/docs/pages/joy-ui/api/link.json b/docs/pages/joy-ui/api/link.json index 0efc1ae2b4c3e2..6501ea18b66df8 100644 --- a/docs/pages/joy-ui/api/link.json +++ b/docs/pages/joy-ui/api/link.json @@ -1,59 +1,66 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "endDecorator": { "type": { "name": "node" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "level": { "type": { "name": "union", "description": "'body1'
    | 'body2'
    | 'body3'
    | 'h1'
    | 'h2'
    | 'h3'
    | 'h4'
    | 'h5'
    | 'h6'
    | 'inherit'
    | string" }, - "default": "'body1'" + "default": "'body1'", + "additionalPropsInfo": {} }, - "overlay": { "type": { "name": "bool" }, "default": "false" }, + "overlay": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ endDecorator?: func
    | object, root?: func
    | object, startDecorator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "textColor": { "type": { "name": "any" } }, + "textColor": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "underline": { "type": { "name": "enum", "description": "'always'
    | 'hover'
    | 'none'" }, - "default": "'hover'" + "default": "'hover'", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Link", diff --git a/docs/pages/joy-ui/api/list-divider.json b/docs/pages/joy-ui/api/list-divider.json index 4edc578dc05148..3db8f71d8cbca4 100644 --- a/docs/pages/joy-ui/api/list-divider.json +++ b/docs/pages/joy-ui/api/list-divider.json @@ -1,31 +1,36 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "inset": { "type": { "name": "union", "description": "'context'
    | 'gutter'
    | 'startDecorator'
    | 'startContent'
    | string" }, - "default": "'context'" + "default": "'context'", + "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListDivider", diff --git a/docs/pages/joy-ui/api/list-item-button.json b/docs/pages/joy-ui/api/list-item-button.json index df9b2cd889acb1..456d9294008cb0 100644 --- a/docs/pages/joy-ui/api/list-item-button.json +++ b/docs/pages/joy-ui/api/list-item-button.json @@ -4,45 +4,52 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "selected ? 'primary' : 'neutral'" + "default": "selected ? 'primary' : 'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "focusVisibleClassName": { "type": { "name": "string" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ListItemButton", diff --git a/docs/pages/joy-ui/api/list-item-content.json b/docs/pages/joy-ui/api/list-item-content.json index 206ffd7831914c..dbd629164cc761 100644 --- a/docs/pages/joy-ui/api/list-item-content.json +++ b/docs/pages/joy-ui/api/list-item-content.json @@ -1,20 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemContent", diff --git a/docs/pages/joy-ui/api/list-item-decorator.json b/docs/pages/joy-ui/api/list-item-decorator.json index f8729f2e3a683d..dc2108939bdc57 100644 --- a/docs/pages/joy-ui/api/list-item-decorator.json +++ b/docs/pages/joy-ui/api/list-item-decorator.json @@ -1,20 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemDecorator", diff --git a/docs/pages/joy-ui/api/list-item.json b/docs/pages/joy-ui/api/list-item.json index 61434d1664572a..d6881289dae3f5 100644 --- a/docs/pages/joy-ui/api/list-item.json +++ b/docs/pages/joy-ui/api/list-item.json @@ -1,44 +1,49 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "endAction": { "type": { "name": "node" } }, - "nested": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "endAction": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "nested": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ endAction?: func
    | object, root?: func
    | object, startAction?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ endAction?: elementType, root?: elementType, startAction?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startAction": { "type": { "name": "node" } }, - "sticky": { "type": { "name": "bool" }, "default": "false" }, + "startAction": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "sticky": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ListItem", diff --git a/docs/pages/joy-ui/api/list-subheader.json b/docs/pages/joy-ui/api/list-subheader.json index 4963a6ac752f0f..fc66466e53a196 100644 --- a/docs/pages/joy-ui/api/list-subheader.json +++ b/docs/pages/joy-ui/api/list-subheader.json @@ -1,33 +1,38 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "sticky": { "type": { "name": "bool" }, "default": "false" }, + "sticky": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" - } + }, + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ListSubheader", diff --git a/docs/pages/joy-ui/api/list.json b/docs/pages/joy-ui/api/list.json index 5172da7fea89db..a1c6b48982bee4 100644 --- a/docs/pages/joy-ui/api/list.json +++ b/docs/pages/joy-ui/api/list.json @@ -1,47 +1,54 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'vertical'" + "default": "'vertical'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } }, - "wrap": { "type": { "name": "bool" }, "default": "false" } + "wrap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "List", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/joy-ui/api/menu-item.json b/docs/pages/joy-ui/api/menu-item.json index ae189c217de216..f9cb749d66a0db 100644 --- a/docs/pages/joy-ui/api/menu-item.json +++ b/docs/pages/joy-ui/api/menu-item.json @@ -1,32 +1,37 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "selected ? 'primary' : 'neutral'" + "default": "selected ? 'primary' : 'neutral'", + "additionalPropsInfo": { "joy-color": true } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'light'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "MenuItem", diff --git a/docs/pages/joy-ui/api/menu-list.json b/docs/pages/joy-ui/api/menu-list.json index 130ad01a48e855..9d614182393ed8 100644 --- a/docs/pages/joy-ui/api/menu-list.json +++ b/docs/pages/joy-ui/api/menu-list.json @@ -4,43 +4,50 @@ "type": { "name": "union", "description": "func
    | { current?: { dispatch: func } }" - } + }, + "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "MenuList", diff --git a/docs/pages/joy-ui/api/menu.json b/docs/pages/joy-ui/api/menu.json index 0ae4987fa1ea96..6591d533d5f7bd 100644 --- a/docs/pages/joy-ui/api/menu.json +++ b/docs/pages/joy-ui/api/menu.json @@ -1,53 +1,63 @@ { "props": { - "actions": { "type": { "name": "custom", "description": "ref" } }, - "anchorEl": { "type": { "name": "union", "description": "HTML element
    | func" } }, + "actions": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "anchorEl": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, "color": { "type": { "name": "enum", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "invertedColors": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "invertedColors": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "modifiers": { "type": { "name": "arrayOf", "description": "Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
    | 'afterRead'
    | 'afterWrite'
    | 'beforeMain'
    | 'beforeRead'
    | 'beforeWrite'
    | 'main'
    | 'read'
    | 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>" - } + }, + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" }, "default": "false" }, + "onClose": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Menu", diff --git a/docs/pages/joy-ui/api/modal-close.json b/docs/pages/joy-ui/api/modal-close.json index 267148cd63afb7..718d406c5a2e25 100644 --- a/docs/pages/joy-ui/api/modal-close.json +++ b/docs/pages/joy-ui/api/modal-close.json @@ -5,36 +5,42 @@ "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ModalClose", diff --git a/docs/pages/joy-ui/api/modal-dialog.json b/docs/pages/joy-ui/api/modal-dialog.json index cb85631e914428..cfaa7bfb0382c5 100644 --- a/docs/pages/joy-ui/api/modal-dialog.json +++ b/docs/pages/joy-ui/api/modal-dialog.json @@ -1,48 +1,55 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "layout": { "type": { "name": "union", "description": "'center'
    | 'fullscreen'
    | string" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "ModalDialog", diff --git a/docs/pages/joy-ui/api/modal-overflow.json b/docs/pages/joy-ui/api/modal-overflow.json index b951a74b9af6c1..f6827918c405a4 100644 --- a/docs/pages/joy-ui/api/modal-overflow.json +++ b/docs/pages/joy-ui/api/modal-overflow.json @@ -4,7 +4,8 @@ "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ModalOverflow", diff --git a/docs/pages/joy-ui/api/modal.json b/docs/pages/joy-ui/api/modal.json index 4358dfb91be052..07c9679ef9ec2f 100644 --- a/docs/pages/joy-ui/api/modal.json +++ b/docs/pages/joy-ui/api/modal.json @@ -1,34 +1,71 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "open": { "type": { "name": "bool" }, "required": true }, - "component": { "type": { "name": "elementType" } }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableScrollLock": { "type": { "name": "bool" }, "default": "false" }, - "hideBackdrop": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, - "onClose": { "type": { "name": "func" } }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "disableAutoFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEnforceFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEscapeKeyDown": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableRestoreFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableScrollLock": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "hideBackdrop": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, "slotProps": { "type": { "name": "shape", "description": "{ backdrop?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Modal", diff --git a/docs/pages/joy-ui/api/option.json b/docs/pages/joy-ui/api/option.json index de95c2ab258ace..273b132d1a2429 100644 --- a/docs/pages/joy-ui/api/option.json +++ b/docs/pages/joy-ui/api/option.json @@ -1,37 +1,45 @@ { "props": { - "value": { "type": { "name": "any" }, "required": true }, - "children": { "type": { "name": "node" } }, + "value": { "type": { "name": "any" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "label": { + "type": { "name": "union", "description": "element
    | string" }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "label": { "type": { "name": "union", "description": "element
    | string" } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Option", diff --git a/docs/pages/joy-ui/api/radio-group.json b/docs/pages/joy-ui/api/radio-group.json index 6bad3d2b75c9ed..1fe2fa66f60d71 100644 --- a/docs/pages/joy-ui/api/radio-group.json +++ b/docs/pages/joy-ui/api/radio-group.json @@ -1,51 +1,65 @@ { "props": { - "className": { "type": { "name": "string" } }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disableIcon": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "defaultValue": { "type": { "name": "any" } }, - "disableIcon": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'vertical'" + "default": "'vertical'", + "additionalPropsInfo": {} }, - "overlay": { "type": { "name": "bool" }, "default": "false" }, + "overlay": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "RadioGroup", diff --git a/docs/pages/joy-ui/api/radio.json b/docs/pages/joy-ui/api/radio.json index 8496bdf567cf53..989cdc2747e699 100644 --- a/docs/pages/joy-ui/api/radio.json +++ b/docs/pages/joy-ui/api/radio.json @@ -1,60 +1,73 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "checkedIcon": { "type": { "name": "node" } }, - "className": { "type": { "name": "string" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "checkedIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" } }, - "disableIcon": { "type": { "name": "bool" }, "default": "false" }, - "label": { "type": { "name": "node" } }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "overlay": { "type": { "name": "bool" }, "default": "false" }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableIcon": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "overlay": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ action?: func
    | object, icon?: func
    | object, input?: func
    | object, label?: func
    | object, radio?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ action?: elementType, icon?: elementType, input?: elementType, label?: elementType, radio?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "uncheckedIcon": { "type": { "name": "node" } }, - "value": { "type": { "name": "any" } }, + "uncheckedIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Radio", diff --git a/docs/pages/joy-ui/api/scoped-css-baseline.json b/docs/pages/joy-ui/api/scoped-css-baseline.json index 3fc84e35ada114..6428137cc6c492 100644 --- a/docs/pages/joy-ui/api/scoped-css-baseline.json +++ b/docs/pages/joy-ui/api/scoped-css-baseline.json @@ -1,21 +1,28 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, - "disableColorScheme": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableColorScheme": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ScopedCssBaseline", diff --git a/docs/pages/joy-ui/api/select.json b/docs/pages/joy-ui/api/select.json index bc07469be9958e..0a048e88d94fdc 100644 --- a/docs/pages/joy-ui/api/select.json +++ b/docs/pages/joy-ui/api/select.json @@ -4,55 +4,61 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, - "autoFocus": { "type": { "name": "bool" } }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "defaultListboxOpen": { "type": { "name": "bool" } }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "endDecorator": { "type": { "name": "node" } }, - "getSerializedValue": { "type": { "name": "func" } }, - "indicator": { "type": { "name": "node" } }, - "listboxId": { "type": { "name": "string" } }, - "listboxOpen": { "type": { "name": "bool" } }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onListboxOpenChange": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "node" } }, - "renderValue": { "type": { "name": "func" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultListboxOpen": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "getSerializedValue": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "indicator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "listboxId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "listboxOpen": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "onClose": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "onListboxOpenChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "placeholder": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "renderValue": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" - } + }, + "additionalPropsInfo": { "joy-size": true } }, "slots": { "type": { "name": "shape", "description": "{ button?: elementType, endDecorator?: elementType, indicator?: elementType, listbox?: elementType, root?: elementType, startDecorator?: elementType }" - } + }, + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" - } + }, + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Select", diff --git a/docs/pages/joy-ui/api/sheet.json b/docs/pages/joy-ui/api/sheet.json index 9f0ed345eea55c..8d224583058743 100644 --- a/docs/pages/joy-ui/api/sheet.json +++ b/docs/pages/joy-ui/api/sheet.json @@ -1,35 +1,40 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "invertedColors": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "invertedColors": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Sheet", diff --git a/docs/pages/joy-ui/api/slider.json b/docs/pages/joy-ui/api/slider.json index 789b3cb04ff238..f181a6bb24ac4d 100644 --- a/docs/pages/joy-ui/api/slider.json +++ b/docs/pages/joy-ui/api/slider.json @@ -1,94 +1,137 @@ { "props": { - "aria-label": { "type": { "name": "string" } }, - "aria-valuetext": { "type": { "name": "string" } }, - "classes": { "type": { "name": "object" } }, + "aria-label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-valuetext": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "defaultValue": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableSwap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getAriaLabel": { + "type": { "name": "func" }, + "signature": { "type": "function(index: number) => string", "describedArgs": ["index"] }, + "additionalPropsInfo": {} + }, + "getAriaValueText": { + "type": { "name": "func" }, + "signature": { + "type": "function(value: number, index: number) => string", + "describedArgs": ["value", "index"] + }, + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableSwap": { "type": { "name": "bool" }, "default": "false" }, - "getAriaLabel": { "type": { "name": "func" } }, - "getAriaValueText": { "type": { "name": "func" } }, - "isRtl": { "type": { "name": "bool" }, "default": "false" }, + "isRtl": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "marks": { "type": { "name": "union", "description": "Array<{ label?: node, value: number }>
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} + }, + "max": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, + "min": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: Event, value: number | Array, activeThumb: number) => void", + "describedArgs": ["event", "value", "activeThumb"] + }, + "additionalPropsInfo": {} + }, + "onChangeCommitted": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent | Event, value: number | Array) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} }, - "max": { "type": { "name": "number" }, "default": "100" }, - "min": { "type": { "name": "number" }, "default": "0" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onChangeCommitted": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} + }, + "scale": { + "type": { "name": "func" }, + "default": "function Identity(x) {\n return x;\n}", + "signature": { "type": "function(x: any) => any", "describedArgs": [] }, + "additionalPropsInfo": {} }, - "scale": { "type": { "name": "func" }, "default": "function Identity(x) {\n return x;\n}" }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "step": { "type": { "name": "number" }, "default": "1" }, + "step": { "type": { "name": "number" }, "default": "1", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "tabIndex": { "type": { "name": "number" } }, + "tabIndex": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "track": { "type": { "name": "enum", "description": "'inverted'
    | 'normal'
    | false" }, - "default": "'normal'" + "default": "'normal'", + "additionalPropsInfo": {} }, "value": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} }, "valueLabelDisplay": { "type": { "name": "enum", "description": "'auto'
    | 'off'
    | 'on'" }, - "default": "'off'" + "default": "'off'", + "additionalPropsInfo": {} }, "valueLabelFormat": { "type": { "name": "union", "description": "func
    | string" }, - "default": "function Identity(x) {\n return x;\n}" + "default": "function Identity(x) {\n return x;\n}", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Slider", diff --git a/docs/pages/joy-ui/api/stack.json b/docs/pages/joy-ui/api/stack.json index 997c4b51253e1d..418d6901fbcb2e 100644 --- a/docs/pages/joy-ui/api/stack.json +++ b/docs/pages/joy-ui/api/stack.json @@ -1,27 +1,30 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - } + }, + "additionalPropsInfo": {} }, - "divider": { "type": { "name": "node" } }, + "divider": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "useFlexGap": { "type": { "name": "bool" } } + "useFlexGap": { "type": { "name": "bool" }, "additionalPropsInfo": {} } }, "name": "Stack", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/joy-ui/api/svg-icon.json b/docs/pages/joy-ui/api/svg-icon.json index c0921d037c8b9c..11d1a5afccde9b 100644 --- a/docs/pages/joy-ui/api/svg-icon.json +++ b/docs/pages/joy-ui/api/svg-icon.json @@ -1,40 +1,45 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'inherit'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "fontSize": { "type": { "name": "enum", "description": "'inherit'
    | 'lg'
    | 'md'
    | 'sm'
    | 'xl'
    | 'xl2'
    | 'xl3'
    | 'xl4'
    | 'xl5'
    | 'xl6'
    | 'xl7'
    | 'xs'
    | 'xs2'
    | 'xs3'" }, - "default": "'xl'" + "default": "'xl'", + "additionalPropsInfo": {} }, - "htmlColor": { "type": { "name": "string" } }, - "inheritViewBox": { "type": { "name": "bool" }, "default": "false" }, - "shapeRendering": { "type": { "name": "string" } }, + "htmlColor": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inheritViewBox": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "shapeRendering": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "titleAccess": { "type": { "name": "string" } }, - "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'" } + "titleAccess": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'", "additionalPropsInfo": {} } }, "name": "SvgIcon", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/joy-ui/api/switch.json b/docs/pages/joy-ui/api/switch.json index 0bf86934a88717..5a8f7f516c628f 100644 --- a/docs/pages/joy-ui/api/switch.json +++ b/docs/pages/joy-ui/api/switch.json @@ -1,54 +1,73 @@ { "props": { - "checked": { "type": { "name": "bool" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" } }, - "endDecorator": { "type": { "name": "union", "description": "node
    | func" } }, - "onChange": { "type": { "name": "func" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endDecorator": { + "type": { "name": "union", "description": "node
    | func" }, + "additionalPropsInfo": {} + }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ action?: func
    | object, endDecorator?: func
    | object, input?: func
    | object, root?: func
    | object, startDecorator?: func
    | object, thumb?: func
    | object, track?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ action?: elementType, endDecorator?: elementType, input?: elementType, root?: elementType, startDecorator?: elementType, thumb?: elementType, track?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } + }, + "startDecorator": { + "type": { "name": "union", "description": "node
    | func" }, + "additionalPropsInfo": {} }, - "startDecorator": { "type": { "name": "union", "description": "node
    | func" } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Switch", diff --git a/docs/pages/joy-ui/api/tab-list.json b/docs/pages/joy-ui/api/tab-list.json index ac5cec6a7fc3f0..b00f38a57ad2b0 100644 --- a/docs/pages/joy-ui/api/tab-list.json +++ b/docs/pages/joy-ui/api/tab-list.json @@ -1,40 +1,46 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" - } + }, + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'soft'" + "default": "'soft'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "TabList", diff --git a/docs/pages/joy-ui/api/tab-panel.json b/docs/pages/joy-ui/api/tab-panel.json index bd9697a189cd96..a44dbec54bb9e4 100644 --- a/docs/pages/joy-ui/api/tab-panel.json +++ b/docs/pages/joy-ui/api/tab-panel.json @@ -1,30 +1,35 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" - } + }, + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "value": { "type": { "name": "union", "description": "number
    | string" }, - "default": "0" + "default": "0", + "additionalPropsInfo": {} } }, "name": "TabPanel", diff --git a/docs/pages/joy-ui/api/tab.json b/docs/pages/joy-ui/api/tab.json index f89ccb6dbf0c8d..b33c057fbba814 100644 --- a/docs/pages/joy-ui/api/tab.json +++ b/docs/pages/joy-ui/api/tab.json @@ -4,43 +4,53 @@ "type": { "name": "union", "description": "func
    | { current?: { focusVisible: func } }" - } + }, + "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "value": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "value": { "type": { "name": "union", "description": "number
    | string" } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Tab", diff --git a/docs/pages/joy-ui/api/table.json b/docs/pages/joy-ui/api/table.json index b3692ebc507b29..cece1e2064d569 100644 --- a/docs/pages/joy-ui/api/table.json +++ b/docs/pages/joy-ui/api/table.json @@ -5,54 +5,62 @@ "name": "union", "description": "'both'
    | 'bothBetween'
    | 'none'
    | 'x'
    | 'xBetween'
    | 'y'
    | 'yBetween'
    | string" }, - "default": "'xBetween'" + "default": "'xBetween'", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "hoverRow": { "type": { "name": "bool" }, "default": "false" }, - "noWrap": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "hoverRow": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "noWrap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "stickyFooter": { "type": { "name": "bool" }, "default": "false" }, - "stickyHeader": { "type": { "name": "bool" }, "default": "false" }, + "stickyFooter": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "stickyHeader": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "stripe": { "type": { "name": "union", "description": "'odd'
    | 'even'
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Table", diff --git a/docs/pages/joy-ui/api/tabs.json b/docs/pages/joy-ui/api/tabs.json index dcda57d851bb78..f870c04aad6dd2 100644 --- a/docs/pages/joy-ui/api/tabs.json +++ b/docs/pages/joy-ui/api/tabs.json @@ -1,53 +1,67 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultValue": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "defaultValue": { "type": { "name": "union", "description": "number
    | string" } }, "direction": { "type": { "name": "enum", "description": "'ltr'
    | 'rtl'" }, - "default": "'ltr'" + "default": "'ltr'", + "additionalPropsInfo": {} }, - "onChange": { "type": { "name": "func" } }, + "onChange": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, - "selectionFollowsFocus": { "type": { "name": "bool" } }, + "selectionFollowsFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "value": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "value": { "type": { "name": "union", "description": "number
    | string" } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" }, - "default": "'plain'" + "default": "'plain'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Tabs", diff --git a/docs/pages/joy-ui/api/textarea.json b/docs/pages/joy-ui/api/textarea.json index e77c5b48d64788..43135d2df192aa 100644 --- a/docs/pages/joy-ui/api/textarea.json +++ b/docs/pages/joy-ui/api/textarea.json @@ -4,30 +4,40 @@ "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } + }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "endDecorator": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, "size": { "type": { "name": "union", "description": "'sm'
    | 'md'
    | 'lg'
    | string" - } + }, + "additionalPropsInfo": { "joy-size": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" - } + }, + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Textarea", diff --git a/docs/pages/joy-ui/api/tooltip.json b/docs/pages/joy-ui/api/tooltip.json index bde4506bcdda67..dd6733cf388b36 100644 --- a/docs/pages/joy-ui/api/tooltip.json +++ b/docs/pages/joy-ui/api/tooltip.json @@ -1,77 +1,124 @@ { "props": { - "children": { "type": { "name": "element" }, "required": true }, - "arrow": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "element" }, "required": true, "additionalPropsInfo": {} }, + "arrow": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "color": { "type": { "name": "enum", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'" }, - "default": "'neutral'" + "default": "'neutral'", + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "describeChild": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "describeChild": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "direction": { "type": { "name": "enum", "description": "'ltr'
    | 'rtl'" }, - "default": "'ltr'" - }, - "disableFocusListener": { "type": { "name": "bool" }, "default": "false" }, - "disableHoverListener": { "type": { "name": "bool" }, "default": "false" }, - "disableInteractive": { "type": { "name": "bool" }, "default": "false" }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "disableTouchListener": { "type": { "name": "bool" }, "default": "false" }, - "enterDelay": { "type": { "name": "number" }, "default": "100" }, - "enterNextDelay": { "type": { "name": "number" }, "default": "0" }, - "enterTouchDelay": { "type": { "name": "number" }, "default": "700" }, - "followCursor": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, - "leaveDelay": { "type": { "name": "number" }, "default": "0" }, - "leaveTouchDelay": { "type": { "name": "number" }, "default": "1500" }, + "default": "'ltr'", + "additionalPropsInfo": {} + }, + "disableFocusListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableHoverListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableInteractive": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableTouchListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "enterDelay": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, + "enterNextDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "enterTouchDelay": { + "type": { "name": "number" }, + "default": "700", + "additionalPropsInfo": {} + }, + "followCursor": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "leaveDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "leaveTouchDelay": { + "type": { "name": "number" }, + "default": "1500", + "additionalPropsInfo": {} + }, "modifiers": { "type": { "name": "arrayOf", "description": "Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
    | 'afterRead'
    | 'afterWrite'
    | 'beforeMain'
    | 'beforeRead'
    | 'beforeWrite'
    | 'main'
    | 'read'
    | 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>" - } + }, + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, + "onOpen": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "placement": { "type": { "name": "enum", "description": "'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "enum", "description": "'sm'
    | 'md'
    | 'lg'" }, - "default": "'md'" + "default": "'md'", + "additionalPropsInfo": { "joy-size": true } }, "slotProps": { "type": { "name": "shape", "description": "{ arrow?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ arrow?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "title": { "type": { "name": "node" } }, + "title": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'" }, - "default": "'solid'" + "default": "'solid'", + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Tooltip", diff --git a/docs/pages/joy-ui/api/typography.json b/docs/pages/joy-ui/api/typography.json index 51891dd51f2e48..70cb7e4fd91816 100644 --- a/docs/pages/joy-ui/api/typography.json +++ b/docs/pages/joy-ui/api/typography.json @@ -1,54 +1,61 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'danger'
    | 'info'
    | 'neutral'
    | 'primary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": { "joy-color": true } }, - "component": { "type": { "name": "elementType" } }, - "endDecorator": { "type": { "name": "node" } }, - "gutterBottom": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "endDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "gutterBottom": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "level": { "type": { "name": "union", "description": "'body1'
    | 'body2'
    | 'body3'
    | 'h1'
    | 'h2'
    | 'h3'
    | 'h4'
    | 'h5'
    | 'h6'
    | 'inherit'
    | string" }, - "default": "'body1'" + "default": "'body1'", + "additionalPropsInfo": {} }, "levelMapping": { "type": { "name": "object" }, - "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n body1: 'p',\n body2: 'p',\n body3: 'p',\n inherit: 'p',\n}" + "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n body1: 'p',\n body2: 'p',\n body3: 'p',\n inherit: 'p',\n}", + "additionalPropsInfo": {} }, - "noWrap": { "type": { "name": "bool" }, "default": "false" }, + "noWrap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ endDecorator?: func
    | object, root?: func
    | object, startDecorator?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": { "slotsApi": true } }, - "startDecorator": { "type": { "name": "node" } }, + "startDecorator": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "textColor": { "type": { "name": "any" } }, + "textColor": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'plain'
    | 'soft'
    | 'solid'
    | string" - } + }, + "additionalPropsInfo": { "joy-variant": true } } }, "name": "Typography", diff --git a/docs/pages/material-ui/api/accordion-actions.json b/docs/pages/material-ui/api/accordion-actions.json index 1dd68fcb7fbe18..7371e56ca71554 100644 --- a/docs/pages/material-ui/api/accordion-actions.json +++ b/docs/pages/material-ui/api/accordion-actions.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableSpacing": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableSpacing": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "AccordionActions", diff --git a/docs/pages/material-ui/api/accordion-details.json b/docs/pages/material-ui/api/accordion-details.json index 011365809191fd..f76a373fc6274e 100644 --- a/docs/pages/material-ui/api/accordion-details.json +++ b/docs/pages/material-ui/api/accordion-details.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "AccordionDetails", diff --git a/docs/pages/material-ui/api/accordion-summary.json b/docs/pages/material-ui/api/accordion-summary.json index 17b1a7ebc66944..4a10c7a38ec97a 100644 --- a/docs/pages/material-ui/api/accordion-summary.json +++ b/docs/pages/material-ui/api/accordion-summary.json @@ -1,14 +1,15 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "expandIcon": { "type": { "name": "node" } }, - "focusVisibleClassName": { "type": { "name": "string" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "expandIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "AccordionSummary", diff --git a/docs/pages/material-ui/api/accordion.json b/docs/pages/material-ui/api/accordion.json index 4fc26aa443860a..d95dce6385b630 100644 --- a/docs/pages/material-ui/api/accordion.json +++ b/docs/pages/material-ui/api/accordion.json @@ -1,21 +1,41 @@ { "props": { - "children": { "type": { "name": "custom", "description": "node" }, "required": true }, - "classes": { "type": { "name": "object" } }, - "defaultExpanded": { "type": { "name": "bool" }, "default": "false" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, - "expanded": { "type": { "name": "bool" } }, - "onChange": { "type": { "name": "func" } }, - "square": { "type": { "name": "bool" }, "default": "false" }, + "children": { + "type": { "name": "custom", "description": "node" }, + "required": true, + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "defaultExpanded": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "expanded": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, expanded: boolean) => void", + "describedArgs": ["event", "expanded"] + }, + "additionalPropsInfo": {} + }, + "square": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Collapse", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Collapse" }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "Accordion", "styles": { diff --git a/docs/pages/material-ui/api/alert-title.json b/docs/pages/material-ui/api/alert-title.json index fe18e7e7a1129c..9d8269184a902d 100644 --- a/docs/pages/material-ui/api/alert-title.json +++ b/docs/pages/material-ui/api/alert-title.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "AlertTitle", diff --git a/docs/pages/material-ui/api/alert.json b/docs/pages/material-ui/api/alert.json index f259814a897b89..475e5385abdc5e 100644 --- a/docs/pages/material-ui/api/alert.json +++ b/docs/pages/material-ui/api/alert.json @@ -1,65 +1,81 @@ { "props": { - "action": { "type": { "name": "node" } }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "closeText": { "type": { "name": "string" }, "default": "'Close'" }, + "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "closeText": { "type": { "name": "string" }, "default": "'Close'", "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ CloseButton?: elementType, CloseIcon?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ closeButton?: object, closeIcon?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" } }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "iconMapping": { "type": { "name": "shape", "description": "{ error?: node, info?: node, success?: node, warning?: node }" - } + }, + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, - "role": { "type": { "name": "string" }, "default": "'alert'" }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "role": { "type": { "name": "string" }, "default": "'alert'", "additionalPropsInfo": {} }, "severity": { "type": { "name": "enum", "description": "'error'
    | 'info'
    | 'success'
    | 'warning'" }, - "default": "'success'" + "default": "'success'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ closeButton?: object, closeIcon?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ closeButton?: elementType, closeIcon?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'filled'
    | 'outlined'
    | 'standard'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} } }, "name": "Alert", diff --git a/docs/pages/material-ui/api/app-bar.json b/docs/pages/material-ui/api/app-bar.json index d58d617d4f4e54..c08ced9b7f104a 100644 --- a/docs/pages/material-ui/api/app-bar.json +++ b/docs/pages/material-ui/api/app-bar.json @@ -1,27 +1,34 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'inherit'
    | 'primary'
    | 'secondary'
    | 'transparent'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} + }, + "enableColorOnDark": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "enableColorOnDark": { "type": { "name": "bool" }, "default": "false" }, "position": { "type": { "name": "enum", "description": "'absolute'
    | 'fixed'
    | 'relative'
    | 'static'
    | 'sticky'" }, - "default": "'fixed'" + "default": "'fixed'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "AppBar", diff --git a/docs/pages/material-ui/api/autocomplete.json b/docs/pages/material-ui/api/autocomplete.json index fe7dfec539ba38..061bfaccf492a7 100644 --- a/docs/pages/material-ui/api/autocomplete.json +++ b/docs/pages/material-ui/api/autocomplete.json @@ -1,105 +1,271 @@ { "props": { - "options": { "type": { "name": "array" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "autoComplete": { "type": { "name": "bool" }, "default": "false" }, - "autoHighlight": { "type": { "name": "bool" }, "default": "false" }, - "autoSelect": { "type": { "name": "bool" }, "default": "false" }, + "options": { "type": { "name": "array" }, "required": true, "additionalPropsInfo": {} }, + "renderInput": { + "type": { "name": "func" }, + "required": true, + "signature": { "type": "function(params: object) => ReactNode", "describedArgs": [] }, + "additionalPropsInfo": {} + }, + "autoComplete": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "autoHighlight": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "autoSelect": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "blurOnSelect": { "type": { "name": "union", "description": "'mouse'
    | 'touch'
    | bool" }, - "default": "false" - }, - "ChipProps": { "type": { "name": "object" } }, - "classes": { "type": { "name": "object" } }, - "clearIcon": { "type": { "name": "node" }, "default": "" }, - "clearOnBlur": { "type": { "name": "bool" }, "default": "!props.freeSolo" }, - "clearOnEscape": { "type": { "name": "bool" }, "default": "false" }, - "clearText": { "type": { "name": "string" }, "default": "'Clear'" }, - "closeText": { "type": { "name": "string" }, "default": "'Close'" }, + "default": "false", + "additionalPropsInfo": {} + }, + "ChipProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "clearIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "clearOnBlur": { + "type": { "name": "bool" }, + "default": "!props.freeSolo", + "additionalPropsInfo": {} + }, + "clearOnEscape": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "clearText": { "type": { "name": "string" }, "default": "'Clear'", "additionalPropsInfo": {} }, + "closeText": { "type": { "name": "string" }, "default": "'Close'", "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "defaultValue": { "type": { "name": "custom", "description": "any" }, - "default": "props.multiple ? [] : null" - }, - "disableClearable": { "type": { "name": "bool" }, "default": "false" }, - "disableCloseOnSelect": { "type": { "name": "bool" }, "default": "false" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" }, - "disableListWrap": { "type": { "name": "bool" }, "default": "false" }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "filterOptions": { "type": { "name": "func" }, "default": "createFilterOptions()" }, - "filterSelectedOptions": { "type": { "name": "bool" }, "default": "false" }, + "default": "props.multiple ? [] : null", + "additionalPropsInfo": {} + }, + "disableClearable": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableCloseOnSelect": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabledItemsFocusable": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableListWrap": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "filterOptions": { + "type": { "name": "func" }, + "default": "createFilterOptions()", + "signature": { + "type": "function(options: Array, state: object) => Array", + "describedArgs": ["options", "state"] + }, + "additionalPropsInfo": {} + }, + "filterSelectedOptions": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, "forcePopupIcon": { "type": { "name": "union", "description": "'auto'
    | bool" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} + }, + "freeSolo": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getLimitTagsText": { + "type": { "name": "func" }, + "default": "(more) => `+${more}`", + "signature": { "type": "function(more: number) => ReactNode", "describedArgs": ["more"] }, + "additionalPropsInfo": {} + }, + "getOptionDisabled": { + "type": { "name": "func" }, + "signature": { "type": "function(option: T) => boolean", "describedArgs": ["option"] }, + "additionalPropsInfo": {} }, - "freeSolo": { "type": { "name": "bool" }, "default": "false" }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "getLimitTagsText": { "type": { "name": "func" }, "default": "(more) => `+${more}`" }, - "getOptionDisabled": { "type": { "name": "func" } }, "getOptionLabel": { "type": { "name": "func" }, - "default": "(option) => option.label ?? option" - }, - "groupBy": { "type": { "name": "func" } }, - "handleHomeEndKeys": { "type": { "name": "bool" }, "default": "!props.freeSolo" }, - "id": { "type": { "name": "string" } }, - "includeInputInList": { "type": { "name": "bool" }, "default": "false" }, - "inputValue": { "type": { "name": "string" } }, - "isOptionEqualToValue": { "type": { "name": "func" } }, - "limitTags": { "type": { "name": "custom", "description": "integer" }, "default": "-1" }, - "ListboxComponent": { "type": { "name": "elementType" }, "default": "'ul'" }, - "ListboxProps": { "type": { "name": "object" } }, - "loading": { "type": { "name": "bool" }, "default": "false" }, - "loadingText": { "type": { "name": "node" }, "default": "'Loading…'" }, - "multiple": { "type": { "name": "bool" }, "default": "false" }, - "noOptionsText": { "type": { "name": "node" }, "default": "'No options'" }, - "onChange": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onHighlightChange": { "type": { "name": "func" } }, - "onInputChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "openOnFocus": { "type": { "name": "bool" }, "default": "false" }, - "openText": { "type": { "name": "string" }, "default": "'Open'" }, - "PaperComponent": { "type": { "name": "elementType" }, "default": "Paper" }, - "PopperComponent": { "type": { "name": "elementType" }, "default": "Popper" }, - "popupIcon": { "type": { "name": "node" }, "default": "" }, - "readOnly": { "type": { "name": "bool" }, "default": "false" }, - "renderGroup": { "type": { "name": "func" } }, - "renderOption": { "type": { "name": "func" } }, - "renderTags": { "type": { "name": "func" } }, - "selectOnFocus": { "type": { "name": "bool" }, "default": "!props.freeSolo" }, + "default": "(option) => option.label ?? option", + "signature": { "type": "function(option: T) => string", "describedArgs": [] }, + "additionalPropsInfo": {} + }, + "groupBy": { + "type": { "name": "func" }, + "signature": { "type": "function(options: T) => string", "describedArgs": ["options"] }, + "additionalPropsInfo": {} + }, + "handleHomeEndKeys": { + "type": { "name": "bool" }, + "default": "!props.freeSolo", + "additionalPropsInfo": {} + }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "includeInputInList": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "inputValue": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "isOptionEqualToValue": { + "type": { "name": "func" }, + "signature": { + "type": "function(option: T, value: T) => boolean", + "describedArgs": ["option", "value"] + }, + "additionalPropsInfo": {} + }, + "limitTags": { + "type": { "name": "custom", "description": "integer" }, + "default": "-1", + "additionalPropsInfo": {} + }, + "ListboxComponent": { + "type": { "name": "elementType" }, + "default": "'ul'", + "additionalPropsInfo": {} + }, + "ListboxProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "loading": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "loadingText": { + "type": { "name": "node" }, + "default": "'Loading…'", + "additionalPropsInfo": {} + }, + "multiple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "noOptionsText": { + "type": { "name": "node" }, + "default": "'No options'", + "additionalPropsInfo": {} + }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: T | Array, reason: string, details?: string) => void", + "describedArgs": ["event", "value", "reason"] + }, + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "onHighlightChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, option: T, reason: string) => void", + "describedArgs": ["event", "option", "reason"] + }, + "additionalPropsInfo": {} + }, + "onInputChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: string, reason: string) => void", + "describedArgs": ["event", "value", "reason"] + }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "openOnFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "openText": { "type": { "name": "string" }, "default": "'Open'", "additionalPropsInfo": {} }, + "PaperComponent": { + "type": { "name": "elementType" }, + "default": "Paper", + "additionalPropsInfo": {} + }, + "PopperComponent": { + "type": { "name": "elementType" }, + "default": "Popper", + "additionalPropsInfo": {} + }, + "popupIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "readOnly": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "renderGroup": { + "type": { "name": "func" }, + "signature": { + "type": "function(params: AutocompleteRenderGroupParams) => ReactNode", + "describedArgs": ["params"] + }, + "additionalPropsInfo": {} + }, + "renderOption": { + "type": { "name": "func" }, + "signature": { + "type": "function(props: object, option: T, state: object) => ReactNode", + "describedArgs": ["props", "option", "state"] + }, + "additionalPropsInfo": {} + }, + "renderTags": { + "type": { "name": "func" }, + "signature": { + "type": "function(value: Array, getTagProps: function, ownerState: object) => ReactNode", + "describedArgs": ["value", "getTagProps", "ownerState"] + }, + "additionalPropsInfo": {} + }, + "selectOnFocus": { + "type": { "name": "bool" }, + "default": "!props.freeSolo", + "additionalPropsInfo": {} + }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ clearIndicator?: object, paper?: object, popper?: object, popupIndicator?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "custom", "description": "any" } } + "value": { "type": { "name": "custom", "description": "any" }, "additionalPropsInfo": {} } }, "name": "Autocomplete", "styles": { diff --git a/docs/pages/material-ui/api/avatar-group.json b/docs/pages/material-ui/api/avatar-group.json index e16d9249ffbb11..4422a63fea255b 100644 --- a/docs/pages/material-ui/api/avatar-group.json +++ b/docs/pages/material-ui/api/avatar-group.json @@ -1,37 +1,50 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ additionalAvatar?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} + }, + "max": { + "type": { "name": "custom", "description": "number" }, + "default": "5", + "additionalPropsInfo": {} }, - "max": { "type": { "name": "custom", "description": "number" }, "default": "5" }, "slotProps": { "type": { "name": "shape", "description": "{ additionalAvatar?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | number" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "total": { + "type": { "name": "number" }, + "default": "children.length", + "additionalPropsInfo": {} }, - "total": { "type": { "name": "number" }, "default": "children.length" }, "variant": { "type": { "name": "union", "description": "'circular'
    | 'rounded'
    | 'square'
    | string" }, - "default": "'circular'" + "default": "'circular'", + "additionalPropsInfo": {} } }, "name": "AvatarGroup", diff --git a/docs/pages/material-ui/api/avatar.json b/docs/pages/material-ui/api/avatar.json index 3d8684f62704a8..9666eec02bf4ef 100644 --- a/docs/pages/material-ui/api/avatar.json +++ b/docs/pages/material-ui/api/avatar.json @@ -1,25 +1,27 @@ { "props": { - "alt": { "type": { "name": "string" } }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "imgProps": { "type": { "name": "object" } }, - "sizes": { "type": { "name": "string" } }, - "src": { "type": { "name": "string" } }, - "srcSet": { "type": { "name": "string" } }, + "alt": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "imgProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "sizes": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "src": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "srcSet": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'circular'
    | 'rounded'
    | 'square'
    | string" }, - "default": "'circular'" + "default": "'circular'", + "additionalPropsInfo": {} } }, "name": "Avatar", diff --git a/docs/pages/material-ui/api/backdrop.json b/docs/pages/material-ui/api/backdrop.json index 05362e10b53693..1131528725ca21 100644 --- a/docs/pages/material-ui/api/backdrop.json +++ b/docs/pages/material-ui/api/backdrop.json @@ -1,38 +1,48 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "invisible": { "type": { "name": "bool" }, "default": "false" }, + "invisible": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Fade", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Fade" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" - } + }, + "additionalPropsInfo": {} } }, "name": "Backdrop", diff --git a/docs/pages/material-ui/api/badge.json b/docs/pages/material-ui/api/badge.json index 11ee10b561f9ba..a9f639c8d199e4 100644 --- a/docs/pages/material-ui/api/badge.json +++ b/docs/pages/material-ui/api/badge.json @@ -5,60 +5,69 @@ "name": "shape", "description": "{ horizontal: 'left'
    | 'right', vertical: 'bottom'
    | 'top' }" }, - "default": "{\n vertical: 'top',\n horizontal: 'right',\n}" + "default": "{\n vertical: 'top',\n horizontal: 'right',\n}", + "additionalPropsInfo": {} }, - "badgeContent": { "type": { "name": "node" } }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "badgeContent": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'default'" + "default": "'default'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Badge?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ badge?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "invisible": { "type": { "name": "bool" }, "default": "false" }, - "max": { "type": { "name": "number" }, "default": "99" }, + "invisible": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "max": { "type": { "name": "number" }, "default": "99", "additionalPropsInfo": {} }, "overlap": { "type": { "name": "enum", "description": "'circular'
    | 'rectangular'" }, - "default": "'rectangular'" + "default": "'rectangular'", + "additionalPropsInfo": {} }, - "showZero": { "type": { "name": "bool" }, "default": "false" }, + "showZero": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ badge?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ badge?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'dot'
    | 'standard'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} } }, "name": "Badge", diff --git a/docs/pages/material-ui/api/bottom-navigation-action.json b/docs/pages/material-ui/api/bottom-navigation-action.json index dbf5084ea2f051..5be8fab8043e58 100644 --- a/docs/pages/material-ui/api/bottom-navigation-action.json +++ b/docs/pages/material-ui/api/bottom-navigation-action.json @@ -1,17 +1,21 @@ { "props": { - "children": { "type": { "name": "custom", "description": "unsupportedProp" } }, - "classes": { "type": { "name": "object" } }, - "icon": { "type": { "name": "node" } }, - "label": { "type": { "name": "node" } }, - "showLabel": { "type": { "name": "bool" } }, + "children": { + "type": { "name": "custom", "description": "unsupportedProp" }, + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "showLabel": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "BottomNavigationAction", "styles": { diff --git a/docs/pages/material-ui/api/bottom-navigation.json b/docs/pages/material-ui/api/bottom-navigation.json index 30142ef5afbc60..564391e1591f9c 100644 --- a/docs/pages/material-ui/api/bottom-navigation.json +++ b/docs/pages/material-ui/api/bottom-navigation.json @@ -1,17 +1,25 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "onChange": { "type": { "name": "func" } }, - "showLabels": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: any) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "showLabels": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "BottomNavigation", "styles": { "classes": ["root"], "globalClasses": {}, "name": "MuiBottomNavigation" }, diff --git a/docs/pages/material-ui/api/box.json b/docs/pages/material-ui/api/box.json index 20015b70cfd914..cec09436edbdb0 100644 --- a/docs/pages/material-ui/api/box.json +++ b/docs/pages/material-ui/api/box.json @@ -1,11 +1,12 @@ { "props": { - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Box", diff --git a/docs/pages/material-ui/api/breadcrumbs.json b/docs/pages/material-ui/api/breadcrumbs.json index c35a1eca6cf8ac..7d4a440f7bb6c9 100644 --- a/docs/pages/material-ui/api/breadcrumbs.json +++ b/docs/pages/material-ui/api/breadcrumbs.json @@ -1,32 +1,45 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "expandText": { "type": { "name": "string" }, "default": "'Show path'" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "expandText": { + "type": { "name": "string" }, + "default": "'Show path'", + "additionalPropsInfo": {} + }, "itemsAfterCollapse": { "type": { "name": "custom", "description": "integer" }, - "default": "1" + "default": "1", + "additionalPropsInfo": {} }, "itemsBeforeCollapse": { "type": { "name": "custom", "description": "integer" }, - "default": "1" + "default": "1", + "additionalPropsInfo": {} + }, + "maxItems": { + "type": { "name": "custom", "description": "integer" }, + "default": "8", + "additionalPropsInfo": {} }, - "maxItems": { "type": { "name": "custom", "description": "integer" }, "default": "8" }, - "separator": { "type": { "name": "node" }, "default": "'/'" }, + "separator": { "type": { "name": "node" }, "default": "'/'", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ collapsedIcon?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ CollapsedIcon?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Breadcrumbs", diff --git a/docs/pages/material-ui/api/button-base.json b/docs/pages/material-ui/api/button-base.json index 46e919e73b50e0..7aabdfb11dba2e 100644 --- a/docs/pages/material-ui/api/button-base.json +++ b/docs/pages/material-ui/api/button-base.json @@ -1,29 +1,42 @@ { "props": { - "action": { "type": { "name": "custom", "description": "ref" } }, - "centerRipple": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "custom", "description": "element type" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableTouchRipple": { "type": { "name": "bool" }, "default": "false" }, - "focusRipple": { "type": { "name": "bool" }, "default": "false" }, - "focusVisibleClassName": { "type": { "name": "string" } }, - "LinkComponent": { "type": { "name": "elementType" }, "default": "'a'" }, - "onFocusVisible": { "type": { "name": "func" } }, + "action": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "centerRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { + "type": { "name": "custom", "description": "element type" }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableTouchRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "focusRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "LinkComponent": { + "type": { "name": "elementType" }, + "default": "'a'", + "additionalPropsInfo": {} + }, + "onFocusVisible": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "TouchRippleProps": { "type": { "name": "object" } }, + "TouchRippleProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "touchRippleRef": { "type": { "name": "union", "description": "func
    | { current?: { pulsate: func, start: func, stop: func } }" - } + }, + "additionalPropsInfo": {} } }, "name": "ButtonBase", diff --git a/docs/pages/material-ui/api/button-group.json b/docs/pages/material-ui/api/button-group.json index a43472a30cc9b6..fcd10d3bd7ee2d 100644 --- a/docs/pages/material-ui/api/button-group.json +++ b/docs/pages/material-ui/api/button-group.json @@ -1,43 +1,56 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableElevation": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableElevation": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": {} } }, "name": "ButtonGroup", diff --git a/docs/pages/material-ui/api/button.json b/docs/pages/material-ui/api/button.json index 097276101c6dc0..c54d54703000d5 100644 --- a/docs/pages/material-ui/api/button.json +++ b/docs/pages/material-ui/api/button.json @@ -1,42 +1,54 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'error'
    | 'info'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableElevation": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "endIcon": { "type": { "name": "node" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "href": { "type": { "name": "string" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableElevation": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "href": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, - "startIcon": { "type": { "name": "node" } }, + "startIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} } }, "name": "Button", diff --git a/docs/pages/material-ui/api/card-action-area.json b/docs/pages/material-ui/api/card-action-area.json index 899f66cd179cef..1ff136187e454d 100644 --- a/docs/pages/material-ui/api/card-action-area.json +++ b/docs/pages/material-ui/api/card-action-area.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardActionArea", diff --git a/docs/pages/material-ui/api/card-actions.json b/docs/pages/material-ui/api/card-actions.json index f5cbba5c1161df..76e06803435073 100644 --- a/docs/pages/material-ui/api/card-actions.json +++ b/docs/pages/material-ui/api/card-actions.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableSpacing": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableSpacing": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardActions", diff --git a/docs/pages/material-ui/api/card-content.json b/docs/pages/material-ui/api/card-content.json index b13c804ab2e34f..012248a6fd846b 100644 --- a/docs/pages/material-ui/api/card-content.json +++ b/docs/pages/material-ui/api/card-content.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardContent", diff --git a/docs/pages/material-ui/api/card-header.json b/docs/pages/material-ui/api/card-header.json index 17256a7f16ad04..dbc9b33f2913d2 100644 --- a/docs/pages/material-ui/api/card-header.json +++ b/docs/pages/material-ui/api/card-header.json @@ -1,20 +1,25 @@ { "props": { - "action": { "type": { "name": "node" } }, - "avatar": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disableTypography": { "type": { "name": "bool" }, "default": "false" }, - "subheader": { "type": { "name": "node" } }, - "subheaderTypographyProps": { "type": { "name": "object" } }, + "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "avatar": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableTypography": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "subheader": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "subheaderTypographyProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "title": { "type": { "name": "node" } }, - "titleTypographyProps": { "type": { "name": "object" } } + "title": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "titleTypographyProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "CardHeader", "styles": { diff --git a/docs/pages/material-ui/api/card-media.json b/docs/pages/material-ui/api/card-media.json index bd95ae13cd32a4..f68febe28987b4 100644 --- a/docs/pages/material-ui/api/card-media.json +++ b/docs/pages/material-ui/api/card-media.json @@ -1,15 +1,16 @@ { "props": { - "children": { "type": { "name": "custom", "description": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "image": { "type": { "name": "string" } }, - "src": { "type": { "name": "string" } }, + "children": { "type": { "name": "custom", "description": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "image": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "src": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "CardMedia", diff --git a/docs/pages/material-ui/api/card.json b/docs/pages/material-ui/api/card.json index 54b32a8381e9ce..14fcf2b2a041f1 100644 --- a/docs/pages/material-ui/api/card.json +++ b/docs/pages/material-ui/api/card.json @@ -1,13 +1,18 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "raised": { "type": { "name": "custom", "description": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "raised": { + "type": { "name": "custom", "description": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Card", diff --git a/docs/pages/material-ui/api/checkbox.json b/docs/pages/material-ui/api/checkbox.json index 96e1201b9dbf92..a5ada5fa32e638 100644 --- a/docs/pages/material-ui/api/checkbox.json +++ b/docs/pages/material-ui/api/checkbox.json @@ -1,40 +1,62 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "checkedIcon": { "type": { "name": "node" }, "default": "" }, - "classes": { "type": { "name": "object" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "checkedIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} + }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "indeterminate": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "indeterminateIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" }, "default": "" }, - "id": { "type": { "name": "string" } }, - "indeterminate": { "type": { "name": "bool" }, "default": "false" }, - "indeterminateIcon": { "type": { "name": "node" }, "default": "" }, - "inputProps": { "type": { "name": "object" } }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "onChange": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Checkbox", "styles": { diff --git a/docs/pages/material-ui/api/chip.json b/docs/pages/material-ui/api/chip.json index 5786b39689287d..2735c0665a2fe1 100644 --- a/docs/pages/material-ui/api/chip.json +++ b/docs/pages/material-ui/api/chip.json @@ -1,42 +1,53 @@ { "props": { - "avatar": { "type": { "name": "element" } }, - "children": { "type": { "name": "custom", "description": "unsupportedProp" } }, - "classes": { "type": { "name": "object" } }, - "clickable": { "type": { "name": "bool" } }, + "avatar": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "children": { + "type": { "name": "custom", "description": "unsupportedProp" }, + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "clickable": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'default'" + "default": "'default'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "deleteIcon": { "type": { "name": "element" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "element" } }, - "label": { "type": { "name": "node" } }, - "onDelete": { "type": { "name": "func" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "deleteIcon": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "onDelete": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} + }, + "skipFocusWhenDisabled": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "skipFocusWhenDisabled": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'filled'
    | 'outlined'
    | string" }, - "default": "'filled'" + "default": "'filled'", + "additionalPropsInfo": {} } }, "name": "Chip", diff --git a/docs/pages/material-ui/api/circular-progress.json b/docs/pages/material-ui/api/circular-progress.json index 3d4dde19fd83a7..e6ceea65650767 100644 --- a/docs/pages/material-ui/api/circular-progress.json +++ b/docs/pages/material-ui/api/circular-progress.json @@ -1,29 +1,37 @@ { "props": { - "classes": { "type": { "name": "object" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} + }, + "disableShrink": { + "type": { "name": "custom", "description": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "disableShrink": { "type": { "name": "custom", "description": "bool" }, "default": "false" }, "size": { "type": { "name": "union", "description": "number
    | string" }, - "default": "40" + "default": "40", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "thickness": { "type": { "name": "number" }, "default": "3.6" }, - "value": { "type": { "name": "number" }, "default": "0" }, + "thickness": { "type": { "name": "number" }, "default": "3.6", "additionalPropsInfo": {} }, + "value": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'determinate'
    | 'indeterminate'" }, - "default": "'indeterminate'" + "default": "'indeterminate'", + "additionalPropsInfo": {} } }, "name": "CircularProgress", diff --git a/docs/pages/material-ui/api/collapse.json b/docs/pages/material-ui/api/collapse.json index 56d7fd6dd79099..59fce18e636536 100644 --- a/docs/pages/material-ui/api/collapse.json +++ b/docs/pages/material-ui/api/collapse.json @@ -1,36 +1,44 @@ { "props": { - "addEndListener": { "type": { "name": "func" } }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "collapsedSize": { "type": { "name": "union", "description": "number
    | string" }, - "default": "'0px'" + "default": "'0px'", + "additionalPropsInfo": {} + }, + "component": { + "type": { "name": "custom", "description": "element type" }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "custom", "description": "element type" } }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" - } + }, + "additionalPropsInfo": {} }, - "in": { "type": { "name": "bool" } }, + "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'vertical'" + "default": "'vertical'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "timeout": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "duration.standard" + "default": "duration.standard", + "additionalPropsInfo": {} } }, "name": "Collapse", diff --git a/docs/pages/material-ui/api/container.json b/docs/pages/material-ui/api/container.json index 7ca1f2bc557785..744cd10352d53b 100644 --- a/docs/pages/material-ui/api/container.json +++ b/docs/pages/material-ui/api/container.json @@ -1,20 +1,22 @@ { "props": { - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disableGutters": { "type": { "name": "bool" } }, - "fixed": { "type": { "name": "bool" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fixed": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "maxWidth": { "type": { "name": "union", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | false
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Container", diff --git a/docs/pages/material-ui/api/css-baseline.json b/docs/pages/material-ui/api/css-baseline.json index d28505ded669b7..d15fad14a906ce 100644 --- a/docs/pages/material-ui/api/css-baseline.json +++ b/docs/pages/material-ui/api/css-baseline.json @@ -1,7 +1,11 @@ { "props": { - "children": { "type": { "name": "node" } }, - "enableColorScheme": { "type": { "name": "bool" }, "default": "false" } + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "enableColorScheme": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + } }, "name": "CssBaseline", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/dialog-actions.json b/docs/pages/material-ui/api/dialog-actions.json index e1082ae315dc53..6232eb08a31569 100644 --- a/docs/pages/material-ui/api/dialog-actions.json +++ b/docs/pages/material-ui/api/dialog-actions.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableSpacing": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableSpacing": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "DialogActions", diff --git a/docs/pages/material-ui/api/dialog-content-text.json b/docs/pages/material-ui/api/dialog-content-text.json index 96fd78ee9135d6..44fbbe7e7720d6 100644 --- a/docs/pages/material-ui/api/dialog-content-text.json +++ b/docs/pages/material-ui/api/dialog-content-text.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "DialogContentText", diff --git a/docs/pages/material-ui/api/dialog-content.json b/docs/pages/material-ui/api/dialog-content.json index 59d41c9e37354a..237d4e64ae00b0 100644 --- a/docs/pages/material-ui/api/dialog-content.json +++ b/docs/pages/material-ui/api/dialog-content.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "dividers": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "dividers": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "DialogContent", diff --git a/docs/pages/material-ui/api/dialog-title.json b/docs/pages/material-ui/api/dialog-title.json index 6727e3ccd3793d..acf353d0ddbd2e 100644 --- a/docs/pages/material-ui/api/dialog-title.json +++ b/docs/pages/material-ui/api/dialog-title.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "DialogTitle", diff --git a/docs/pages/material-ui/api/dialog.json b/docs/pages/material-ui/api/dialog.json index e159699fba1e28..e1a4338c1602f9 100644 --- a/docs/pages/material-ui/api/dialog.json +++ b/docs/pages/material-ui/api/dialog.json @@ -1,53 +1,78 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, - "aria-describedby": { "type": { "name": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "aria-describedby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "BackdropComponent": { "type": { "name": "elementType" }, "default": "styled(Backdrop, {\n name: 'MuiModal',\n slot: 'Backdrop',\n overridesResolver: (props, styles) => {\n return styles.backdrop;\n },\n})({\n zIndex: -1,\n})", "deprecated": true, - "deprecationInfo": "Use slots.backdrop instead. While this prop currently works, it will be removed in the next major version." + "deprecationInfo": "Use slots.backdrop instead. While this prop currently works, it will be removed in the next major version.", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" }, - "fullScreen": { "type": { "name": "bool" }, "default": "false" }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableEscapeKeyDown": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "fullScreen": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "maxWidth": { "type": { "name": "union", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | false
    | string" }, - "default": "'sm'" + "default": "'sm'", + "additionalPropsInfo": {} }, "onBackdropClick": { "type": { "name": "func" }, "deprecated": true, - "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events." + "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events.", + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, - "PaperComponent": { "type": { "name": "elementType" }, "default": "Paper" }, - "PaperProps": { "type": { "name": "object" }, "default": "{}" }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "PaperComponent": { + "type": { "name": "elementType" }, + "default": "Paper", + "additionalPropsInfo": {} + }, + "PaperProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, "scroll": { "type": { "name": "enum", "description": "'body'
    | 'paper'" }, - "default": "'paper'" + "default": "'paper'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Fade", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Fade" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "Dialog", "styles": { diff --git a/docs/pages/material-ui/api/divider.json b/docs/pages/material-ui/api/divider.json index 25fdf52e0d1540..f1805831095c44 100644 --- a/docs/pages/material-ui/api/divider.json +++ b/docs/pages/material-ui/api/divider.json @@ -1,34 +1,38 @@ { "props": { - "absolute": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "flexItem": { "type": { "name": "bool" }, "default": "false" }, - "light": { "type": { "name": "bool" }, "default": "false" }, + "absolute": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "flexItem": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "light": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "textAlign": { "type": { "name": "enum", "description": "'center'
    | 'left'
    | 'right'" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'fullWidth'
    | 'inset'
    | 'middle'
    | string" }, - "default": "'fullWidth'" + "default": "'fullWidth'", + "additionalPropsInfo": {} } }, "name": "Divider", diff --git a/docs/pages/material-ui/api/drawer.json b/docs/pages/material-ui/api/drawer.json index c574db5c704e17..cd8b4ae685b593 100644 --- a/docs/pages/material-ui/api/drawer.json +++ b/docs/pages/material-ui/api/drawer.json @@ -5,36 +5,48 @@ "name": "enum", "description": "'bottom'
    | 'left'
    | 'right'
    | 'top'" }, - "default": "'left'" + "default": "'left'", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "elevation": { "type": { "name": "custom", "description": "integer" }, "default": "16" }, - "hideBackdrop": { "type": { "name": "bool" }, "default": "false" }, - "ModalProps": { "type": { "name": "object" }, "default": "{}" }, - "onClose": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" }, "default": "false" }, - "PaperProps": { "type": { "name": "object" }, "default": "{}" }, - "SlideProps": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "elevation": { + "type": { "name": "custom", "description": "integer" }, + "default": "16", + "additionalPropsInfo": {} + }, + "hideBackdrop": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "ModalProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "PaperProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "SlideProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'permanent'
    | 'persistent'
    | 'temporary'" }, - "default": "'temporary'" + "default": "'temporary'", + "additionalPropsInfo": {} } }, "name": "Drawer", diff --git a/docs/pages/material-ui/api/fab.json b/docs/pages/material-ui/api/fab.json index 51f718abf50cc4..2ab459bac4aef7 100644 --- a/docs/pages/material-ui/api/fab.json +++ b/docs/pages/material-ui/api/fab.json @@ -1,38 +1,46 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'error'
    | 'info'
    | 'inherit'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'default'" + "default": "'default'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" } }, - "href": { "type": { "name": "string" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "href": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'large'" + "default": "'large'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'circular'
    | 'extended'
    | string" }, - "default": "'circular'" + "default": "'circular'", + "additionalPropsInfo": {} } }, "name": "Fab", diff --git a/docs/pages/material-ui/api/fade.json b/docs/pages/material-ui/api/fade.json index 07b3721acff627..84963d9638559d 100644 --- a/docs/pages/material-ui/api/fade.json +++ b/docs/pages/material-ui/api/fade.json @@ -1,21 +1,27 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "addEndListener": { "type": { "name": "func" } }, - "appear": { "type": { "name": "bool" }, "default": "true" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" - } + }, + "additionalPropsInfo": {} }, - "in": { "type": { "name": "bool" } }, + "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "timeout": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} } }, "name": "Fade", diff --git a/docs/pages/material-ui/api/filled-input.json b/docs/pages/material-ui/api/filled-input.json index b26619675340ad..e3fabe8774df40 100644 --- a/docs/pages/material-ui/api/filled-input.json +++ b/docs/pages/material-ui/api/filled-input.json @@ -1,60 +1,89 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" - } + }, + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} + }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableUnderline": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "hiddenLabel": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputComponent": { + "type": { "name": "elementType" }, + "default": "'input'", + "additionalPropsInfo": {} + }, + "inputProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "margin": { + "type": { "name": "enum", "description": "'dense'
    | 'none'" }, + "additionalPropsInfo": {} + }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "disableUnderline": { "type": { "name": "bool" } }, - "endAdornment": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "hiddenLabel": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, - "inputComponent": { "type": { "name": "elementType" }, "default": "'input'" }, - "inputProps": { "type": { "name": "object" }, "default": "{}" }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'" } }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "string" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, - "rows": { "type": { "name": "union", "description": "number
    | string" } }, "slotProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "startAdornment": { "type": { "name": "node" } }, + "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "default": "'text'" }, - "value": { "type": { "name": "any" } } + "type": { "type": { "name": "string" }, "default": "'text'", "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "FilledInput", "styles": { diff --git a/docs/pages/material-ui/api/form-control-label.json b/docs/pages/material-ui/api/form-control-label.json index 58d7aea55a2197..7b76fa9e4bb556 100644 --- a/docs/pages/material-ui/api/form-control-label.json +++ b/docs/pages/material-ui/api/form-control-label.json @@ -1,36 +1,47 @@ { "props": { - "control": { "type": { "name": "element" }, "required": true }, - "checked": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, + "control": { "type": { "name": "element" }, "required": true, "additionalPropsInfo": {} }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "componentsProps": { "type": { "name": "shape", "description": "{ typography?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" } }, - "disableTypography": { "type": { "name": "bool" } }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "label": { "type": { "name": "node" } }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableTypography": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "labelPlacement": { "type": { "name": "enum", "description": "'bottom'
    | 'end'
    | 'start'
    | 'top'" }, - "default": "'end'" + "default": "'end'", + "additionalPropsInfo": {} }, - "onChange": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" } }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ typography?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "FormControlLabel", "styles": { diff --git a/docs/pages/material-ui/api/form-control.json b/docs/pages/material-ui/api/form-control.json index 0973b2ea6213a1..938991e870299d 100644 --- a/docs/pages/material-ui/api/form-control.json +++ b/docs/pages/material-ui/api/form-control.json @@ -1,47 +1,52 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "focused": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "hiddenLabel": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focused": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "hiddenLabel": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'
    | 'normal'" }, - "default": "'none'" + "default": "'none'", + "additionalPropsInfo": {} }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": {} } }, "name": "FormControl", diff --git a/docs/pages/material-ui/api/form-group.json b/docs/pages/material-ui/api/form-group.json index ede71c6b0e2519..13651f3207566f 100644 --- a/docs/pages/material-ui/api/form-group.json +++ b/docs/pages/material-ui/api/form-group.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "row": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "row": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "FormGroup", diff --git a/docs/pages/material-ui/api/form-helper-text.json b/docs/pages/material-ui/api/form-helper-text.json index 5fb6eaba1ab54e..7667289ca55e0b 100644 --- a/docs/pages/material-ui/api/form-helper-text.json +++ b/docs/pages/material-ui/api/form-helper-text.json @@ -1,25 +1,27 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" } }, - "error": { "type": { "name": "bool" } }, - "filled": { "type": { "name": "bool" } }, - "focused": { "type": { "name": "bool" } }, - "margin": { "type": { "name": "enum", "description": "'dense'" } }, - "required": { "type": { "name": "bool" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "filled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "focused": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "margin": { "type": { "name": "enum", "description": "'dense'" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'filled'
    | 'outlined'
    | 'standard'
    | string" - } + }, + "additionalPropsInfo": {} } }, "name": "FormHelperText", diff --git a/docs/pages/material-ui/api/form-label.json b/docs/pages/material-ui/api/form-label.json index bbdedf945470c0..82ba6dc8a6626b 100644 --- a/docs/pages/material-ui/api/form-label.json +++ b/docs/pages/material-ui/api/form-label.json @@ -1,24 +1,26 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'error'
    | 'info'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" } }, - "error": { "type": { "name": "bool" } }, - "filled": { "type": { "name": "bool" } }, - "focused": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "filled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "focused": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "FormLabel", diff --git a/docs/pages/material-ui/api/global-styles.json b/docs/pages/material-ui/api/global-styles.json index 1ef82dcf97df75..97c180f7bd62bb 100644 --- a/docs/pages/material-ui/api/global-styles.json +++ b/docs/pages/material-ui/api/global-styles.json @@ -4,7 +4,8 @@ "type": { "name": "union", "description": "array
    | func
    | number
    | object
    | string
    | bool" - } + }, + "additionalPropsInfo": {} } }, "name": "GlobalStyles", diff --git a/docs/pages/material-ui/api/grid.json b/docs/pages/material-ui/api/grid.json index be19baca79e339..8a2b28140b15c4 100644 --- a/docs/pages/material-ui/api/grid.json +++ b/docs/pages/material-ui/api/grid.json @@ -1,92 +1,104 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "columns": { "type": { "name": "union", "description": "Array<number>
    | number
    | object" }, - "default": "12" + "default": "12", + "additionalPropsInfo": {} }, "columnSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "container": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "container": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" }, - "default": "'row'" + "default": "'row'", + "additionalPropsInfo": {} }, - "item": { "type": { "name": "bool" }, "default": "false" }, + "item": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "lg": { "type": { "name": "union", "description": "'auto'
    | number
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, "md": { "type": { "name": "union", "description": "'auto'
    | number
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, "rowSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "sm": { "type": { "name": "union", "description": "'auto'
    | number
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" }, - "default": "0" + "default": "0", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "wrap": { "type": { "name": "enum", "description": "'nowrap'
    | 'wrap-reverse'
    | 'wrap'" }, - "default": "'wrap'" + "default": "'wrap'", + "additionalPropsInfo": {} }, "xl": { "type": { "name": "union", "description": "'auto'
    | number
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, "xs": { "type": { "name": "union", "description": "'auto'
    | number
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, - "zeroMinWidth": { "type": { "name": "bool" }, "default": "false" } + "zeroMinWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Grid", "styles": { diff --git a/docs/pages/material-ui/api/grow.json b/docs/pages/material-ui/api/grow.json index c5d8cb37372111..e97ef4756cc831 100644 --- a/docs/pages/material-ui/api/grow.json +++ b/docs/pages/material-ui/api/grow.json @@ -1,21 +1,27 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "addEndListener": { "type": { "name": "func" } }, - "appear": { "type": { "name": "bool" }, "default": "true" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" - } + }, + "additionalPropsInfo": {} }, - "in": { "type": { "name": "bool" } }, + "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "timeout": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} } }, "name": "Grow", diff --git a/docs/pages/material-ui/api/hidden.json b/docs/pages/material-ui/api/hidden.json index e4d3b3206a4cd1..e4fddf9c14f5e9 100644 --- a/docs/pages/material-ui/api/hidden.json +++ b/docs/pages/material-ui/api/hidden.json @@ -1,32 +1,35 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "implementation": { "type": { "name": "enum", "description": "'css'
    | 'js'" }, - "default": "'js'" + "default": "'js'", + "additionalPropsInfo": {} }, "initialWidth": { "type": { "name": "enum", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'" - } + }, + "additionalPropsInfo": {} }, - "lgDown": { "type": { "name": "bool" }, "default": "false" }, - "lgUp": { "type": { "name": "bool" }, "default": "false" }, - "mdDown": { "type": { "name": "bool" }, "default": "false" }, - "mdUp": { "type": { "name": "bool" }, "default": "false" }, + "lgDown": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "lgUp": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "mdDown": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "mdUp": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "only": { "type": { "name": "union", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | Array<'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'>" - } + }, + "additionalPropsInfo": {} }, - "smDown": { "type": { "name": "bool" }, "default": "false" }, - "smUp": { "type": { "name": "bool" }, "default": "false" }, - "xlDown": { "type": { "name": "bool" }, "default": "false" }, - "xlUp": { "type": { "name": "bool" }, "default": "false" }, - "xsDown": { "type": { "name": "bool" }, "default": "false" }, - "xsUp": { "type": { "name": "bool" }, "default": "false" } + "smDown": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "smUp": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "xlDown": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "xlUp": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "xsDown": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "xsUp": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Hidden", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/icon-button.json b/docs/pages/material-ui/api/icon-button.json index a207f0d7b7155a..cc70ed550d5e0d 100644 --- a/docs/pages/material-ui/api/icon-button.json +++ b/docs/pages/material-ui/api/icon-button.json @@ -1,36 +1,44 @@ { "props": { - "children": { "type": { "name": "custom", "description": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "custom", "description": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'default'" + "default": "'default'", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "edge": { "type": { "name": "enum", "description": "'end'
    | 'start'
    | false" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "IconButton", diff --git a/docs/pages/material-ui/api/icon.json b/docs/pages/material-ui/api/icon.json index 7ed10e34ee7993..8342c116abcbe2 100644 --- a/docs/pages/material-ui/api/icon.json +++ b/docs/pages/material-ui/api/icon.json @@ -1,28 +1,35 @@ { "props": { - "baseClassName": { "type": { "name": "string" }, "default": "'material-icons'" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "baseClassName": { + "type": { "name": "string" }, + "default": "'material-icons'", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'action'
    | 'disabled'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "fontSize": { "type": { "name": "union", "description": "'inherit'
    | 'large'
    | 'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Icon", diff --git a/docs/pages/material-ui/api/image-list-item-bar.json b/docs/pages/material-ui/api/image-list-item-bar.json index ec4297bd1b903e..514b5b371c343c 100644 --- a/docs/pages/material-ui/api/image-list-item-bar.json +++ b/docs/pages/material-ui/api/image-list-item-bar.json @@ -1,26 +1,29 @@ { "props": { - "actionIcon": { "type": { "name": "node" } }, + "actionIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "actionPosition": { "type": { "name": "enum", "description": "'left'
    | 'right'" }, - "default": "'right'" + "default": "'right'", + "additionalPropsInfo": {} }, - "classes": { "type": { "name": "object" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "position": { "type": { "name": "enum", "description": "'below'
    | 'bottom'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, - "subtitle": { "type": { "name": "node" } }, + "subtitle": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "title": { "type": { "name": "node" } } + "title": { "type": { "name": "node" }, "additionalPropsInfo": {} } }, "name": "ImageListItemBar", "styles": { diff --git a/docs/pages/material-ui/api/image-list-item.json b/docs/pages/material-ui/api/image-list-item.json index cd0cb819c1eba0..810c0ba8d9d1c4 100644 --- a/docs/pages/material-ui/api/image-list-item.json +++ b/docs/pages/material-ui/api/image-list-item.json @@ -1,15 +1,24 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "cols": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, - "component": { "type": { "name": "elementType" } }, - "rows": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "cols": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} + }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ImageListItem", diff --git a/docs/pages/material-ui/api/image-list.json b/docs/pages/material-ui/api/image-list.json index 748d8c39884f80..2c2445ad5a1048 100644 --- a/docs/pages/material-ui/api/image-list.json +++ b/docs/pages/material-ui/api/image-list.json @@ -1,26 +1,33 @@ { "props": { - "children": { "type": { "name": "node" }, "required": true }, - "classes": { "type": { "name": "object" } }, - "cols": { "type": { "name": "custom", "description": "integer" }, "default": "2" }, - "component": { "type": { "name": "elementType" } }, - "gap": { "type": { "name": "number" }, "default": "4" }, + "children": { "type": { "name": "node" }, "required": true, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "cols": { + "type": { "name": "custom", "description": "integer" }, + "default": "2", + "additionalPropsInfo": {} + }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "gap": { "type": { "name": "number" }, "default": "4", "additionalPropsInfo": {} }, "rowHeight": { "type": { "name": "union", "description": "'auto'
    | number" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'masonry'
    | 'quilted'
    | 'standard'
    | 'woven'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} } }, "name": "ImageList", diff --git a/docs/pages/material-ui/api/input-adornment.json b/docs/pages/material-ui/api/input-adornment.json index e8c8d7de3bf109..432c30344c265a 100644 --- a/docs/pages/material-ui/api/input-adornment.json +++ b/docs/pages/material-ui/api/input-adornment.json @@ -2,24 +2,35 @@ "props": { "position": { "type": { "name": "enum", "description": "'end'
    | 'start'" }, - "required": true + "required": true, + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disablePointerEvents": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableTypography": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disablePointerEvents": { "type": { "name": "bool" }, "default": "false" }, - "disableTypography": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" - } + }, + "additionalPropsInfo": {} } }, "name": "InputAdornment", diff --git a/docs/pages/material-ui/api/input-base.json b/docs/pages/material-ui/api/input-base.json index 9c9d63361bac90..293a35fe2440ee 100644 --- a/docs/pages/material-ui/api/input-base.json +++ b/docs/pages/material-ui/api/input-base.json @@ -1,70 +1,101 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "disableInjectingGlobalStyles": { "type": { "name": "bool" }, "default": "false" }, - "endAdornment": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableInjectingGlobalStyles": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "inputComponent": { "type": { "name": "custom", "description": "element type" }, - "default": "'input'" + "default": "'input'", + "additionalPropsInfo": {} + }, + "inputProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "margin": { + "type": { "name": "enum", "description": "'dense'
    | 'none'" }, + "additionalPropsInfo": {} + }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onBlur": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "onInvalid": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "default": "{}" }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'" } }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onBlur": { "type": { "name": "func" } }, - "onChange": { "type": { "name": "func" } }, - "onInvalid": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "string" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, - "rows": { "type": { "name": "union", "description": "number
    | string" } }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" - } + }, + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "startAdornment": { "type": { "name": "node" } }, + "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "default": "'text'" }, - "value": { "type": { "name": "any" } } + "type": { "type": { "name": "string" }, "default": "'text'", "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "InputBase", "styles": { diff --git a/docs/pages/material-ui/api/input-label.json b/docs/pages/material-ui/api/input-label.json index c6825c7c40d139..bdaeb2fa2d1fb7 100644 --- a/docs/pages/material-ui/api/input-label.json +++ b/docs/pages/material-ui/api/input-label.json @@ -1,38 +1,46 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'error'
    | 'info'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'warning'
    | string" - } + }, + "additionalPropsInfo": {} + }, + "disableAnimation": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "disableAnimation": { "type": { "name": "bool" }, "default": "false" }, - "disabled": { "type": { "name": "bool" } }, - "error": { "type": { "name": "bool" } }, - "focused": { "type": { "name": "bool" } }, - "margin": { "type": { "name": "enum", "description": "'dense'" } }, - "required": { "type": { "name": "bool" } }, - "shrink": { "type": { "name": "bool" } }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "focused": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "margin": { "type": { "name": "enum", "description": "'dense'" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "shrink": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'normal'
    | 'small'
    | string" }, - "default": "'normal'" + "default": "'normal'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" - } + }, + "additionalPropsInfo": {} } }, "name": "InputLabel", diff --git a/docs/pages/material-ui/api/input.json b/docs/pages/material-ui/api/input.json index 319f57dcdcb0fe..da667f65438751 100644 --- a/docs/pages/material-ui/api/input.json +++ b/docs/pages/material-ui/api/input.json @@ -1,59 +1,88 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" - } + }, + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} + }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableUnderline": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputComponent": { + "type": { "name": "elementType" }, + "default": "'input'", + "additionalPropsInfo": {} + }, + "inputProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "margin": { + "type": { "name": "enum", "description": "'dense'
    | 'none'" }, + "additionalPropsInfo": {} + }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "disableUnderline": { "type": { "name": "bool" } }, - "endAdornment": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, - "inputComponent": { "type": { "name": "elementType" }, "default": "'input'" }, - "inputProps": { "type": { "name": "object" }, "default": "{}" }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'" } }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "string" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, - "rows": { "type": { "name": "union", "description": "number
    | string" } }, "slotProps": { "type": { "name": "shape", "description": "{ input?: object, root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "startAdornment": { "type": { "name": "node" } }, + "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "default": "'text'" }, - "value": { "type": { "name": "any" } } + "type": { "type": { "name": "string" }, "default": "'text'", "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Input", "styles": { diff --git a/docs/pages/material-ui/api/linear-progress.json b/docs/pages/material-ui/api/linear-progress.json index 39768364b0ed36..67972fb0cdc1b2 100644 --- a/docs/pages/material-ui/api/linear-progress.json +++ b/docs/pages/material-ui/api/linear-progress.json @@ -1,27 +1,30 @@ { "props": { - "classes": { "type": { "name": "object" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'primary'
    | 'secondary'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "number" } }, - "valueBuffer": { "type": { "name": "number" } }, + "value": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "valueBuffer": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'buffer'
    | 'determinate'
    | 'indeterminate'
    | 'query'" }, - "default": "'indeterminate'" + "default": "'indeterminate'", + "additionalPropsInfo": {} } }, "name": "LinearProgress", diff --git a/docs/pages/material-ui/api/link.json b/docs/pages/material-ui/api/link.json index 7cb46443895101..2c87f1dd20bd6d 100644 --- a/docs/pages/material-ui/api/link.json +++ b/docs/pages/material-ui/api/link.json @@ -1,29 +1,35 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "color": { "type": { "name": "any" }, "default": "'primary'" }, - "component": { "type": { "name": "custom", "description": "element type" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "color": { "type": { "name": "any" }, "default": "'primary'", "additionalPropsInfo": {} }, + "component": { + "type": { "name": "custom", "description": "element type" }, + "additionalPropsInfo": {} + }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "TypographyClasses": { "type": { "name": "object" } }, + "TypographyClasses": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "underline": { "type": { "name": "enum", "description": "'always'
    | 'hover'
    | 'none'" }, - "default": "'always'" + "default": "'always'", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'body1'
    | 'body2'
    | 'button'
    | 'caption'
    | 'h1'
    | 'h2'
    | 'h3'
    | 'h4'
    | 'h5'
    | 'h6'
    | 'inherit'
    | 'overline'
    | 'subtitle1'
    | 'subtitle2'
    | string" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": {} } }, "name": "Link", diff --git a/docs/pages/material-ui/api/list-item-avatar.json b/docs/pages/material-ui/api/list-item-avatar.json index adf4e4ff338818..52d268acb79fbf 100644 --- a/docs/pages/material-ui/api/list-item-avatar.json +++ b/docs/pages/material-ui/api/list-item-avatar.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemAvatar", diff --git a/docs/pages/material-ui/api/list-item-button.json b/docs/pages/material-ui/api/list-item-button.json index c97d3e1497716e..41fa69adbd06d4 100644 --- a/docs/pages/material-ui/api/list-item-button.json +++ b/docs/pages/material-ui/api/list-item-button.json @@ -2,23 +2,25 @@ "props": { "alignItems": { "type": { "name": "enum", "description": "'center'
    | 'flex-start'" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "dense": { "type": { "name": "bool" }, "default": "false" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, - "divider": { "type": { "name": "bool" }, "default": "false" }, - "focusVisibleClassName": { "type": { "name": "string" } }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "dense": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "divider": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemButton", diff --git a/docs/pages/material-ui/api/list-item-icon.json b/docs/pages/material-ui/api/list-item-icon.json index c8e064059b31c4..2bdbe16c88168d 100644 --- a/docs/pages/material-ui/api/list-item-icon.json +++ b/docs/pages/material-ui/api/list-item-icon.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemIcon", diff --git a/docs/pages/material-ui/api/list-item-secondary-action.json b/docs/pages/material-ui/api/list-item-secondary-action.json index d854c052d71163..1e1ffde04ed957 100644 --- a/docs/pages/material-ui/api/list-item-secondary-action.json +++ b/docs/pages/material-ui/api/list-item-secondary-action.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemSecondaryAction", diff --git a/docs/pages/material-ui/api/list-item-text.json b/docs/pages/material-ui/api/list-item-text.json index c3c53131565ffe..7a76350cb1c908 100644 --- a/docs/pages/material-ui/api/list-item-text.json +++ b/docs/pages/material-ui/api/list-item-text.json @@ -1,18 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableTypography": { "type": { "name": "bool" }, "default": "false" }, - "inset": { "type": { "name": "bool" }, "default": "false" }, - "primary": { "type": { "name": "node" } }, - "primaryTypographyProps": { "type": { "name": "object" } }, - "secondary": { "type": { "name": "node" } }, - "secondaryTypographyProps": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableTypography": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "inset": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "primary": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "primaryTypographyProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "secondary": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "secondaryTypographyProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItemText", diff --git a/docs/pages/material-ui/api/list-item.json b/docs/pages/material-ui/api/list-item.json index 89a2802a293daf..dc12f1d8de6407 100644 --- a/docs/pages/material-ui/api/list-item.json +++ b/docs/pages/material-ui/api/list-item.json @@ -2,67 +2,83 @@ "props": { "alignItems": { "type": { "name": "enum", "description": "'center'
    | 'flex-start'" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, "autoFocus": { "type": { "name": "bool" }, "default": "false", "deprecated": true, - "deprecationInfo": "checkout ListItemButton instead" + "deprecationInfo": "checkout ListItemButton instead", + "additionalPropsInfo": {} }, "button": { "type": { "name": "bool" }, "default": "false", "deprecated": true, - "deprecationInfo": "checkout ListItemButton instead" + "deprecationInfo": "checkout ListItemButton instead", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "custom", "description": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "custom", "description": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "ContainerComponent": { "type": { "name": "custom", "description": "element type" }, "default": "'li'", - "deprecated": true + "deprecated": true, + "additionalPropsInfo": {} + }, + "ContainerProps": { + "type": { "name": "object" }, + "default": "{}", + "deprecated": true, + "additionalPropsInfo": {} }, - "ContainerProps": { "type": { "name": "object" }, "default": "{}", "deprecated": true }, - "dense": { "type": { "name": "bool" }, "default": "false" }, + "dense": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "disabled": { "type": { "name": "bool" }, "default": "false", "deprecated": true, - "deprecationInfo": "checkout ListItemButton instead" + "deprecationInfo": "checkout ListItemButton instead", + "additionalPropsInfo": {} }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, - "disablePadding": { "type": { "name": "bool" }, "default": "false" }, - "divider": { "type": { "name": "bool" }, "default": "false" }, - "secondaryAction": { "type": { "name": "node" } }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disablePadding": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "divider": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "secondaryAction": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "selected": { "type": { "name": "bool" }, "default": "false", "deprecated": true, - "deprecationInfo": "checkout ListItemButton instead" + "deprecationInfo": "checkout ListItemButton instead", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListItem", diff --git a/docs/pages/material-ui/api/list-subheader.json b/docs/pages/material-ui/api/list-subheader.json index a9fc763e038446..402d76c5570257 100644 --- a/docs/pages/material-ui/api/list-subheader.json +++ b/docs/pages/material-ui/api/list-subheader.json @@ -1,23 +1,25 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "enum", "description": "'default'
    | 'inherit'
    | 'primary'" }, - "default": "'default'" + "default": "'default'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, - "disableSticky": { "type": { "name": "bool" }, "default": "false" }, - "inset": { "type": { "name": "bool" }, "default": "false" }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableSticky": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "inset": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ListSubheader", diff --git a/docs/pages/material-ui/api/list.json b/docs/pages/material-ui/api/list.json index ed2111be38f57c..f90a8af24fdae3 100644 --- a/docs/pages/material-ui/api/list.json +++ b/docs/pages/material-ui/api/list.json @@ -1,16 +1,17 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "dense": { "type": { "name": "bool" }, "default": "false" }, - "disablePadding": { "type": { "name": "bool" }, "default": "false" }, - "subheader": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "dense": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disablePadding": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "subheader": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "List", diff --git a/docs/pages/material-ui/api/loading-button.json b/docs/pages/material-ui/api/loading-button.json index f26686e229e33c..7b546f3d5459bc 100644 --- a/docs/pages/material-ui/api/loading-button.json +++ b/docs/pages/material-ui/api/loading-button.json @@ -1,32 +1,36 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "loading": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "loading": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "loadingIndicator": { "type": { "name": "node" }, - "default": "" + "default": "", + "additionalPropsInfo": {} }, "loadingPosition": { "type": { "name": "custom", "description": "'start'
    | 'end'
    | 'center'" }, - "default": "'center'" + "default": "'center'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'contained'
    | 'outlined'
    | 'text'
    | string" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} } }, "name": "LoadingButton", diff --git a/docs/pages/material-ui/api/masonry.json b/docs/pages/material-ui/api/masonry.json index a7d71dbb9bc03f..5e4d94dcaf19c1 100644 --- a/docs/pages/material-ui/api/masonry.json +++ b/docs/pages/material-ui/api/masonry.json @@ -1,30 +1,33 @@ { "props": { - "children": { "type": { "name": "node" }, "required": true }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "required": true, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "columns": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" }, - "default": "4" + "default": "4", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, - "defaultColumns": { "type": { "name": "number" } }, - "defaultHeight": { "type": { "name": "number" } }, - "defaultSpacing": { "type": { "name": "number" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "defaultColumns": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "defaultHeight": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "defaultSpacing": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" }, - "default": "1" + "default": "1", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Masonry", diff --git a/docs/pages/material-ui/api/menu-item.json b/docs/pages/material-ui/api/menu-item.json index 346feb5bbe8972..a9f08c7940926d 100644 --- a/docs/pages/material-ui/api/menu-item.json +++ b/docs/pages/material-ui/api/menu-item.json @@ -1,19 +1,20 @@ { "props": { - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "dense": { "type": { "name": "bool" }, "default": "false" }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, - "divider": { "type": { "name": "bool" }, "default": "false" }, - "focusVisibleClassName": { "type": { "name": "string" } }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "dense": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "divider": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "focusVisibleClassName": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "MenuItem", diff --git a/docs/pages/material-ui/api/menu-list.json b/docs/pages/material-ui/api/menu-list.json index 77a779fe4a6720..1e6b6e14eda763 100644 --- a/docs/pages/material-ui/api/menu-list.json +++ b/docs/pages/material-ui/api/menu-list.json @@ -1,13 +1,22 @@ { "props": { - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "autoFocusItem": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" }, - "disableListWrap": { "type": { "name": "bool" }, "default": "false" }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "autoFocusItem": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "disabledItemsFocusable": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableListWrap": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, "variant": { "type": { "name": "enum", "description": "'menu'
    | 'selectedMenu'" }, - "default": "'selectedMenu'" + "default": "'selectedMenu'", + "additionalPropsInfo": {} } }, "name": "MenuList", diff --git a/docs/pages/material-ui/api/menu.json b/docs/pages/material-ui/api/menu.json index d39ba8fdef3e22..7196d12e11c4ad 100644 --- a/docs/pages/material-ui/api/menu.json +++ b/docs/pages/material-ui/api/menu.json @@ -1,31 +1,48 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, - "anchorEl": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "autoFocus": { "type": { "name": "bool" }, "default": "true" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disableAutoFocusItem": { "type": { "name": "bool" }, "default": "false" }, - "MenuListProps": { "type": { "name": "object" }, "default": "{}" }, - "onClose": { "type": { "name": "func" } }, - "PopoverClasses": { "type": { "name": "object" } }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "anchorEl": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "autoFocus": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disableAutoFocusItem": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "MenuListProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "PopoverClasses": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "transitionDuration": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" }, "default": "{}" }, + "TransitionProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'menu'
    | 'selectedMenu'" }, - "default": "'selectedMenu'" + "default": "'selectedMenu'", + "additionalPropsInfo": {} } }, "name": "Menu", diff --git a/docs/pages/material-ui/api/mobile-stepper.json b/docs/pages/material-ui/api/mobile-stepper.json index 688d605eea3646..029e8230aa8535 100644 --- a/docs/pages/material-ui/api/mobile-stepper.json +++ b/docs/pages/material-ui/api/mobile-stepper.json @@ -1,30 +1,41 @@ { "props": { - "steps": { "type": { "name": "custom", "description": "integer" }, "required": true }, - "activeStep": { "type": { "name": "custom", "description": "integer" }, "default": "0" }, - "backButton": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "LinearProgressProps": { "type": { "name": "object" } }, - "nextButton": { "type": { "name": "node" } }, + "steps": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, + "activeStep": { + "type": { "name": "custom", "description": "integer" }, + "default": "0", + "additionalPropsInfo": {} + }, + "backButton": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "LinearProgressProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "nextButton": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "position": { "type": { "name": "enum", "description": "'bottom'
    | 'static'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "enum", "description": "'dots'
    | 'progress'
    | 'text'" }, - "default": "'dots'" + "default": "'dots'", + "additionalPropsInfo": {} } }, "name": "MobileStepper", diff --git a/docs/pages/material-ui/api/modal.json b/docs/pages/material-ui/api/modal.json index c2722983c0d12c..3c1dae7dfdc7ea 100644 --- a/docs/pages/material-ui/api/modal.json +++ b/docs/pages/material-ui/api/modal.json @@ -1,63 +1,109 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "open": { "type": { "name": "bool" }, "required": true }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, "BackdropComponent": { "type": { "name": "elementType" }, "default": "styled(Backdrop, {\n name: 'MuiModal',\n slot: 'Backdrop',\n overridesResolver: (props, styles) => {\n return styles.backdrop;\n },\n})({\n zIndex: -1,\n})", "deprecated": true, - "deprecationInfo": "Use slots.backdrop instead. While this prop currently works, it will be removed in the next major version." + "deprecationInfo": "Use slots.backdrop instead. While this prop currently works, it will be removed in the next major version.", + "additionalPropsInfo": {} }, "BackdropProps": { "type": { "name": "object" }, "deprecated": true, - "deprecationInfo": "Use slotProps.backdrop instead." + "deprecationInfo": "Use slotProps.backdrop instead.", + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "closeAfterTransition": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "classes": { "type": { "name": "object" } }, - "closeAfterTransition": { "type": { "name": "bool" }, "default": "false" }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Backdrop?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ backdrop?: func
    | object, root?: func
    | object }" }, - "default": "{}" - }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "disableAutoFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" }, - "disableScrollLock": { "type": { "name": "bool" }, "default": "false" }, - "hideBackdrop": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, + "default": "{}", + "additionalPropsInfo": {} + }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "disableAutoFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEnforceFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableEscapeKeyDown": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableRestoreFocus": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableScrollLock": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "hideBackdrop": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "onBackdropClick": { "type": { "name": "func" }, "deprecated": true, - "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events." + "deprecationInfo": "Use the onClose prop with the reason argument to handle the backdropClick events.", + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" } }, "slotProps": { "type": { "name": "shape", "description": "{ backdrop?: func
    | object, root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Modal", diff --git a/docs/pages/material-ui/api/native-select.json b/docs/pages/material-ui/api/native-select.json index d90e75525a6913..0cc984c8e44c98 100644 --- a/docs/pages/material-ui/api/native-select.json +++ b/docs/pages/material-ui/api/native-select.json @@ -1,23 +1,40 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" }, "default": "{}" }, - "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDropDownIcon" }, - "input": { "type": { "name": "element" }, "default": "" }, - "inputProps": { "type": { "name": "object" } }, - "onChange": { "type": { "name": "func" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { + "type": { "name": "object" }, + "default": "{}", + "additionalPropsInfo": { "cssApi": true } + }, + "IconComponent": { + "type": { "name": "elementType" }, + "default": "ArrowDropDownIcon", + "additionalPropsInfo": {} + }, + "input": { "type": { "name": "element" }, "default": "", "additionalPropsInfo": {} }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" - } + }, + "additionalPropsInfo": {} } }, "name": "NativeSelect", diff --git a/docs/pages/material-ui/api/outlined-input.json b/docs/pages/material-ui/api/outlined-input.json index 5697dc415b145a..f7ae62fbc6d133 100644 --- a/docs/pages/material-ui/api/outlined-input.json +++ b/docs/pages/material-ui/api/outlined-input.json @@ -1,52 +1,79 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" - } + }, + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} + }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputComponent": { + "type": { "name": "elementType" }, + "default": "'input'", + "additionalPropsInfo": {} + }, + "inputProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "margin": { + "type": { "name": "enum", "description": "'dense'
    | 'none'" }, + "additionalPropsInfo": {} + }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "notched": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "endAdornment": { "type": { "name": "node" } }, - "error": { "type": { "name": "bool" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, - "inputComponent": { "type": { "name": "elementType" }, "default": "'input'" }, - "inputProps": { "type": { "name": "object" }, "default": "{}" }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "label": { "type": { "name": "node" } }, - "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'" } }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "notched": { "type": { "name": "bool" } }, - "onChange": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "string" } }, - "readOnly": { "type": { "name": "bool" } }, - "required": { "type": { "name": "bool" } }, - "rows": { "type": { "name": "union", "description": "number
    | string" } }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "startAdornment": { "type": { "name": "node" } }, + "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "default": "'text'" }, - "value": { "type": { "name": "any" } } + "type": { "type": { "name": "string" }, "default": "'text'", "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "OutlinedInput", "styles": { diff --git a/docs/pages/material-ui/api/pagination-item.json b/docs/pages/material-ui/api/pagination-item.json index 35bd1ed4ff765c..a0acf72b62d522 100644 --- a/docs/pages/material-ui/api/pagination-item.json +++ b/docs/pages/material-ui/api/pagination-item.json @@ -1,61 +1,69 @@ { "props": { - "classes": { "type": { "name": "object" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'standard'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "page": { "type": { "name": "node" } }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "page": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "shape": { "type": { "name": "enum", "description": "'circular'
    | 'rounded'" }, - "default": "'circular'" + "default": "'circular'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "type": { "type": { "name": "enum", "description": "'end-ellipsis'
    | 'first'
    | 'last'
    | 'next'
    | 'page'
    | 'previous'
    | 'start-ellipsis'" }, - "default": "'page'" + "default": "'page'", + "additionalPropsInfo": {} }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'text'
    | string" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} } }, "name": "PaginationItem", diff --git a/docs/pages/material-ui/api/pagination.json b/docs/pages/material-ui/api/pagination.json index cb78bf134b2d8e..af0f18733f3c8f 100644 --- a/docs/pages/material-ui/api/pagination.json +++ b/docs/pages/material-ui/api/pagination.json @@ -1,52 +1,96 @@ { "props": { - "boundaryCount": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, - "classes": { "type": { "name": "object" } }, + "boundaryCount": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'standard'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} + }, + "count": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} }, - "count": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, - "defaultPage": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "getItemAriaLabel": { "type": { "name": "func" } }, - "hideNextButton": { "type": { "name": "bool" }, "default": "false" }, - "hidePrevButton": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, - "page": { "type": { "name": "custom", "description": "integer" } }, + "defaultPage": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getItemAriaLabel": { + "type": { "name": "func" }, + "signature": { + "type": "function(type: string, page: number, selected: bool) => string", + "describedArgs": ["type", "page", "selected"] + }, + "additionalPropsInfo": {} + }, + "hideNextButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "hidePrevButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent, page: number) => void", + "describedArgs": ["event", "page"] + }, + "additionalPropsInfo": {} + }, + "page": { "type": { "name": "custom", "description": "integer" }, "additionalPropsInfo": {} }, "renderItem": { "type": { "name": "func" }, - "default": "(item) => " + "default": "(item) => ", + "signature": { + "type": "function(params: PaginationRenderItemParams) => ReactNode", + "describedArgs": ["params"] + }, + "additionalPropsInfo": {} }, "shape": { "type": { "name": "enum", "description": "'circular'
    | 'rounded'" }, - "default": "'circular'" + "default": "'circular'", + "additionalPropsInfo": {} + }, + "showFirstButton": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "showLastButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "siblingCount": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} }, - "showFirstButton": { "type": { "name": "bool" }, "default": "false" }, - "showLastButton": { "type": { "name": "bool" }, "default": "false" }, - "siblingCount": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'text'
    | string" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} } }, "name": "Pagination", diff --git a/docs/pages/material-ui/api/paper.json b/docs/pages/material-ui/api/paper.json index a69c71a1883146..15bef43296a52f 100644 --- a/docs/pages/material-ui/api/paper.json +++ b/docs/pages/material-ui/api/paper.json @@ -1,22 +1,28 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "elevation": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, - "square": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "elevation": { + "type": { "name": "custom", "description": "integer" }, + "default": "1", + "additionalPropsInfo": {} + }, + "square": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'elevation'
    | 'outlined'
    | string" }, - "default": "'elevation'" + "default": "'elevation'", + "additionalPropsInfo": {} } }, "name": "Paper", diff --git a/docs/pages/material-ui/api/popover.json b/docs/pages/material-ui/api/popover.json index d362711be03930..f7a19615b48775 100644 --- a/docs/pages/material-ui/api/popover.json +++ b/docs/pages/material-ui/api/popover.json @@ -1,57 +1,78 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, - "action": { "type": { "name": "custom", "description": "ref" } }, - "anchorEl": { "type": { "name": "custom", "description": "HTML element
    | func" } }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "action": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "anchorEl": { + "type": { "name": "custom", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, "anchorOrigin": { "type": { "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right'
    | number, vertical: 'bottom'
    | 'center'
    | 'top'
    | number }" }, - "default": "{\n vertical: 'top',\n horizontal: 'left',\n}" + "default": "{\n vertical: 'top',\n horizontal: 'left',\n}", + "additionalPropsInfo": {} }, "anchorPosition": { - "type": { "name": "shape", "description": "{ left: number, top: number }" } + "type": { "name": "shape", "description": "{ left: number, top: number }" }, + "additionalPropsInfo": {} }, "anchorReference": { "type": { "name": "enum", "description": "'anchorEl'
    | 'anchorPosition'
    | 'none'" }, - "default": "'anchorEl'" + "default": "'anchorEl'", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} + }, + "elevation": { + "type": { "name": "custom", "description": "integer" }, + "default": "8", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "elevation": { "type": { "name": "custom", "description": "integer" }, "default": "8" }, - "marginThreshold": { "type": { "name": "number" }, "default": "16" }, - "onClose": { "type": { "name": "func" } }, + "marginThreshold": { "type": { "name": "number" }, "default": "16", "additionalPropsInfo": {} }, + "onClose": { "type": { "name": "func" }, "additionalPropsInfo": {} }, "PaperProps": { "type": { "name": "shape", "description": "{ component?: element type }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "transformOrigin": { "type": { "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right'
    | number, vertical: 'bottom'
    | 'center'
    | 'top'
    | number }" }, - "default": "{\n vertical: 'top',\n horizontal: 'left',\n}" + "default": "{\n vertical: 'top',\n horizontal: 'left',\n}", + "additionalPropsInfo": {} + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Grow", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, "transitionDuration": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" }, "default": "{}" } + "TransitionProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} } }, "name": "Popover", "styles": { "classes": ["root", "paper"], "globalClasses": {}, "name": "MuiPopover" }, diff --git a/docs/pages/material-ui/api/popper.json b/docs/pages/material-ui/api/popper.json index 36b3a8fa00dab3..efe5f7a0833d22 100644 --- a/docs/pages/material-ui/api/popper.json +++ b/docs/pages/material-ui/api/popper.json @@ -1,61 +1,76 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true }, + "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, "anchorEl": { "type": { "name": "union", "description": "HTML element
    | object
    | func" - } + }, + "additionalPropsInfo": {} + }, + "children": { + "type": { "name": "union", "description": "node
    | func" }, + "additionalPropsInfo": {} }, - "children": { "type": { "name": "union", "description": "node
    | func" } }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} + }, + "container": { + "type": { "name": "union", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} }, - "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, - "disablePortal": { "type": { "name": "bool" }, "default": "false" }, - "keepMounted": { "type": { "name": "bool" }, "default": "false" }, + "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "modifiers": { "type": { "name": "arrayOf", "description": "Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
    | 'afterRead'
    | 'afterWrite'
    | 'beforeMain'
    | 'beforeRead'
    | 'beforeWrite'
    | 'main'
    | 'read'
    | 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>" - } + }, + "additionalPropsInfo": {} }, "placement": { "type": { "name": "enum", "description": "'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, "popperOptions": { "type": { "name": "shape", "description": "{ modifiers?: array, onFirstUpdate?: func, placement?: 'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top', strategy?: 'absolute'
    | 'fixed' }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "popperRef": { "type": { "name": "custom", "description": "ref" } }, + "popperRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "transition": { "type": { "name": "bool" }, "default": "false" } + "transition": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Popper", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/radio-group.json b/docs/pages/material-ui/api/radio-group.json index b02816ea033cb6..de5945ac34f4bd 100644 --- a/docs/pages/material-ui/api/radio-group.json +++ b/docs/pages/material-ui/api/radio-group.json @@ -1,10 +1,17 @@ { "props": { - "children": { "type": { "name": "node" } }, - "defaultValue": { "type": { "name": "any" } }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "value": { "type": { "name": "any" } } + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent, value: string) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "RadioGroup", "styles": { diff --git a/docs/pages/material-ui/api/radio.json b/docs/pages/material-ui/api/radio.json index 283ba4e7ee23f8..41df0bd7cb037b 100644 --- a/docs/pages/material-ui/api/radio.json +++ b/docs/pages/material-ui/api/radio.json @@ -1,38 +1,56 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "checkedIcon": { "type": { "name": "node" }, "default": "" }, - "classes": { "type": { "name": "object" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "checkedIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" } }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" }, "default": "" }, - "id": { "type": { "name": "string" } }, - "inputProps": { "type": { "name": "object" } }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Radio", "styles": { diff --git a/docs/pages/material-ui/api/rating.json b/docs/pages/material-ui/api/rating.json index c7fc27a91ffa09..0509a26dba5f01 100644 --- a/docs/pages/material-ui/api/rating.json +++ b/docs/pages/material-ui/api/rating.json @@ -1,40 +1,79 @@ { "props": { - "classes": { "type": { "name": "object" } }, - "defaultValue": { "type": { "name": "number" }, "default": "null" }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "emptyIcon": { "type": { "name": "node" }, "default": "" }, - "emptyLabelText": { "type": { "name": "node" }, "default": "'Empty'" }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "defaultValue": { "type": { "name": "number" }, "default": "null", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "emptyIcon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} + }, + "emptyLabelText": { + "type": { "name": "node" }, + "default": "'Empty'", + "additionalPropsInfo": {} + }, "getLabelText": { "type": { "name": "func" }, - "default": "function defaultLabelText(value) {\n return `${value} Star${value !== 1 ? 's' : ''}`;\n}" + "default": "function defaultLabelText(value) {\n return `${value} Star${value !== 1 ? 's' : ''}`;\n}", + "signature": { "type": "function(value: number) => string", "describedArgs": ["value"] }, + "additionalPropsInfo": {} + }, + "highlightSelectedOnly": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "icon": { + "type": { "name": "node" }, + "default": "", + "additionalPropsInfo": {} }, - "highlightSelectedOnly": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" }, "default": "" }, "IconContainerComponent": { "type": { "name": "elementType" }, - "default": "function IconContainer(props) {\n const { value, ...other } = props;\n return ;\n}" + "default": "function IconContainer(props) {\n const { value, ...other } = props;\n return ;\n}", + "additionalPropsInfo": {} + }, + "max": { "type": { "name": "number" }, "default": "5", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: number | null) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "onChangeActive": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: number) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "precision": { + "type": { "name": "custom", "description": "number" }, + "default": "1", + "additionalPropsInfo": {} }, - "max": { "type": { "name": "number" }, "default": "5" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onChangeActive": { "type": { "name": "func" } }, - "precision": { "type": { "name": "custom", "description": "number" }, "default": "1" }, - "readOnly": { "type": { "name": "bool" }, "default": "false" }, + "readOnly": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "number" } } + "value": { "type": { "name": "number" }, "additionalPropsInfo": {} } }, "name": "Rating", "styles": { diff --git a/docs/pages/material-ui/api/scoped-css-baseline.json b/docs/pages/material-ui/api/scoped-css-baseline.json index 78b186e9449e28..b5b2bffab0b49a 100644 --- a/docs/pages/material-ui/api/scoped-css-baseline.json +++ b/docs/pages/material-ui/api/scoped-css-baseline.json @@ -1,14 +1,15 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "enableColorScheme": { "type": { "name": "bool" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "enableColorScheme": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ScopedCssBaseline", diff --git a/docs/pages/material-ui/api/select.json b/docs/pages/material-ui/api/select.json index 75511f6656161f..9b30b9358afbba 100644 --- a/docs/pages/material-ui/api/select.json +++ b/docs/pages/material-ui/api/select.json @@ -1,39 +1,71 @@ { "props": { - "autoWidth": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" }, "default": "{}" }, - "defaultOpen": { "type": { "name": "bool" }, "default": "false" }, - "defaultValue": { "type": { "name": "any" } }, - "displayEmpty": { "type": { "name": "bool" }, "default": "false" }, - "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDropDownIcon" }, - "id": { "type": { "name": "string" } }, - "input": { "type": { "name": "element" } }, - "inputProps": { "type": { "name": "object" } }, - "label": { "type": { "name": "node" } }, - "labelId": { "type": { "name": "string" } }, - "MenuProps": { "type": { "name": "object" } }, - "multiple": { "type": { "name": "bool" }, "default": "false" }, - "native": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "renderValue": { "type": { "name": "func" } }, - "SelectDisplayProps": { "type": { "name": "object" } }, + "autoWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { + "type": { "name": "object" }, + "default": "{}", + "additionalPropsInfo": { "cssApi": true } + }, + "defaultOpen": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "displayEmpty": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "IconComponent": { + "type": { "name": "elementType" }, + "default": "ArrowDropDownIcon", + "additionalPropsInfo": {} + }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "input": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "labelId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "MenuProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "multiple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "native": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: SelectChangeEvent, child?: object) => void", + "describedArgs": ["event", "child"] + }, + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "renderValue": { + "type": { "name": "func" }, + "signature": { "type": "function(value: any) => ReactNode", "describedArgs": ["value"] }, + "additionalPropsInfo": {} + }, + "SelectDisplayProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "value": { + "type": { "name": "union", "description": "''
    | any" }, + "additionalPropsInfo": {} }, - "value": { "type": { "name": "union", "description": "''
    | any" } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": {} } }, "name": "Select", diff --git a/docs/pages/material-ui/api/skeleton.json b/docs/pages/material-ui/api/skeleton.json index 26abf9fb924258..65c47fc03aee3d 100644 --- a/docs/pages/material-ui/api/skeleton.json +++ b/docs/pages/material-ui/api/skeleton.json @@ -5,26 +5,35 @@ "name": "enum", "description": "'pulse'
    | 'wave'
    | false" }, - "default": "'pulse'" + "default": "'pulse'", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "height": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "height": { "type": { "name": "union", "description": "number
    | string" } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'circular'
    | 'rectangular'
    | 'rounded'
    | 'text'
    | string" }, - "default": "'text'" + "default": "'text'", + "additionalPropsInfo": {} }, - "width": { "type": { "name": "union", "description": "number
    | string" } } + "width": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + } }, "name": "Skeleton", "styles": { diff --git a/docs/pages/material-ui/api/slide.json b/docs/pages/material-ui/api/slide.json index 0c3613f4888470..9d2731bbc44334 100644 --- a/docs/pages/material-ui/api/slide.json +++ b/docs/pages/material-ui/api/slide.json @@ -1,32 +1,40 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "addEndListener": { "type": { "name": "func" } }, - "appear": { "type": { "name": "bool" }, "default": "true" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, "container": { - "type": { "name": "custom", "description": "HTML element
    | func" } + "type": { "name": "custom", "description": "HTML element
    | func" }, + "additionalPropsInfo": {} }, "direction": { "type": { "name": "enum", "description": "'down'
    | 'left'
    | 'right'
    | 'up'" }, - "default": "'down'" + "default": "'down'", + "additionalPropsInfo": {} }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" }, - "default": "{\n enter: theme.transitions.easing.easeOut,\n exit: theme.transitions.easing.sharp,\n}" + "default": "{\n enter: theme.transitions.easing.easeOut,\n exit: theme.transitions.easing.sharp,\n}", + "additionalPropsInfo": {} }, - "in": { "type": { "name": "bool" } }, + "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "timeout": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} } }, "name": "Slide", diff --git a/docs/pages/material-ui/api/slider.json b/docs/pages/material-ui/api/slider.json index ea24cd93cec506..a53235811ebdd1 100644 --- a/docs/pages/material-ui/api/slider.json +++ b/docs/pages/material-ui/api/slider.json @@ -1,100 +1,150 @@ { "props": { - "aria-label": { "type": { "name": "custom", "description": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "aria-valuetext": { "type": { "name": "custom", "description": "string" } }, - "classes": { "type": { "name": "object" } }, + "aria-label": { + "type": { "name": "custom", "description": "string" }, + "additionalPropsInfo": {} + }, + "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-valuetext": { + "type": { "name": "custom", "description": "string" }, + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Mark?: elementType, MarkLabel?: elementType, Rail?: elementType, Root?: elementType, Thumb?: elementType, Track?: elementType, ValueLabel?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: func
    | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto'
    | 'off'
    | 'on' } }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "defaultValue": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableSwap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "getAriaLabel": { + "type": { "name": "func" }, + "signature": { "type": "function(index: number) => string", "describedArgs": ["index"] }, + "additionalPropsInfo": {} + }, + "getAriaValueText": { + "type": { "name": "func" }, + "signature": { + "type": "function(value: number, index: number) => string", + "describedArgs": ["value", "index"] + }, + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableSwap": { "type": { "name": "bool" }, "default": "false" }, - "getAriaLabel": { "type": { "name": "func" } }, - "getAriaValueText": { "type": { "name": "func" } }, "marks": { "type": { "name": "union", "description": "Array<{ label?: node, value: number }>
    | bool" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} + }, + "max": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, + "min": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: Event, value: number | Array, activeThumb: number) => void", + "describedArgs": ["event", "value", "activeThumb"] + }, + "additionalPropsInfo": {} + }, + "onChangeCommitted": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent | Event, value: number | Array) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} }, - "max": { "type": { "name": "number" }, "default": "100" }, - "min": { "type": { "name": "number" }, "default": "0" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "onChangeCommitted": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} + }, + "scale": { + "type": { "name": "func" }, + "default": "function Identity(x) {\n return x;\n}", + "signature": { "type": "function(x: any) => any", "describedArgs": [] }, + "additionalPropsInfo": {} }, - "scale": { "type": { "name": "func" }, "default": "function Identity(x) {\n return x;\n}" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: func
    | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto'
    | 'off'
    | 'on' } }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "step": { "type": { "name": "number" }, "default": "1" }, + "step": { "type": { "name": "number" }, "default": "1", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "tabIndex": { "type": { "name": "number" } }, + "tabIndex": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "track": { "type": { "name": "enum", "description": "'inverted'
    | 'normal'
    | false" }, - "default": "'normal'" + "default": "'normal'", + "additionalPropsInfo": {} }, "value": { - "type": { "name": "union", "description": "Array<number>
    | number" } + "type": { "name": "union", "description": "Array<number>
    | number" }, + "additionalPropsInfo": {} }, "valueLabelDisplay": { "type": { "name": "enum", "description": "'auto'
    | 'off'
    | 'on'" }, - "default": "'off'" + "default": "'off'", + "additionalPropsInfo": {} }, "valueLabelFormat": { "type": { "name": "union", "description": "func
    | string" }, - "default": "function Identity(x) {\n return x;\n}" + "default": "function Identity(x) {\n return x;\n}", + "additionalPropsInfo": {} } }, "name": "Slider", diff --git a/docs/pages/material-ui/api/snackbar-content.json b/docs/pages/material-ui/api/snackbar-content.json index 17a8bd6e1ef671..cb83d2884413a7 100644 --- a/docs/pages/material-ui/api/snackbar-content.json +++ b/docs/pages/material-ui/api/snackbar-content.json @@ -1,14 +1,15 @@ { "props": { - "action": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "message": { "type": { "name": "node" } }, - "role": { "type": { "name": "string" }, "default": "'alert'" }, + "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "message": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "role": { "type": { "name": "string" }, "default": "'alert'", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "SnackbarContent", diff --git a/docs/pages/material-ui/api/snackbar.json b/docs/pages/material-ui/api/snackbar.json index d3d291d0e6b407..0ca78954580912 100644 --- a/docs/pages/material-ui/api/snackbar.json +++ b/docs/pages/material-ui/api/snackbar.json @@ -1,39 +1,61 @@ { "props": { - "action": { "type": { "name": "node" } }, + "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "anchorOrigin": { "type": { "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right', vertical: 'bottom'
    | 'top' }" }, - "default": "{ vertical: 'bottom', horizontal: 'left' }" + "default": "{ vertical: 'bottom', horizontal: 'left' }", + "additionalPropsInfo": {} }, - "autoHideDuration": { "type": { "name": "number" }, "default": "null" }, - "children": { "type": { "name": "element" } }, - "classes": { "type": { "name": "object" } }, - "ClickAwayListenerProps": { "type": { "name": "object" } }, - "ContentProps": { "type": { "name": "object" } }, - "disableWindowBlurListener": { "type": { "name": "bool" }, "default": "false" }, - "key": { "type": { "name": "custom", "description": "any" } }, - "message": { "type": { "name": "node" } }, - "onClose": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "resumeHideDuration": { "type": { "name": "number" } }, + "autoHideDuration": { + "type": { "name": "number" }, + "default": "null", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "ClickAwayListenerProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "ContentProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "disableWindowBlurListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "key": { "type": { "name": "custom", "description": "any" }, "additionalPropsInfo": {} }, + "message": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent | Event, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "resumeHideDuration": { "type": { "name": "number" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Grow", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" }, "default": "{}" } + "TransitionProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} } }, "name": "Snackbar", "styles": { diff --git a/docs/pages/material-ui/api/speed-dial-action.json b/docs/pages/material-ui/api/speed-dial-action.json index c2d8084e2fb65b..58c2f476086f1f 100644 --- a/docs/pages/material-ui/api/speed-dial-action.json +++ b/docs/pages/material-ui/api/speed-dial-action.json @@ -1,27 +1,29 @@ { "props": { - "classes": { "type": { "name": "object" } }, - "delay": { "type": { "name": "number" }, "default": "0" }, - "FabProps": { "type": { "name": "object" }, "default": "{}" }, - "icon": { "type": { "name": "node" } }, - "id": { "type": { "name": "string" } }, - "open": { "type": { "name": "bool" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "delay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "FabProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "TooltipClasses": { "type": { "name": "object" } }, - "tooltipOpen": { "type": { "name": "bool" }, "default": "false" }, + "TooltipClasses": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "tooltipOpen": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "tooltipPlacement": { "type": { "name": "enum", "description": "'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'left'" + "default": "'left'", + "additionalPropsInfo": {} }, - "tooltipTitle": { "type": { "name": "node" } } + "tooltipTitle": { "type": { "name": "node" }, "additionalPropsInfo": {} } }, "name": "SpeedDialAction", "styles": { diff --git a/docs/pages/material-ui/api/speed-dial-icon.json b/docs/pages/material-ui/api/speed-dial-icon.json index aeea4663336927..231cfe7844a7b5 100644 --- a/docs/pages/material-ui/api/speed-dial-icon.json +++ b/docs/pages/material-ui/api/speed-dial-icon.json @@ -1,13 +1,14 @@ { "props": { - "classes": { "type": { "name": "object" } }, - "icon": { "type": { "name": "node" } }, - "openIcon": { "type": { "name": "node" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "openIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "SpeedDialIcon", diff --git a/docs/pages/material-ui/api/speed-dial.json b/docs/pages/material-ui/api/speed-dial.json index fca653993254af..79b203d30bf288 100644 --- a/docs/pages/material-ui/api/speed-dial.json +++ b/docs/pages/material-ui/api/speed-dial.json @@ -1,37 +1,58 @@ { "props": { - "ariaLabel": { "type": { "name": "string" }, "required": true }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "ariaLabel": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "direction": { "type": { "name": "enum", "description": "'down'
    | 'left'
    | 'right'
    | 'up'" }, - "default": "'up'" + "default": "'up'", + "additionalPropsInfo": {} }, - "FabProps": { "type": { "name": "object" }, "default": "{}" }, - "hidden": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" } }, - "onClose": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "openIcon": { "type": { "name": "node" } }, + "FabProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "hidden": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: object, reason: string) => void", + "describedArgs": ["event", "reason"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "openIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Zoom", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Zoom" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "SpeedDial", "styles": { diff --git a/docs/pages/material-ui/api/stack.json b/docs/pages/material-ui/api/stack.json index e10087fe818446..eb63e03d5dda9e 100644 --- a/docs/pages/material-ui/api/stack.json +++ b/docs/pages/material-ui/api/stack.json @@ -1,27 +1,30 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - } + }, + "additionalPropsInfo": {} }, - "divider": { "type": { "name": "node" } }, + "divider": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "useFlexGap": { "type": { "name": "bool" } } + "useFlexGap": { "type": { "name": "bool" }, "additionalPropsInfo": {} } }, "name": "Stack", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/step-button.json b/docs/pages/material-ui/api/step-button.json index 8804672d3d5f51..20206480389fdd 100644 --- a/docs/pages/material-ui/api/step-button.json +++ b/docs/pages/material-ui/api/step-button.json @@ -1,14 +1,15 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "icon": { "type": { "name": "node" } }, - "optional": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "optional": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "StepButton", diff --git a/docs/pages/material-ui/api/step-connector.json b/docs/pages/material-ui/api/step-connector.json index 156efa6f0294db..a5b7688809337f 100644 --- a/docs/pages/material-ui/api/step-connector.json +++ b/docs/pages/material-ui/api/step-connector.json @@ -1,11 +1,12 @@ { "props": { - "classes": { "type": { "name": "object" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "StepConnector", diff --git a/docs/pages/material-ui/api/step-content.json b/docs/pages/material-ui/api/step-content.json index 837f3593679093..75662aaf56d81f 100644 --- a/docs/pages/material-ui/api/step-content.json +++ b/docs/pages/material-ui/api/step-content.json @@ -1,22 +1,28 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Collapse", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Collapse" }, "transitionDuration": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "StepContent", "styles": { diff --git a/docs/pages/material-ui/api/step-icon.json b/docs/pages/material-ui/api/step-icon.json index 5455fbb4389b2a..db7a1669f3c9aa 100644 --- a/docs/pages/material-ui/api/step-icon.json +++ b/docs/pages/material-ui/api/step-icon.json @@ -1,15 +1,16 @@ { "props": { - "active": { "type": { "name": "bool" }, "default": "false" }, - "classes": { "type": { "name": "object" } }, - "completed": { "type": { "name": "bool" }, "default": "false" }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" } }, + "active": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "completed": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "StepIcon", diff --git a/docs/pages/material-ui/api/step-label.json b/docs/pages/material-ui/api/step-label.json index 2d9f0ab02b8a67..96f8b6efc802ec 100644 --- a/docs/pages/material-ui/api/step-label.json +++ b/docs/pages/material-ui/api/step-label.json @@ -1,25 +1,28 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "componentsProps": { "type": { "name": "shape", "description": "{ label?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "node" } }, - "optional": { "type": { "name": "node" } }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "optional": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ label?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, - "StepIconComponent": { "type": { "name": "elementType" } }, - "StepIconProps": { "type": { "name": "object" } }, + "StepIconComponent": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "StepIconProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "StepLabel", diff --git a/docs/pages/material-ui/api/step.json b/docs/pages/material-ui/api/step.json index c4fbc6ee8e17d8..235093ec38441a 100644 --- a/docs/pages/material-ui/api/step.json +++ b/docs/pages/material-ui/api/step.json @@ -1,19 +1,20 @@ { "props": { - "active": { "type": { "name": "bool" } }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "completed": { "type": { "name": "bool" } }, - "component": { "type": { "name": "elementType" } }, - "disabled": { "type": { "name": "bool" } }, - "expanded": { "type": { "name": "bool" }, "default": "false" }, - "index": { "type": { "name": "custom", "description": "integer" } }, - "last": { "type": { "name": "bool" } }, + "active": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "completed": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "expanded": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "index": { "type": { "name": "custom", "description": "integer" }, "additionalPropsInfo": {} }, + "last": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Step", diff --git a/docs/pages/material-ui/api/stepper.json b/docs/pages/material-ui/api/stepper.json index 32c54009e7e52b..63130fd750a3d3 100644 --- a/docs/pages/material-ui/api/stepper.json +++ b/docs/pages/material-ui/api/stepper.json @@ -1,21 +1,35 @@ { "props": { - "activeStep": { "type": { "name": "custom", "description": "integer" }, "default": "0" }, - "alternativeLabel": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "connector": { "type": { "name": "element" }, "default": "" }, - "nonLinear": { "type": { "name": "bool" }, "default": "false" }, + "activeStep": { + "type": { "name": "custom", "description": "integer" }, + "default": "0", + "additionalPropsInfo": {} + }, + "alternativeLabel": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "connector": { + "type": { "name": "element" }, + "default": "", + "additionalPropsInfo": {} + }, + "nonLinear": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Stepper", diff --git a/docs/pages/material-ui/api/svg-icon.json b/docs/pages/material-ui/api/svg-icon.json index 865a3377a49274..d0b1fede2cc849 100644 --- a/docs/pages/material-ui/api/svg-icon.json +++ b/docs/pages/material-ui/api/svg-icon.json @@ -1,33 +1,36 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'action'
    | 'disabled'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "fontSize": { "type": { "name": "union", "description": "'inherit'
    | 'large'
    | 'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, - "htmlColor": { "type": { "name": "string" } }, - "inheritViewBox": { "type": { "name": "bool" }, "default": "false" }, - "shapeRendering": { "type": { "name": "string" } }, + "htmlColor": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inheritViewBox": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "shapeRendering": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "titleAccess": { "type": { "name": "string" } }, - "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'" } + "titleAccess": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'", "additionalPropsInfo": {} } }, "name": "SvgIcon", "styles": { diff --git a/docs/pages/material-ui/api/swipeable-drawer.json b/docs/pages/material-ui/api/swipeable-drawer.json index 5e349dde6e2d5d..45ff3c4960b3da 100644 --- a/docs/pages/material-ui/api/swipeable-drawer.json +++ b/docs/pages/material-ui/api/swipeable-drawer.json @@ -1,29 +1,54 @@ { "props": { - "onClose": { "type": { "name": "func" }, "required": true }, - "onOpen": { "type": { "name": "func" }, "required": true }, + "onClose": { + "type": { "name": "func" }, + "required": true, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "required": true, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, "allowSwipeInChildren": { "type": { "name": "union", "description": "bool
    | func" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} + }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "disableBackdropTransition": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableDiscovery": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "disableBackdropTransition": { "type": { "name": "bool" }, "default": "false" }, - "disableDiscovery": { "type": { "name": "bool" }, "default": "false" }, "disableSwipeToOpen": { "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)" + "default": "typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)", + "additionalPropsInfo": {} + }, + "hysteresis": { "type": { "name": "number" }, "default": "0.52", "additionalPropsInfo": {} }, + "minFlingVelocity": { + "type": { "name": "number" }, + "default": "450", + "additionalPropsInfo": {} }, - "hysteresis": { "type": { "name": "number" }, "default": "0.52" }, - "minFlingVelocity": { "type": { "name": "number" }, "default": "450" }, - "open": { "type": { "name": "bool" }, "default": "false" }, - "SwipeAreaProps": { "type": { "name": "object" } }, - "swipeAreaWidth": { "type": { "name": "number" }, "default": "20" }, + "open": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "SwipeAreaProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "swipeAreaWidth": { "type": { "name": "number" }, "default": "20", "additionalPropsInfo": {} }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} } }, "name": "SwipeableDrawer", diff --git a/docs/pages/material-ui/api/switch.json b/docs/pages/material-ui/api/switch.json index 64a46e5dccc22c..5dc9499b90f28e 100644 --- a/docs/pages/material-ui/api/switch.json +++ b/docs/pages/material-ui/api/switch.json @@ -1,45 +1,56 @@ { "props": { - "checked": { "type": { "name": "bool" } }, - "checkedIcon": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "checkedIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "defaultChecked": { "type": { "name": "bool" } }, - "disabled": { "type": { "name": "bool" } }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, + "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "edge": { "type": { "name": "enum", "description": "'end'
    | 'start'
    | false" }, - "default": "false" + "default": "false", + "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" } }, - "id": { "type": { "name": "string" } }, - "inputProps": { "type": { "name": "object" } }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "onChange": { "type": { "name": "func" } }, - "required": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "Switch", "styles": { diff --git a/docs/pages/material-ui/api/tab-context.json b/docs/pages/material-ui/api/tab-context.json index e01cf33a941639..de69f2f2de30d2 100644 --- a/docs/pages/material-ui/api/tab-context.json +++ b/docs/pages/material-ui/api/tab-context.json @@ -1,7 +1,7 @@ { "props": { - "value": { "type": { "name": "string" }, "required": true }, - "children": { "type": { "name": "node" } } + "value": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} } }, "name": "TabContext", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/tab-list.json b/docs/pages/material-ui/api/tab-list.json index f965cdc48d5951..650dbfda529882 100644 --- a/docs/pages/material-ui/api/tab-list.json +++ b/docs/pages/material-ui/api/tab-list.json @@ -1,5 +1,5 @@ { - "props": { "children": { "type": { "name": "node" } } }, + "props": { "children": { "type": { "name": "node" }, "additionalPropsInfo": {} } }, "name": "TabList", "styles": { "classes": [ diff --git a/docs/pages/material-ui/api/tab-panel.json b/docs/pages/material-ui/api/tab-panel.json index 86a68b8f48259c..46ae3e81499848 100644 --- a/docs/pages/material-ui/api/tab-panel.json +++ b/docs/pages/material-ui/api/tab-panel.json @@ -1,13 +1,14 @@ { "props": { - "value": { "type": { "name": "string" }, "required": true }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "value": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TabPanel", diff --git a/docs/pages/material-ui/api/tab-scroll-button.json b/docs/pages/material-ui/api/tab-scroll-button.json index 89f22cc8a49e18..6250e83c5dd10d 100644 --- a/docs/pages/material-ui/api/tab-scroll-button.json +++ b/docs/pages/material-ui/api/tab-scroll-button.json @@ -2,34 +2,39 @@ "props": { "direction": { "type": { "name": "enum", "description": "'left'
    | 'right'" }, - "required": true + "required": true, + "additionalPropsInfo": {} }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "required": true + "required": true, + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ endScrollButtonIcon?: func
    | object, startScrollButtonIcon?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ EndScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TabScrollButton", diff --git a/docs/pages/material-ui/api/tab.json b/docs/pages/material-ui/api/tab.json index f22b99d97cf61c..a6b87f5c9cdb10 100644 --- a/docs/pages/material-ui/api/tab.json +++ b/docs/pages/material-ui/api/tab.json @@ -1,27 +1,39 @@ { "props": { - "children": { "type": { "name": "custom", "description": "unsupportedProp" } }, - "classes": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "icon": { "type": { "name": "union", "description": "element
    | string" } }, + "children": { + "type": { "name": "custom", "description": "unsupportedProp" }, + "additionalPropsInfo": {} + }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "icon": { + "type": { "name": "union", "description": "element
    | string" }, + "additionalPropsInfo": {} + }, "iconPosition": { "type": { "name": "enum", "description": "'bottom'
    | 'end'
    | 'start'
    | 'top'" }, - "default": "'top'" + "default": "'top'", + "additionalPropsInfo": {} }, - "label": { "type": { "name": "node" } }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } }, - "wrapped": { "type": { "name": "bool" }, "default": "false" } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "wrapped": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } }, "name": "Tab", "styles": { diff --git a/docs/pages/material-ui/api/table-body.json b/docs/pages/material-ui/api/table-body.json index 18f99c16c01385..e2f84d06828c23 100644 --- a/docs/pages/material-ui/api/table-body.json +++ b/docs/pages/material-ui/api/table-body.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableBody", diff --git a/docs/pages/material-ui/api/table-cell.json b/docs/pages/material-ui/api/table-cell.json index 7d090e4ca69105..2c47b067f5a5a0 100644 --- a/docs/pages/material-ui/api/table-cell.json +++ b/docs/pages/material-ui/api/table-cell.json @@ -5,38 +5,44 @@ "name": "enum", "description": "'center'
    | 'inherit'
    | 'justify'
    | 'left'
    | 'right'" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "padding": { "type": { "name": "enum", "description": "'checkbox'
    | 'none'
    | 'normal'" - } + }, + "additionalPropsInfo": {} }, - "scope": { "type": { "name": "string" } }, + "scope": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" - } + }, + "additionalPropsInfo": {} }, "sortDirection": { - "type": { "name": "enum", "description": "'asc'
    | 'desc'
    | false" } + "type": { "name": "enum", "description": "'asc'
    | 'desc'
    | false" }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'body'
    | 'footer'
    | 'head'
    | string" - } + }, + "additionalPropsInfo": {} } }, "name": "TableCell", diff --git a/docs/pages/material-ui/api/table-container.json b/docs/pages/material-ui/api/table-container.json index 5796d0e836408c..298cc40d5e9870 100644 --- a/docs/pages/material-ui/api/table-container.json +++ b/docs/pages/material-ui/api/table-container.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableContainer", diff --git a/docs/pages/material-ui/api/table-footer.json b/docs/pages/material-ui/api/table-footer.json index 166e43607fca66..3614ee6b24a34e 100644 --- a/docs/pages/material-ui/api/table-footer.json +++ b/docs/pages/material-ui/api/table-footer.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableFooter", diff --git a/docs/pages/material-ui/api/table-head.json b/docs/pages/material-ui/api/table-head.json index dde885c58fab5c..cb29fe6ce28327 100644 --- a/docs/pages/material-ui/api/table-head.json +++ b/docs/pages/material-ui/api/table-head.json @@ -1,13 +1,14 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableHead", diff --git a/docs/pages/material-ui/api/table-pagination.json b/docs/pages/material-ui/api/table-pagination.json index 58a483dd96c8d8..8a8949418636cb 100644 --- a/docs/pages/material-ui/api/table-pagination.json +++ b/docs/pages/material-ui/api/table-pagination.json @@ -1,39 +1,83 @@ { "props": { - "count": { "type": { "name": "custom", "description": "integer" }, "required": true }, - "onPageChange": { "type": { "name": "func" }, "required": true }, - "page": { "type": { "name": "custom", "description": "integer" }, "required": true }, - "rowsPerPage": { "type": { "name": "custom", "description": "integer" }, "required": true }, - "ActionsComponent": { "type": { "name": "elementType" }, "default": "TablePaginationActions" }, - "backIconButtonProps": { "type": { "name": "object" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "count": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, + "onPageChange": { + "type": { "name": "func" }, + "required": true, + "signature": { + "type": "function(event: React.MouseEvent | null, page: number) => void", + "describedArgs": ["event", "page"] + }, + "additionalPropsInfo": {} + }, + "page": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, + "rowsPerPage": { + "type": { "name": "custom", "description": "integer" }, + "required": true, + "additionalPropsInfo": {} + }, + "ActionsComponent": { + "type": { "name": "elementType" }, + "default": "TablePaginationActions", + "additionalPropsInfo": {} + }, + "backIconButtonProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "getItemAriaLabel": { "type": { "name": "func" }, - "default": "function defaultGetAriaLabel(type) {\n return `Go to ${type} page`;\n}" + "default": "function defaultGetAriaLabel(type) {\n return `Go to ${type} page`;\n}", + "signature": { "type": "function(type: string) => string", "describedArgs": ["type"] }, + "additionalPropsInfo": {} }, "labelDisplayedRows": { "type": { "name": "func" }, - "default": "function defaultLabelDisplayedRows({ from, to, count }) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}" + "default": "function defaultLabelDisplayedRows({ from, to, count }) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}", + "additionalPropsInfo": {} + }, + "labelRowsPerPage": { + "type": { "name": "node" }, + "default": "'Rows per page:'", + "additionalPropsInfo": {} + }, + "nextIconButtonProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "onRowsPerPageChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.ChangeEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} }, - "labelRowsPerPage": { "type": { "name": "node" }, "default": "'Rows per page:'" }, - "nextIconButtonProps": { "type": { "name": "object" } }, - "onRowsPerPageChange": { "type": { "name": "func" } }, "rowsPerPageOptions": { "type": { "name": "arrayOf", "description": "Array<number
    | { label: string, value: number }>" }, - "default": "[10, 25, 50, 100]" + "default": "[10, 25, 50, 100]", + "additionalPropsInfo": {} + }, + "SelectProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "showFirstButton": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} }, - "SelectProps": { "type": { "name": "object" }, "default": "{}" }, - "showFirstButton": { "type": { "name": "bool" }, "default": "false" }, - "showLastButton": { "type": { "name": "bool" }, "default": "false" }, + "showLastButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TablePagination", diff --git a/docs/pages/material-ui/api/table-row.json b/docs/pages/material-ui/api/table-row.json index d0564f779b6062..35e5eb05d34e04 100644 --- a/docs/pages/material-ui/api/table-row.json +++ b/docs/pages/material-ui/api/table-row.json @@ -1,15 +1,16 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "hover": { "type": { "name": "bool" }, "default": "false" }, - "selected": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "hover": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableRow", diff --git a/docs/pages/material-ui/api/table-sort-label.json b/docs/pages/material-ui/api/table-sort-label.json index 85d2b1c9c744df..3a23429209a1dd 100644 --- a/docs/pages/material-ui/api/table-sort-label.json +++ b/docs/pages/material-ui/api/table-sort-label.json @@ -1,19 +1,25 @@ { "props": { - "active": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "active": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "direction": { "type": { "name": "enum", "description": "'asc'
    | 'desc'" }, - "default": "'asc'" + "default": "'asc'", + "additionalPropsInfo": {} + }, + "hideSortIcon": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "IconComponent": { + "type": { "name": "elementType" }, + "default": "ArrowDownwardIcon", + "additionalPropsInfo": {} }, - "hideSortIcon": { "type": { "name": "bool" }, "default": "false" }, - "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDownwardIcon" }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TableSortLabel", diff --git a/docs/pages/material-ui/api/table.json b/docs/pages/material-ui/api/table.json index f9b49069d99645..4b576985f3a3d7 100644 --- a/docs/pages/material-ui/api/table.json +++ b/docs/pages/material-ui/api/table.json @@ -1,28 +1,31 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "padding": { "type": { "name": "enum", "description": "'checkbox'
    | 'none'
    | 'normal'" }, - "default": "'normal'" + "default": "'normal'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, - "stickyHeader": { "type": { "name": "bool" }, "default": "false" }, + "stickyHeader": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Table", diff --git a/docs/pages/material-ui/api/tabs.json b/docs/pages/material-ui/api/tabs.json index 9cb307a213d0f6..953121ec75bee3 100644 --- a/docs/pages/material-ui/api/tabs.json +++ b/docs/pages/material-ui/api/tabs.json @@ -1,69 +1,104 @@ { "props": { - "action": { "type": { "name": "custom", "description": "ref" } }, - "allowScrollButtonsMobile": { "type": { "name": "bool" }, "default": "false" }, - "aria-label": { "type": { "name": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "centered": { "type": { "name": "bool" }, "default": "false" }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, + "action": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "allowScrollButtonsMobile": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "aria-label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "centered": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "indicatorColor": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} + }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: any) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} }, - "onChange": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} + }, + "ScrollButtonComponent": { + "type": { "name": "elementType" }, + "default": "TabScrollButton", + "additionalPropsInfo": {} }, - "ScrollButtonComponent": { "type": { "name": "elementType" }, "default": "TabScrollButton" }, "scrollButtons": { "type": { "name": "enum", "description": "'auto'
    | false
    | true" }, - "default": "'auto'" + "default": "'auto'", + "additionalPropsInfo": {} }, - "selectionFollowsFocus": { "type": { "name": "bool" } }, + "selectionFollowsFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ endScrollButtonIcon?: func
    | object, startScrollButtonIcon?: func
    | object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ EndScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TabIndicatorProps": { + "type": { "name": "object" }, + "default": "{}", + "additionalPropsInfo": {} + }, + "TabScrollButtonProps": { + "type": { "name": "object" }, + "default": "{}", + "additionalPropsInfo": {} }, - "TabIndicatorProps": { "type": { "name": "object" }, "default": "{}" }, - "TabScrollButtonProps": { "type": { "name": "object" }, "default": "{}" }, "textColor": { "type": { "name": "enum", "description": "'inherit'
    | 'primary'
    | 'secondary'" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "value": { "type": { "name": "any" } }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'fullWidth'
    | 'scrollable'
    | 'standard'" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} }, - "visibleScrollbar": { "type": { "name": "bool" }, "default": "false" } + "visibleScrollbar": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + } }, "name": "Tabs", "styles": { diff --git a/docs/pages/material-ui/api/text-field.json b/docs/pages/material-ui/api/text-field.json index e74c574e518c73..151bed48a71061 100644 --- a/docs/pages/material-ui/api/text-field.json +++ b/docs/pages/material-ui/api/text-field.json @@ -1,64 +1,82 @@ { "props": { - "autoComplete": { "type": { "name": "string" } }, - "autoFocus": { "type": { "name": "bool" }, "default": "false" }, - "classes": { "type": { "name": "object" } }, + "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'" + "default": "'primary'", + "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "error": { "type": { "name": "bool" }, "default": "false" }, - "FormHelperTextProps": { "type": { "name": "object" } }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "helperText": { "type": { "name": "node" } }, - "id": { "type": { "name": "string" } }, - "InputLabelProps": { "type": { "name": "object" } }, - "inputProps": { "type": { "name": "object" } }, - "InputProps": { "type": { "name": "object" } }, - "inputRef": { "type": { "name": "custom", "description": "ref" } }, - "label": { "type": { "name": "node" } }, + "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "FormHelperTextProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "helperText": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "InputLabelProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "InputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'
    | 'normal'" }, - "default": "'none'" + "default": "'none'", + "additionalPropsInfo": {} }, - "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, - "minRows": { "type": { "name": "union", "description": "number
    | string" } }, - "multiline": { "type": { "name": "bool" }, "default": "false" }, - "name": { "type": { "name": "string" } }, - "onChange": { "type": { "name": "func" } }, - "placeholder": { "type": { "name": "string" } }, - "required": { "type": { "name": "bool" }, "default": "false" }, - "rows": { "type": { "name": "union", "description": "number
    | string" } }, - "select": { "type": { "name": "bool" }, "default": "false" }, - "SelectProps": { "type": { "name": "object" } }, + "maxRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "minRows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, + "additionalPropsInfo": {} + }, + "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "rows": { + "type": { "name": "union", "description": "number
    | string" }, + "additionalPropsInfo": {} + }, + "select": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "SelectProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" } }, - "value": { "type": { "name": "any" } }, + "type": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" }, - "default": "'outlined'" + "default": "'outlined'", + "additionalPropsInfo": {} } }, "name": "TextField", diff --git a/docs/pages/material-ui/api/timeline-connector.json b/docs/pages/material-ui/api/timeline-connector.json index 1e487e5e0a4cf0..4f7b1b0323b5b7 100644 --- a/docs/pages/material-ui/api/timeline-connector.json +++ b/docs/pages/material-ui/api/timeline-connector.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TimelineConnector", diff --git a/docs/pages/material-ui/api/timeline-content.json b/docs/pages/material-ui/api/timeline-content.json index b7a913412b8b9d..1d798e23c1fc8c 100644 --- a/docs/pages/material-ui/api/timeline-content.json +++ b/docs/pages/material-ui/api/timeline-content.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TimelineContent", diff --git a/docs/pages/material-ui/api/timeline-dot.json b/docs/pages/material-ui/api/timeline-dot.json index 9ea0ca5a30d5d1..274ff93fde8033 100644 --- a/docs/pages/material-ui/api/timeline-dot.json +++ b/docs/pages/material-ui/api/timeline-dot.json @@ -1,26 +1,29 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'error'
    | 'grey'
    | 'info'
    | 'inherit'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'grey'" + "default": "'grey'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'filled'
    | 'outlined'
    | string" }, - "default": "'filled'" + "default": "'filled'", + "additionalPropsInfo": {} } }, "name": "TimelineDot", diff --git a/docs/pages/material-ui/api/timeline-item.json b/docs/pages/material-ui/api/timeline-item.json index ced818dac2016d..09850f35378b7c 100644 --- a/docs/pages/material-ui/api/timeline-item.json +++ b/docs/pages/material-ui/api/timeline-item.json @@ -1,13 +1,17 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "position": { "type": { "name": "enum", "description": "'left'
    | 'right'" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "position": { + "type": { "name": "enum", "description": "'left'
    | 'right'" }, + "additionalPropsInfo": {} + }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TimelineItem", diff --git a/docs/pages/material-ui/api/timeline-opposite-content.json b/docs/pages/material-ui/api/timeline-opposite-content.json index eae159e827f2f7..b6073c5920f715 100644 --- a/docs/pages/material-ui/api/timeline-opposite-content.json +++ b/docs/pages/material-ui/api/timeline-opposite-content.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TimelineOppositeContent", diff --git a/docs/pages/material-ui/api/timeline-separator.json b/docs/pages/material-ui/api/timeline-separator.json index 5c3aa1b72e1fec..72fcf22715b766 100644 --- a/docs/pages/material-ui/api/timeline-separator.json +++ b/docs/pages/material-ui/api/timeline-separator.json @@ -1,12 +1,13 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TimelineSeparator", diff --git a/docs/pages/material-ui/api/timeline.json b/docs/pages/material-ui/api/timeline.json index 866c82757dbf0e..34c674d30b7e6a 100644 --- a/docs/pages/material-ui/api/timeline.json +++ b/docs/pages/material-ui/api/timeline.json @@ -1,20 +1,22 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "className": { "type": { "name": "string" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, "position": { "type": { "name": "enum", "description": "'alternate'
    | 'left'
    | 'right'" }, - "default": "'right'" + "default": "'right'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Timeline", diff --git a/docs/pages/material-ui/api/toggle-button-group.json b/docs/pages/material-ui/api/toggle-button-group.json index 2efa227b1ab22f..1d7ffe7422ecd8 100644 --- a/docs/pages/material-ui/api/toggle-button-group.json +++ b/docs/pages/material-ui/api/toggle-button-group.json @@ -1,36 +1,47 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'standard'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} + }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "exclusive": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.MouseEvent, value: any) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "exclusive": { "type": { "name": "bool" }, "default": "false" }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'" + "default": "'horizontal'", + "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" } } + "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } }, "name": "ToggleButtonGroup", "styles": { diff --git a/docs/pages/material-ui/api/toggle-button.json b/docs/pages/material-ui/api/toggle-button.json index cb50842361d84e..f4fd26341caff3 100644 --- a/docs/pages/material-ui/api/toggle-button.json +++ b/docs/pages/material-ui/api/toggle-button.json @@ -1,34 +1,55 @@ { "props": { - "value": { "type": { "name": "any" }, "required": true }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, + "value": { "type": { "name": "any" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'standard'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'standard'" + "default": "'standard'", + "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, - "disableRipple": { "type": { "name": "bool" }, "default": "false" }, - "fullWidth": { "type": { "name": "bool" }, "default": "false" }, - "onChange": { "type": { "name": "func" } }, - "onClick": { "type": { "name": "func" } }, - "selected": { "type": { "name": "bool" } }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableFocusRipple": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onChange": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.MouseEvent, value: any) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "onClick": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.MouseEvent, value: any) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "selected": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'" + "default": "'medium'", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "ToggleButton", diff --git a/docs/pages/material-ui/api/toolbar.json b/docs/pages/material-ui/api/toolbar.json index 62b4369de000e3..5203185fdbb155 100644 --- a/docs/pages/material-ui/api/toolbar.json +++ b/docs/pages/material-ui/api/toolbar.json @@ -1,21 +1,23 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disableGutters": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'dense'
    | 'regular'
    | string" }, - "default": "'regular'" + "default": "'regular'", + "additionalPropsInfo": {} } }, "name": "Toolbar", diff --git a/docs/pages/material-ui/api/tooltip.json b/docs/pages/material-ui/api/tooltip.json index 7ae2d147509d10..f6090d25c5384b 100644 --- a/docs/pages/material-ui/api/tooltip.json +++ b/docs/pages/material-ui/api/tooltip.json @@ -1,69 +1,125 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "arrow": { "type": { "name": "bool" }, "default": "false" }, - "classes": { "type": { "name": "object" } }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "arrow": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "components": { "type": { "name": "shape", "description": "{ Arrow?: elementType, Popper?: elementType, Tooltip?: elementType, Transition?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "componentsProps": { "type": { "name": "shape", "description": "{ arrow?: object, popper?: object, tooltip?: object, transition?: object }" }, - "default": "{}" - }, - "describeChild": { "type": { "name": "bool" }, "default": "false" }, - "disableFocusListener": { "type": { "name": "bool" }, "default": "false" }, - "disableHoverListener": { "type": { "name": "bool" }, "default": "false" }, - "disableInteractive": { "type": { "name": "bool" }, "default": "false" }, - "disableTouchListener": { "type": { "name": "bool" }, "default": "false" }, - "enterDelay": { "type": { "name": "number" }, "default": "100" }, - "enterNextDelay": { "type": { "name": "number" }, "default": "0" }, - "enterTouchDelay": { "type": { "name": "number" }, "default": "700" }, - "followCursor": { "type": { "name": "bool" }, "default": "false" }, - "id": { "type": { "name": "string" } }, - "leaveDelay": { "type": { "name": "number" }, "default": "0" }, - "leaveTouchDelay": { "type": { "name": "number" }, "default": "1500" }, - "onClose": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, + "default": "{}", + "additionalPropsInfo": {} + }, + "describeChild": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disableFocusListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableHoverListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableInteractive": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableTouchListener": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "enterDelay": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, + "enterNextDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "enterTouchDelay": { + "type": { "name": "number" }, + "default": "700", + "additionalPropsInfo": {} + }, + "followCursor": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "leaveDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, + "leaveTouchDelay": { + "type": { "name": "number" }, + "default": "1500", + "additionalPropsInfo": {} + }, + "onClose": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "onOpen": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent) => void", + "describedArgs": ["event"] + }, + "additionalPropsInfo": {} + }, + "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "placement": { "type": { "name": "enum", "description": "'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'" + "default": "'bottom'", + "additionalPropsInfo": {} }, - "PopperComponent": { "type": { "name": "elementType" }, "default": "Popper" }, - "PopperProps": { "type": { "name": "object" }, "default": "{}" }, + "PopperComponent": { + "type": { "name": "elementType" }, + "default": "Popper", + "additionalPropsInfo": {} + }, + "PopperProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, "slotProps": { "type": { "name": "shape", "description": "{ arrow?: object, popper?: object, tooltip?: object, transition?: object }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "slots": { "type": { "name": "shape", "description": "{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }" }, - "default": "{}" + "default": "{}", + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "title": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Grow", + "additionalPropsInfo": {} }, - "title": { "type": { "name": "node" } }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "Tooltip", "styles": { diff --git a/docs/pages/material-ui/api/tree-item.json b/docs/pages/material-ui/api/tree-item.json index 15e7915e54275f..3fcb668dd2821d 100644 --- a/docs/pages/material-ui/api/tree-item.json +++ b/docs/pages/material-ui/api/tree-item.json @@ -1,28 +1,37 @@ { "props": { - "nodeId": { "type": { "name": "string" }, "required": true }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "collapseIcon": { "type": { "name": "node" } }, + "nodeId": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "collapseIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "ContentComponent": { "type": { "name": "custom", "description": "element type" }, - "default": "TreeItemContent" + "default": "TreeItemContent", + "additionalPropsInfo": {} + }, + "ContentProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "endIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "expandIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "onFocus": { + "type": { "name": "custom", "description": "unsupportedProp" }, + "additionalPropsInfo": {} }, - "ContentProps": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" }, "default": "false" }, - "endIcon": { "type": { "name": "node" } }, - "expandIcon": { "type": { "name": "node" } }, - "icon": { "type": { "name": "node" } }, - "label": { "type": { "name": "node" } }, - "onFocus": { "type": { "name": "custom", "description": "unsupportedProp" } }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } + }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Collapse", + "additionalPropsInfo": {} }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Collapse" }, - "TransitionProps": { "type": { "name": "object" } } + "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } }, "name": "TreeItem", "styles": { diff --git a/docs/pages/material-ui/api/tree-view.json b/docs/pages/material-ui/api/tree-view.json index a423dd7c0916ff..92677a6cc6e07f 100644 --- a/docs/pages/material-ui/api/tree-view.json +++ b/docs/pages/material-ui/api/tree-view.json @@ -1,35 +1,71 @@ { "props": { - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "defaultCollapseIcon": { "type": { "name": "node" } }, - "defaultEndIcon": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "defaultCollapseIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultEndIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "defaultExpanded": { "type": { "name": "arrayOf", "description": "Array<string>" }, - "default": "[]" + "default": "[]", + "additionalPropsInfo": {} }, - "defaultExpandIcon": { "type": { "name": "node" } }, - "defaultParentIcon": { "type": { "name": "node" } }, + "defaultExpandIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultParentIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "defaultSelected": { "type": { "name": "union", "description": "Array<string>
    | string" }, - "default": "[]" - }, - "disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" }, - "disableSelection": { "type": { "name": "bool" }, "default": "false" }, - "expanded": { "type": { "name": "arrayOf", "description": "Array<string>" } }, - "id": { "type": { "name": "string" } }, - "multiSelect": { "type": { "name": "bool" }, "default": "false" }, - "onNodeFocus": { "type": { "name": "func" } }, - "onNodeSelect": { "type": { "name": "func" } }, - "onNodeToggle": { "type": { "name": "func" } }, + "default": "[]", + "additionalPropsInfo": {} + }, + "disabledItemsFocusable": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "disableSelection": { + "type": { "name": "bool" }, + "default": "false", + "additionalPropsInfo": {} + }, + "expanded": { + "type": { "name": "arrayOf", "description": "Array<string>" }, + "additionalPropsInfo": {} + }, + "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "multiSelect": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "onNodeFocus": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, value: string) => void", + "describedArgs": ["event", "value"] + }, + "additionalPropsInfo": {} + }, + "onNodeSelect": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, nodeIds: Array | string) => void", + "describedArgs": ["event", "nodeIds"] + }, + "additionalPropsInfo": {} + }, + "onNodeToggle": { + "type": { "name": "func" }, + "signature": { + "type": "function(event: React.SyntheticEvent, nodeIds: array) => void", + "describedArgs": ["event", "nodeIds"] + }, + "additionalPropsInfo": {} + }, "selected": { - "type": { "name": "union", "description": "Array<string>
    | string" } + "type": { "name": "union", "description": "Array<string>
    | string" }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "TreeView", diff --git a/docs/pages/material-ui/api/typography.json b/docs/pages/material-ui/api/typography.json index 1c85d4a8fd0e5c..77d4928fe472b9 100644 --- a/docs/pages/material-ui/api/typography.json +++ b/docs/pages/material-ui/api/typography.json @@ -5,30 +5,34 @@ "name": "enum", "description": "'center'
    | 'inherit'
    | 'justify'
    | 'left'
    | 'right'" }, - "default": "'inherit'" + "default": "'inherit'", + "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" } }, - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "gutterBottom": { "type": { "name": "bool" }, "default": "false" }, - "noWrap": { "type": { "name": "bool" }, "default": "false" }, - "paragraph": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "gutterBottom": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "noWrap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "paragraph": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, "variant": { "type": { "name": "union", "description": "'body1'
    | 'body2'
    | 'button'
    | 'caption'
    | 'h1'
    | 'h2'
    | 'h3'
    | 'h4'
    | 'h5'
    | 'h6'
    | 'inherit'
    | 'overline'
    | 'subtitle1'
    | 'subtitle2'
    | string" }, - "default": "'body1'" + "default": "'body1'", + "additionalPropsInfo": {} }, "variantMapping": { "type": { "name": "object" }, - "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n subtitle1: 'h6',\n subtitle2: 'h6',\n body1: 'p',\n body2: 'p',\n inherit: 'p',\n}" + "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n subtitle1: 'h6',\n subtitle2: 'h6',\n body1: 'p',\n body2: 'p',\n inherit: 'p',\n}", + "additionalPropsInfo": {} } }, "name": "Typography", diff --git a/docs/pages/material-ui/api/zoom.json b/docs/pages/material-ui/api/zoom.json index 38a6f4b55ff8d3..e1f4bf4135cff9 100644 --- a/docs/pages/material-ui/api/zoom.json +++ b/docs/pages/material-ui/api/zoom.json @@ -1,21 +1,27 @@ { "props": { - "children": { "type": { "name": "custom", "description": "element" }, "required": true }, - "addEndListener": { "type": { "name": "func" } }, - "appear": { "type": { "name": "bool" }, "default": "true" }, + "children": { + "type": { "name": "custom", "description": "element" }, + "required": true, + "additionalPropsInfo": {} + }, + "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" - } + }, + "additionalPropsInfo": {} }, - "in": { "type": { "name": "bool" } }, + "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "timeout": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", + "additionalPropsInfo": {} } }, "name": "Zoom", diff --git a/docs/pages/system/api/box.json b/docs/pages/system/api/box.json index 7e923c5eb25b0a..4eeb2a418ee964 100644 --- a/docs/pages/system/api/box.json +++ b/docs/pages/system/api/box.json @@ -1,11 +1,12 @@ { "props": { - "component": { "type": { "name": "elementType" } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Box", diff --git a/docs/pages/system/api/container.json b/docs/pages/system/api/container.json index 4a1dfae169ea41..181d1cf4649b6e 100644 --- a/docs/pages/system/api/container.json +++ b/docs/pages/system/api/container.json @@ -1,20 +1,22 @@ { "props": { - "classes": { "type": { "name": "object" } }, - "component": { "type": { "name": "elementType" } }, - "disableGutters": { "type": { "name": "bool" } }, - "fixed": { "type": { "name": "bool" } }, + "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "disableGutters": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "fixed": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "maxWidth": { "type": { "name": "union", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | false
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } } }, "name": "Container", diff --git a/docs/pages/system/api/grid.json b/docs/pages/system/api/grid.json index 241eff5da0f4b9..e22817cab252b3 100644 --- a/docs/pages/system/api/grid.json +++ b/docs/pages/system/api/grid.json @@ -1,64 +1,105 @@ { "props": { - "children": { "type": { "name": "node" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "columns": { "type": { "name": "union", "description": "Array<number>
    | number
    | object" - } + }, + "additionalPropsInfo": {} }, "columnSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, - "container": { "type": { "name": "bool" } }, + "container": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - } + }, + "additionalPropsInfo": {} }, - "disableEqualOverflow": { "type": { "name": "bool" } }, + "disableEqualOverflow": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, "lg": { - "type": { "name": "union", "description": "'auto'
    | number
    | bool" } + "type": { + "name": "union", + "description": "'auto'
    | number
    | bool" + }, + "additionalPropsInfo": {} + }, + "lgOffset": { + "type": { "name": "union", "description": "'auto'
    | number" }, + "additionalPropsInfo": {} }, - "lgOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "md": { - "type": { "name": "union", "description": "'auto'
    | number
    | bool" } + "type": { + "name": "union", + "description": "'auto'
    | number
    | bool" + }, + "additionalPropsInfo": {} + }, + "mdOffset": { + "type": { "name": "union", "description": "'auto'
    | number" }, + "additionalPropsInfo": {} }, - "mdOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "rowSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "sm": { - "type": { "name": "union", "description": "'auto'
    | number
    | bool" } + "type": { + "name": "union", + "description": "'auto'
    | number
    | bool" + }, + "additionalPropsInfo": {} + }, + "smOffset": { + "type": { "name": "union", "description": "'auto'
    | number" }, + "additionalPropsInfo": {} }, - "smOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "wrap": { "type": { "name": "enum", "description": "'nowrap'
    | 'wrap-reverse'
    | 'wrap'" - } + }, + "additionalPropsInfo": {} }, "xl": { - "type": { "name": "union", "description": "'auto'
    | number
    | bool" } + "type": { + "name": "union", + "description": "'auto'
    | number
    | bool" + }, + "additionalPropsInfo": {} + }, + "xlOffset": { + "type": { "name": "union", "description": "'auto'
    | number" }, + "additionalPropsInfo": {} }, - "xlOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "xs": { - "type": { "name": "union", "description": "'auto'
    | number
    | bool" } + "type": { + "name": "union", + "description": "'auto'
    | number
    | bool" + }, + "additionalPropsInfo": {} }, - "xsOffset": { "type": { "name": "union", "description": "'auto'
    | number" } } + "xsOffset": { + "type": { "name": "union", "description": "'auto'
    | number" }, + "additionalPropsInfo": {} + } }, "name": "Grid", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/system/api/stack.json b/docs/pages/system/api/stack.json index 7818d6c704f07a..4143214bbd12bc 100644 --- a/docs/pages/system/api/stack.json +++ b/docs/pages/system/api/stack.json @@ -1,27 +1,30 @@ { "props": { - "children": { "type": { "name": "node" } }, - "component": { "type": { "name": "elementType" } }, + "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - } + }, + "additionalPropsInfo": {} }, - "divider": { "type": { "name": "node" } }, + "divider": { "type": { "name": "node" }, "additionalPropsInfo": {} }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - } + }, + "additionalPropsInfo": {} }, "sx": { "type": { "name": "union", "description": "Array<func
    | object
    | bool>
    | func
    | object" - } + }, + "additionalPropsInfo": { "sx": true } }, - "useFlexGap": { "type": { "name": "bool" } } + "useFlexGap": { "type": { "name": "bool" }, "additionalPropsInfo": {} } }, "name": "Stack", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/translations/api-docs-base/badge/badge.json b/docs/translations/api-docs-base/badge/badge.json index 7b35413dae7ceb..79d407a0d1ecd5 100644 --- a/docs/translations/api-docs-base/badge/badge.json +++ b/docs/translations/api-docs-base/badge/badge.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "badgeContent": "The content rendered within the badge.", - "children": "The badge will be added relative to this node.", - "invisible": "If true, the badge is invisible.", - "max": "Max count to show.", - "showZero": "Controls whether the badge is hidden when badgeContent is zero.", - "slotProps": "The props used for each slot inside the Badge.", - "slots": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component. See Slots API below for more details." + "badgeContent": { + "description": "The content rendered within the badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The badge will be added relative to this node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invisible": { + "description": "If true, the badge is invisible.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "Max count to show.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "showZero": { + "description": "Controls whether the badge is hidden when badgeContent is zero.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/button/button.json b/docs/translations/api-docs-base/button/button.json index e880be5b3dbae4..439fbaabf50d24 100644 --- a/docs/translations/api-docs-base/button/button.json +++ b/docs/translations/api-docs-base/button/button.json @@ -1,11 +1,36 @@ { "componentDescription": "The foundation for building custom-styled buttons.", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "disabled": "If true, the component is disabled.", - "focusableWhenDisabled": "If true, allows a disabled button to receive focus.", - "slotProps": "The props used for each slot inside the Button.", - "slots": "The components used for each slot inside the Button. Either a string to use a HTML element or a component. See Slots API below for more details." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusableWhenDisabled": { + "description": "If true, allows a disabled button to receive focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Button.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Button. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json index 2b75252afc3139..9439b9aca8852e 100644 --- a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json +++ b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json @@ -1,11 +1,36 @@ { "componentDescription": "Listen for click events that occur somewhere in the document, outside of the element itself.\nFor instance, if you need to hide a menu when people click anywhere else on your page.", "propDescriptions": { - "children": "The wrapped element.
    ⚠️ Needs to be able to hold a ref.", - "disableReactTree": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled.", - "mouseEvent": "The mouse event to listen to. You can disable the listener by providing false.", - "onClickAway": "Callback fired when a "click away" event is detected.", - "touchEvent": "The touch event to listen to. You can disable the listener by providing false." + "children": { + "description": "The wrapped element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "disableReactTree": { + "description": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "mouseEvent": { + "description": "The mouse event to listen to. You can disable the listener by providing false.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClickAway": { + "description": "Callback fired when a "click away" event is detected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "touchEvent": { + "description": "The touch event to listen to. You can disable the listener by providing false.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/focus-trap/focus-trap.json b/docs/translations/api-docs-base/focus-trap/focus-trap.json index 999dd0d4670234..ec3e41a7fedae6 100644 --- a/docs/translations/api-docs-base/focus-trap/focus-trap.json +++ b/docs/translations/api-docs-base/focus-trap/focus-trap.json @@ -1,13 +1,48 @@ { "componentDescription": "Utility component that locks focus inside the component.", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "disableAutoFocus": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", - "disableEnforceFocus": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", - "disableRestoreFocus": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", - "getTabbable": "Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency.

    Signature:
    function(root: HTMLElement) => void
    ", - "isEnabled": "This prop extends the open prop. It allows to toggle the open state without having to wait for a rerender when changing the open prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time.", - "open": "If true, focus is locked." + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAutoFocus": { + "description": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEnforceFocus": { + "description": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRestoreFocus": { + "description": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getTabbable": { + "description": "Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "isEnabled": { + "description": "This prop extends the open prop. It allows to toggle the open state without having to wait for a rerender when changing the open prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "open": { + "description": "If true, focus is locked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/form-control/form-control.json b/docs/translations/api-docs-base/form-control/form-control.json index 639969fc0126a0..6efe0f0edbc06b 100644 --- a/docs/translations/api-docs-base/form-control/form-control.json +++ b/docs/translations/api-docs-base/form-control/form-control.json @@ -1,14 +1,54 @@ { "componentDescription": "Provides context such as filled/focused/error/required for form inputs.\nRelying on the context provides high flexibility and ensures that the state always stays\nconsistent across the children of the `FormControl`.\nThis context is used by the following components:\n\n* FormLabel\n* FormHelperText\n* Input\n* InputLabel\n\nYou can find one composition example below and more going to [the demos](https://mui.com/material-ui/react-text-field/#components).\n\n```jsx\n\n Email address\n \n We'll never share your email.\n\n```\n\n⚠️ Only one `Input` can be used within a FormControl because it create visual inconsistencies.\nFor instance, only one input can be focused at the same time, the state shouldn't be shared.", "propDescriptions": { - "children": "The content of the component.", - "disabled": "If true, the label, input and helper text should be displayed in a disabled state.", - "error": "If true, the label is displayed in an error state.", - "onChange": "Callback fired when the form element's value is modified.", - "required": "If true, the label will indicate that the input is required.", - "slotProps": "The props used for each slot inside the FormControl.", - "slots": "The components used for each slot inside the FormControl. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "The value of the form element." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the label, input and helper text should be displayed in a disabled state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the label is displayed in an error state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the form element's value is modified.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the label will indicate that the input is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the FormControl.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the FormControl. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the form element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/input/input.json b/docs/translations/api-docs-base/input/input.json index 604e11cb95e78e..aec2c96d684243 100644 --- a/docs/translations/api-docs-base/input/input.json +++ b/docs/translations/api-docs-base/input/input.json @@ -1,27 +1,132 @@ { "componentDescription": "", "propDescriptions": { - "autoComplete": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "autoFocus": "If true, the input element is focused during the first mount.", - "className": "Class name applied to the root element.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "endAdornment": "Trailing adornment for this input.", - "error": "If true, the input will indicate an error by setting the aria-invalid attribute on the input and the Mui-error class on the root element. The prop defaults to the value (false) inherited from the parent FormControl component.", - "id": "The id of the input element.", - "maxRows": "Maximum number of rows to display when multiline option is set to true.", - "minRows": "Minimum number of rows to display when multiline option is set to true.", - "multiline": "If true, a textarea element is rendered.", - "name": "Name attribute of the input element.", - "placeholder": "The short hint displayed in the input before the user enters a value.", - "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", - "required": "If true, the input element is required. The prop defaults to the value (false) 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. See Slots API below for more details.", - "startAdornment": "Leading adornment for this input.", - "type": "Type of the input element. It should be a valid HTML5 input type.", - "value": "The value of the input element, required for a controlled component." + "autoComplete": { + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the input element is focused during the first mount.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "className": { + "description": "Class name applied to the root element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endAdornment": { + "description": "Trailing adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error by setting the aria-invalid attribute on the input and the Mui-error class on the root element. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "The id of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxRows": { + "description": "Maximum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiline": { + "description": "If true, a textarea element is rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placeholder": { + "description": "The short hint displayed in the input before the user enters a value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "It prevents the user from changing the value of the field (not from interacting with the field).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rows": { + "description": "Number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startAdornment": { + "description": "Leading adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "type": { + "description": "Type of the input element. It should be a valid HTML5 input type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the input element, required for a controlled component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/menu-item/menu-item.json b/docs/translations/api-docs-base/menu-item/menu-item.json index 4582dbc3a635eb..5037be1e75f5fe 100644 --- a/docs/translations/api-docs-base/menu-item/menu-item.json +++ b/docs/translations/api-docs-base/menu-item/menu-item.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "label": "A text representation of the menu item's content. Used for keyboard text navigation matching.", - "slotProps": "The props used for each slot inside the MenuItem.", - "slots": "The components used for each slot inside the MenuItem. Either a string to use a HTML element or a component. See Slots API below for more details." + "label": { + "description": "A text representation of the menu item's content. Used for keyboard text navigation matching.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the MenuItem.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the MenuItem. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/menu/menu.json b/docs/translations/api-docs-base/menu/menu.json index 3c132b59c33c47..b7227a862e9435 100644 --- a/docs/translations/api-docs-base/menu/menu.json +++ b/docs/translations/api-docs-base/menu/menu.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "actions": "A ref with imperative actions. It allows to select the first or last menu item.", - "anchorEl": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper.", - "onOpenChange": "Triggered when focus leaves the menu and the menu should close.", - "open": "Controls whether the menu is displayed.", - "slotProps": "The props used for each slot inside the Menu.", - "slots": "The components used for each slot inside the Menu. Either a string to use a HTML element or a component. See Slots API below for more details." + "actions": { + "description": "A ref with imperative actions. It allows to select the first or last menu item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "anchorEl": { + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onOpenChange": { + "description": "Triggered when focus leaves the menu and the menu should close.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "open": { + "description": "Controls whether the menu is displayed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Menu.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Menu. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/modal/modal.json b/docs/translations/api-docs-base/modal/modal.json index 2b9d618ebd1f91..c7340361ae0844 100644 --- a/docs/translations/api-docs-base/modal/modal.json +++ b/docs/translations/api-docs-base/modal/modal.json @@ -1,22 +1,105 @@ { "componentDescription": "Modal is a lower-level construct that is leveraged by the following components:\n\n* [Dialog](https://mui.com/material-ui/api/dialog/)\n* [Drawer](https://mui.com/material-ui/api/drawer/)\n* [Menu](https://mui.com/material-ui/api/menu/)\n* [Popover](https://mui.com/material-ui/api/popover/)\n\nIf you are creating a modal dialog, you probably want to use the [Dialog](https://mui.com/material-ui/api/dialog/) component\nrather than directly using Modal.\n\nThis component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "closeAfterTransition": "When set to true the Modal waits until a nested Transition is completed before closing.", - "container": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "disableAutoFocus": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEnforceFocus": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEscapeKeyDown": "If true, hitting escape will not fire the onClose callback.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "disableRestoreFocus": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "disableScrollLock": "Disable the scroll lock behavior.", - "hideBackdrop": "If true, the backdrop is not rendered.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", - "open": "If true, the component is shown.", - "slotProps": "The props used for each slot inside the Modal.", - "slots": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component. See Slots API below for more details." + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "closeAfterTransition": { + "description": "When set to true the Modal waits until a nested Transition is completed before closing.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAutoFocus": { + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEnforceFocus": { + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEscapeKeyDown": { + "description": "If true, hitting escape will not fire the onClose callback.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRestoreFocus": { + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableScrollLock": { + "description": "Disable the scroll lock behavior.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hideBackdrop": { + "description": "If true, the backdrop is not rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onBackdropClick": { + "description": "Callback fired when the backdrop is clicked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "escapeKeyDown", "backdropClick"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Modal.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/no-ssr/no-ssr.json b/docs/translations/api-docs-base/no-ssr/no-ssr.json index 987272b652e3ae..bd21a0a19c01ec 100644 --- a/docs/translations/api-docs-base/no-ssr/no-ssr.json +++ b/docs/translations/api-docs-base/no-ssr/no-ssr.json @@ -1,9 +1,24 @@ { "componentDescription": "NoSsr purposely removes components from the subject of Server Side Rendering (SSR).\n\nThis component can be useful in a variety of situations:\n\n* Escape hatch for broken dependencies not supporting SSR.\n* Improve the time-to-first paint on the client by only rendering above the fold.\n* Reduce the rendering time on the server.\n* Under too heavy server load, you can turn on service degradation.", "propDescriptions": { - "children": "You can wrap a node.", - "defer": "If true, the component will not only prevent server-side rendering. It will also defer the rendering of the children into a different screen frame.", - "fallback": "The fallback content to display." + "children": { + "description": "You can wrap a node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defer": { + "description": "If true, the component will not only prevent server-side rendering. It will also defer the rendering of the children into a different screen frame.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fallback": { + "description": "The fallback content to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/option-group/option-group.json b/docs/translations/api-docs-base/option-group/option-group.json index 2914c0a842eccd..a08cd17cd37380 100644 --- a/docs/translations/api-docs-base/option-group/option-group.json +++ b/docs/translations/api-docs-base/option-group/option-group.json @@ -1,10 +1,30 @@ { "componentDescription": "An unstyled option group to be used within a Select.", "propDescriptions": { - "disabled": "If true all the options in the group will be disabled.", - "label": "The human-readable description of the group.", - "slotProps": "The props used for each slot inside the Input.", - "slots": "The components used for each slot inside the OptionGroup. Either a string to use a HTML element or a component. See Slots API below for more details." + "disabled": { + "description": "If true all the options in the group will be disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "The human-readable description of the group.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the OptionGroup. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/option/option.json b/docs/translations/api-docs-base/option/option.json index 934b7f4c1c0387..a5daa7450bdf35 100644 --- a/docs/translations/api-docs-base/option/option.json +++ b/docs/translations/api-docs-base/option/option.json @@ -1,11 +1,36 @@ { "componentDescription": "An unstyled option to be used within a Select.", "propDescriptions": { - "disabled": "If true, the option will be disabled.", - "label": "A text representation of the option's content. Used for keyboard text navigation matching.", - "slotProps": "The props used for each slot inside the Option.", - "slots": "The components used for each slot inside the Option. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "The value of the option." + "disabled": { + "description": "If true, the option will be disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "A text representation of the option's content. Used for keyboard text navigation matching.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Option.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Option. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the option.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/popper/popper.json b/docs/translations/api-docs-base/popper/popper.json index 2fee1eb3dd079f..bfe44d47faeebe 100644 --- a/docs/translations/api-docs-base/popper/popper.json +++ b/docs/translations/api-docs-base/popper/popper.json @@ -1,20 +1,90 @@ { "componentDescription": "Poppers rely on the 3rd party library [Popper.js](https://popper.js.org/docs/v2/) for positioning.", "propDescriptions": { - "anchorEl": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", - "children": "Popper render function or node.", - "container": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "direction": "Direction of the text.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "modifiers": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "open": "If true, the component is shown.", - "placement": "Popper placement.", - "popperOptions": "Options provided to the Popper.js instance.", - "popperRef": "A ref that points to the used popper instance.", - "slotProps": "The props used for each slot inside the Popper.", - "slots": "The components used for each slot inside the Popper. Either a string to use a HTML element or a component. See Slots API below for more details.", - "transition": "Help supporting a react-transition-group/Transition component." + "anchorEl": { + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Popper render function or node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "Direction of the text.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "modifiers": { + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placement": { + "description": "Popper placement.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "popperOptions": { + "description": "Options provided to the Popper.js instance.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "popperRef": { + "description": "A ref that points to the used popper instance.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Popper.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Popper. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "transition": { + "description": "Help supporting a react-transition-group/Transition component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/portal/portal.json b/docs/translations/api-docs-base/portal/portal.json index 0ceb8af7e1cc38..17d6ce798a3cf5 100644 --- a/docs/translations/api-docs-base/portal/portal.json +++ b/docs/translations/api-docs-base/portal/portal.json @@ -1,9 +1,24 @@ { "componentDescription": "Portals provide a first-class way to render children into a DOM node\nthat exists outside the DOM hierarchy of the parent component.", "propDescriptions": { - "children": "The children to render into the container.", - "container": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component." + "children": { + "description": "The children to render into the container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/select/select.json b/docs/translations/api-docs-base/select/select.json index 6e6f0502e5cfb4..7292c7e7ea8c16 100644 --- a/docs/translations/api-docs-base/select/select.json +++ b/docs/translations/api-docs-base/select/select.json @@ -1,22 +1,102 @@ { "componentDescription": "The foundation for building custom-styled select components.", "propDescriptions": { - "autoFocus": "If true, the select element is focused during the first mount", - "defaultListboxOpen": "If true, the select will be initially open.", - "defaultValue": "The default selected value. Use when the component is not controlled.", - "disabled": "If true, the select is disabled.", - "getOptionAsString": "A function used to convert the option label to a string. It's useful when labels are elements and need to be converted to plain text to enable navigation using character keys on a keyboard.", - "getSerializedValue": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", - "listboxId": "id attribute of the listbox element.", - "listboxOpen": "Controls the open state of the select's listbox.", - "multiple": "If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props.", - "name": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", - "onChange": "Callback fired when an option is selected.", - "onListboxOpenChange": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", - "renderValue": "Function that customizes the rendering of the selected value.", - "slotProps": "The props used for each slot inside the Input.", - "slots": "The components used for each slot inside the Select. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "The selected value. Set to null to deselect all options." + "autoFocus": { + "description": "If true, the select element is focused during the first mount", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultListboxOpen": { + "description": "If true, the select will be initially open.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default selected value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the select is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getOptionAsString": { + "description": "A function used to convert the option label to a string. It's useful when labels are elements and need to be converted to plain text to enable navigation using character keys on a keyboard.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getSerializedValue": { + "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "listboxId": { + "description": "id attribute of the listbox element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "listboxOpen": { + "description": "Controls the open state of the select's listbox.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiple": { + "description": "If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when an option is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onListboxOpenChange": { + "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "renderValue": { + "description": "Function that customizes the rendering of the selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Select. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The selected value. Set to null to deselect all options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/slider/slider.json b/docs/translations/api-docs-base/slider/slider.json index eb3a26a4f433ac..833a1be48254e7 100644 --- a/docs/translations/api-docs-base/slider/slider.json +++ b/docs/translations/api-docs-base/slider/slider.json @@ -1,30 +1,160 @@ { "componentDescription": "", "propDescriptions": { - "aria-label": "The label of the slider.", - "aria-labelledby": "The id of the element containing a label for the slider.", - "aria-valuetext": "A string value that provides a user-friendly name for the current value of the slider.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "disableSwap": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    • index: The thumb label's index to format.
    ", - "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    • value: The thumb label's value to format.
    • index: The thumb label's index to format.
    ", - "isRtl": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", - "marks": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", - "max": "The maximum allowed value of the slider. Should not be equal to min.", - "min": "The minimum allowed value of the slider. Should not be equal to max.", - "name": "Name attribute of the hidden input element.", - "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    • value: The new value.
    • activeThumb: Index of the currently moved thumb.
    ", - "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: The new value.
    ", - "orientation": "The component orientation.", - "scale": "A transformation function, to change the scale of the slider.

    Signature:
    function(x: any) => any
    ", - "slotProps": "The props used for each slot inside the Slider.", - "slots": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component. See Slots API below for more details.", - "step": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", - "tabIndex": "Tab index attribute of the hidden input element.", - "track": "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": "The value of the slider. For ranged sliders, provide an array with two values.", - "valueLabelFormat": "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" + "aria-label": { + "description": "The label of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-labelledby": { + "description": "The id of the element containing a label for the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-valuetext": { + "description": "A string value that provides a user-friendly name for the current value of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSwap": { + "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getAriaLabel": { + "description": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "index": "The thumb label's index to format." } + }, + "getAriaValueText": { + "description": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "value": "The thumb label's value to format.", + "index": "The thumb label's index to format." + } + }, + "isRtl": { + "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "marks": { + "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "The maximum allowed value of the slider. Should not be equal to min.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "min": { + "description": "The minimum allowed value of the slider. Should not be equal to max.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the hidden input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback function that is fired when the slider's value changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.", + "value": "The new value.", + "activeThumb": "Index of the currently moved thumb." + } + }, + "onChangeCommitted": { + "description": "Callback function that is fired when the mouseup is triggered.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. Warning: This is a generic event not a change event.", + "value": "The new value." + } + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "scale": { + "description": "A transformation function, to change the scale of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "step": { + "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "tabIndex": { + "description": "Tab index attribute of the hidden input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "track": { + "description": "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.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the slider. For ranged sliders, provide an array with two values.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "valueLabelFormat": { + "description": "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", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/snackbar/snackbar.json b/docs/translations/api-docs-base/snackbar/snackbar.json index 36580b71397907..1d93e4031e8396 100644 --- a/docs/translations/api-docs-base/snackbar/snackbar.json +++ b/docs/translations/api-docs-base/snackbar/snackbar.json @@ -1,14 +1,57 @@ { "componentDescription": "", "propDescriptions": { - "autoHideDuration": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value.", - "disableWindowBlurListener": "If true, the autoHideDuration timer will expire even if the window is not focused.", - "exited": "The prop used to handle exited transition and unmount the component.", - "onClose": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

    Signature:
    function(event: React.SyntheticEvent<any> | Event, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown".
    ", - "open": "If true, the component is shown.", - "resumeHideDuration": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.", - "slotProps": "The props used for each slot inside the Snackbar.", - "slots": "The components used for each slot inside the Snackbar. Either a string to use a HTML element or a component. See Slots API below for more details." + "autoHideDuration": { + "description": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableWindowBlurListener": { + "description": "If true, the autoHideDuration timer will expire even if the window is not focused.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "exited": { + "description": "The prop used to handle exited transition and unmount the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "resumeHideDuration": { + "description": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Snackbar.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Snackbar. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-base/switch/switch.json b/docs/translations/api-docs-base/switch/switch.json index 663434e38131bc..879e3e1d109442 100644 --- a/docs/translations/api-docs-base/switch/switch.json +++ b/docs/translations/api-docs-base/switch/switch.json @@ -1,14 +1,56 @@ { "componentDescription": "The foundation for building custom-styled switches.", "propDescriptions": { - "checked": "If true, the component is checked.", - "defaultChecked": "The default checked state. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "readOnly": "If true, the component is read only.", - "required": "If true, the input element is required.", - "slotProps": "The props used for each slot inside the Switch.", - "slots": "The components used for each slot inside the Switch. Either a string to use a HTML element or a component. See Slots API below for more details." + "checked": { + "description": "If true, the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultChecked": { + "description": "The default checked state. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "readOnly": { + "description": "If true, the component is read only.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Switch.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Switch. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class applied to the root element." }, diff --git a/docs/translations/api-docs-base/tab-panel/tab-panel.json b/docs/translations/api-docs-base/tab-panel/tab-panel.json index e3a53028925fc9..b86ea6982b259c 100644 --- a/docs/translations/api-docs-base/tab-panel/tab-panel.json +++ b/docs/translations/api-docs-base/tab-panel/tab-panel.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "slotProps": "The props used for each slot inside the TabPanel.", - "slots": "The components used for each slot inside the TabPanel. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected. If not provided, it will fall back to the index of the panel. It is recommended to explicitly provide it, as it's required for the tab panel to be rendered on the server." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the TabPanel.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the TabPanel. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected. If not provided, it will fall back to the index of the panel. It is recommended to explicitly provide it, as it's required for the tab panel to be rendered on the server.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/tab/tab.json b/docs/translations/api-docs-base/tab/tab.json index 6b1f4d81a06a29..3eae6494e6d3d8 100644 --- a/docs/translations/api-docs-base/tab/tab.json +++ b/docs/translations/api-docs-base/tab/tab.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "disabled": "If true, the component is disabled.", - "onChange": "Callback invoked when new value is being set.", - "slotProps": "The props used for each slot inside the Tab.", - "slots": "The components used for each slot inside the Tab. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "You can provide your own value. Otherwise, it falls back to the child position index." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback invoked when new value is being set.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Tab.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Tab. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "You can provide your own value. Otherwise, it falls back to the child position index.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/table-pagination/table-pagination.json b/docs/translations/api-docs-base/table-pagination/table-pagination.json index ed6450b2309fe3..1122db08ccf180 100644 --- a/docs/translations/api-docs-base/table-pagination/table-pagination.json +++ b/docs/translations/api-docs-base/table-pagination/table-pagination.json @@ -1,19 +1,89 @@ { "componentDescription": "A pagination for tables.", "propDescriptions": { - "count": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1.", - "getItemAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.

    Signature:
    function(type: string) => string
    • type: The link or button type to format ('first' | 'last' | 'next' | 'previous').
    ", - "labelDisplayedRows": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations.", - "labelId": "Id of the label element within the pagination.", - "labelRowsPerPage": "Customize the rows per page label.
    For localization purposes, you can use the provided translations.", - "onPageChange": "Callback fired when the page is changed.

    Signature:
    function(event: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
    • event: The event source of the callback.
    • page: The page selected.
    ", - "onRowsPerPageChange": "Callback fired when the number of rows per page is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback.
    ", - "page": "The zero-based index of the current page.", - "rowsPerPage": "The number of rows per page.
    Set -1 to display all the rows.", - "rowsPerPageOptions": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.", - "selectId": "Id of the select element within the pagination.", - "slotProps": "The props used for each slot inside the TablePagination.", - "slots": "The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component. See Slots API below for more details." + "count": { + "description": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getItemAriaLabel": { + "description": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "type": "The link or button type to format ('first' | 'last' | 'next' | 'previous')." + } + }, + "labelDisplayedRows": { + "description": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "labelId": { + "description": "Id of the label element within the pagination.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "labelRowsPerPage": { + "description": "Customize the rows per page label.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onPageChange": { + "description": "Callback fired when the page is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "page": "The page selected." + } + }, + "onRowsPerPageChange": { + "description": "Callback fired when the number of rows per page is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "page": { + "description": "The zero-based index of the current page.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rowsPerPage": { + "description": "The number of rows per page.
    Set -1 to display all the rows.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rowsPerPageOptions": { + "description": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selectId": { + "description": "Id of the select element within the pagination.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the TablePagination.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/tabs-list/tabs-list.json b/docs/translations/api-docs-base/tabs-list/tabs-list.json index 9d459303149ef5..3e2fe2454cb0aa 100644 --- a/docs/translations/api-docs-base/tabs-list/tabs-list.json +++ b/docs/translations/api-docs-base/tabs-list/tabs-list.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "slotProps": "The props used for each slot inside the TabsList.", - "slots": "The components used for each slot inside the TabsList. Either a string to use a HTML element or a component. See Slots API below for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the TabsList.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the TabsList. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/tabs/tabs.json b/docs/translations/api-docs-base/tabs/tabs.json index 37fa6685b070b8..2762046f174d0b 100644 --- a/docs/translations/api-docs-base/tabs/tabs.json +++ b/docs/translations/api-docs-base/tabs/tabs.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "defaultValue": "The default value. Use when the component is not controlled.", - "direction": "The direction of the text.", - "onChange": "Callback invoked when new value is being set.", - "orientation": "The component orientation (layout flow direction).", - "selectionFollowsFocus": "If true the selected tab changes on focus. Otherwise it only changes on activation.", - "slotProps": "The props used for each slot inside the Tabs.", - "slots": "The components used for each slot inside the Tabs. Either a string to use a HTML element or a component. See Slots API below for more details.", - "value": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "The direction of the text.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback invoked when new value is being set.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation (layout flow direction).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selectionFollowsFocus": { + "description": "If true the selected tab changes on focus. Otherwise it only changes on activation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Tabs.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Tabs. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json b/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json index 98f8e7a416c8a7..b88136280d5021 100644 --- a/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json +++ b/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json @@ -1,8 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "maxRows": "Maximum number of rows to display.", - "minRows": "Minimum number of rows to display." + "maxRows": { + "description": "Maximum number of rows to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-joy/alert/alert.json b/docs/translations/api-docs-joy/alert/alert.json index 272cde996ffc11..61a2f0a6d97016 100644 --- a/docs/translations/api-docs-joy/alert/alert.json +++ b/docs/translations/api-docs-joy/alert/alert.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "endDecorator": "Element placed after the children.", - "invertedColors": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "role": "The ARIA role attribute of the element.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invertedColors": { + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "role": { + "description": "The ARIA role attribute of the element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json b/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json index ca1a512b1a74ff..207b4ed9f03242 100644 --- a/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json +++ b/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the AspectRatio if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "maxHeight": "The maximum calculated height of the element (not the CSS height).", - "minHeight": "The minimum calculated height of the element (not the CSS height).", - "objectFit": "The CSS object-fit value of the first-child.", - "ratio": "The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. https://caniuse.com/?search=aspect-ratio", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "Used to render icon or text elements inside the AspectRatio if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxHeight": { + "description": "The maximum calculated height of the element (not the CSS height).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minHeight": { + "description": "The minimum calculated height of the element (not the CSS height).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "objectFit": { + "description": "The CSS object-fit value of the first-child.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ratio": { + "description": "The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. https://caniuse.com/?search=aspect-ratio", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json b/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json index 1d2ea890edaa5e..592237b63d130d 100644 --- a/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json +++ b/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component (affect other nested list* components). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component (affect other nested list* components).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json b/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json index ff0b5617dc3048..fd8cae7170617b 100644 --- a/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json +++ b/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/autocomplete/autocomplete.json b/docs/translations/api-docs-joy/autocomplete/autocomplete.json index e033a9d0b7084e..896c1b2b083e5a 100644 --- a/docs/translations/api-docs-joy/autocomplete/autocomplete.json +++ b/docs/translations/api-docs-joy/autocomplete/autocomplete.json @@ -1,58 +1,344 @@ { "componentDescription": "", "propDescriptions": { - "aria-describedby": "Identifies the element (or elements) that describes the object.", - "aria-label": "Defines a string value that labels the current element.", - "aria-labelledby": "Identifies the element (or elements) that labels the current element.", - "autoFocus": "If true, the input element is focused during the first mount.", - "clearIcon": "The icon to display in place of the default clear icon.", - "clearText": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", - "closeText": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disableClearable": "If true, the input can't be cleared.", - "disabled": "If true, the component is disabled.", - "endDecorator": "Trailing adornment for this input.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    • options: The options to render.
    • state: The state of the component.
    ", - "forcePopupIcon": "Force the visibility display of the popup icon.", - "freeSolo": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", - "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: string | number) => ReactNode
    • more: The number of truncated tags.
    ", - "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    • option: The option to test.
    ", - "getOptionLabel": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.

    Signature:
    function(option: T) => string
    ", - "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    • options: The options to group.
    ", - "id": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", - "inputValue": "The input value.", - "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    • option: The option to test.
    • value: The value to test against.
    ", - "limitTags": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", - "loading": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", - "loadingText": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", - "multiple": "If true, value must be an array and the menu will support multiple selections.", - "name": "Name attribute of the input element.", - "noOptionsText": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    • event: The event source of the callback.
    • value: The new value of the component.
    • reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".
    ", - "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
    ", - "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    • event: The event source of the callback.
    • option: The highlighted option.
    • reason: Can be: "keyboard", "auto", "mouse", "touch".
    ", - "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    • event: The event source of the callback.
    • value: The new value of the text input.
    • reason: Can be: "input" (user input), "reset" (programmatic change), "clear".
    ", - "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", - "open": "If true, the component is shown.", - "openText": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", - "options": "Array of options.", - "placeholder": "The input placeholder", - "popupIcon": "The icon to display in place of the default popup icon.", - "readOnly": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    • params: The group to render.
    ", - "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    • props: The props to apply on the li element.
    • option: The option to render.
    • state: The state of the component.
    ", - "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    • value: The value provided to the component.
    • getTagProps: A tag props getter.
    • ownerState: The state of the Autocomplete component.
    ", - "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Leading adornment for this input.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "type": "Type of the input element. It should be a valid HTML5 input type.", - "value": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "aria-describedby": { + "description": "Identifies the element (or elements) that describes the object.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-label": { + "description": "Defines a string value that labels the current element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-labelledby": { + "description": "Identifies the element (or elements) that labels the current element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the input element is focused during the first mount.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearIcon": { + "description": "The icon to display in place of the default clear icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearText": { + "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "closeText": { + "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableClearable": { + "description": "If true, the input can't be cleared.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Trailing adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "filterOptions": { + "description": "A function that determines the filtered options to be rendered on search.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "options": "The options to render.", + "state": "The state of the component." + } + }, + "forcePopupIcon": { + "description": "Force the visibility display of the popup icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "freeSolo": { + "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getLimitTagsText": { + "description": "The label to display when the tags are truncated (limitTags).", + "notes": "", + "deprecated": "", + "typeDescriptions": { "more": "The number of truncated tags." } + }, + "getOptionDisabled": { + "description": "Used to determine the disabled state for a given option.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "option": "The option to test." } + }, + "getOptionLabel": { + "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "groupBy": { + "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "options": "The options to group." } + }, + "id": { + "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputValue": { + "description": "The input value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "isOptionEqualToValue": { + "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "option": "The option to test.", "value": "The value to test against." } + }, + "limitTags": { + "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loading": { + "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingText": { + "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiple": { + "description": "If true, value must be an array and the menu will support multiple selections.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "noOptionsText": { + "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "value": "The new value of the component.", + "reason": "One of "createOption", "selectOption", "removeOption", "blur" or "clear"." + } + }, + "onClose": { + "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur"." + } + }, + "onHighlightChange": { + "description": "Callback fired when the highlight option changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "option": "The highlighted option.", + "reason": "Can be: "keyboard", "auto", "mouse", "touch"." + } + }, + "onInputChange": { + "description": "Callback fired when the input value changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "value": "The new value of the text input.", + "reason": "Can be: "input" (user input), "reset" (programmatic change), "clear"." + } + }, + "onOpen": { + "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "openText": { + "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "options": { + "description": "Array of options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placeholder": { + "description": "The input placeholder", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "popupIcon": { + "description": "The icon to display in place of the default popup icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "renderGroup": { + "description": "Render the group.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "params": "The group to render." } + }, + "renderOption": { + "description": "Render the option, use getOptionLabel by default.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "props": "The props to apply on the li element.", + "option": "The option to render.", + "state": "The state of the component." + } + }, + "renderTags": { + "description": "Render the selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "value": "The value provided to the component.", + "getTagProps": "A tag props getter.", + "ownerState": "The state of the Autocomplete component." + } + }, + "required": { + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Leading adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "type": { + "description": "Type of the input element. It should be a valid HTML5 input type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/avatar-group/avatar-group.json b/docs/translations/api-docs-joy/avatar-group/avatar-group.json index 9d7fae700387dd..3ede5503262026 100644 --- a/docs/translations/api-docs-joy/avatar-group/avatar-group.json +++ b/docs/translations/api-docs-joy/avatar-group/avatar-group.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the AvatarGroup if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "Used to render icon or text elements inside the AvatarGroup if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/avatar/avatar.json b/docs/translations/api-docs-joy/avatar/avatar.json index 5297faf8a62a6f..c725ecd03465fa 100644 --- a/docs/translations/api-docs-joy/avatar/avatar.json +++ b/docs/translations/api-docs-joy/avatar/avatar.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "alt": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", - "children": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "src": "The src attribute for the img element.", - "srcSet": "The srcSet attribute for the img element. Use this attribute for responsive image display.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "alt": { + "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "src": { + "description": "The src attribute for the img element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "srcSet": { + "description": "The srcSet attribute for the img element. Use this attribute for responsive image display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/badge/badge.json b/docs/translations/api-docs-joy/badge/badge.json index 57d56e4627179e..bd39af72fffefd 100644 --- a/docs/translations/api-docs-joy/badge/badge.json +++ b/docs/translations/api-docs-joy/badge/badge.json @@ -1,20 +1,90 @@ { "componentDescription": "", "propDescriptions": { - "anchorOrigin": "The anchor of the badge.", - "badgeContent": "The content rendered within the badge.", - "badgeInset": "The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.", - "children": "The badge will be added relative to this node.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "invisible": "If true, the badge is invisible.", - "max": "Max count to show.", - "showZero": "Controls whether the badge is hidden when badgeContent is zero.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "anchorOrigin": { + "description": "The anchor of the badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "badgeContent": { + "description": "The content rendered within the badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "badgeInset": { + "description": "The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The badge will be added relative to this node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invisible": { + "description": "If true, the badge is invisible.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "Max count to show.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "showZero": { + "description": "Controls whether the badge is hidden when badgeContent is zero.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json b/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json index cf9e2f9325d7c7..eccdbf9b290031 100644 --- a/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json +++ b/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "separator": "Custom separator node.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "separator": { + "description": "Custom separator node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/button/button.json b/docs/translations/api-docs-joy/button/button.json index 1b2359cb447569..077b02c33a1a21 100644 --- a/docs/translations/api-docs-joy/button/button.json +++ b/docs/translations/api-docs-joy/button/button.json @@ -1,21 +1,96 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "endDecorator": "Element placed after the children.", - "fullWidth": "If true, the button will take up the full width of its container.", - "loading": "If true, the loading indicator is shown.", - "loadingIndicator": "The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", - "loadingPosition": "The loading indicator can be positioned on the start, end, or the center of the button.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the button will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loading": { + "description": "If true, the loading indicator is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingIndicator": { + "description": "The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingPosition": { + "description": "The loading indicator can be positioned on the start, end, or the center of the button.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/card-content/card-content.json b/docs/translations/api-docs-joy/card-content/card-content.json index 44696adcb84b77..cc715cea275cba 100644 --- a/docs/translations/api-docs-joy/card-content/card-content.json +++ b/docs/translations/api-docs-joy/card-content/card-content.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the CardContent if src is not set. This can be an element, or just a string.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "Used to render icon or text elements inside the CardContent if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/card-cover/card-cover.json b/docs/translations/api-docs-joy/card-cover/card-cover.json index 315390b8b24583..6f0cb97d1feda9 100644 --- a/docs/translations/api-docs-joy/card-cover/card-cover.json +++ b/docs/translations/api-docs-joy/card-cover/card-cover.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the CardCover if src is not set. This can be an element, or just a string.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "Used to render icon or text elements inside the CardCover if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/card-overflow/card-overflow.json b/docs/translations/api-docs-joy/card-overflow/card-overflow.json index cf12f77e5b0327..7ddcced1076f20 100644 --- a/docs/translations/api-docs-joy/card-overflow/card-overflow.json +++ b/docs/translations/api-docs-joy/card-overflow/card-overflow.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the CardOverflow if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "Used to render icon or text elements inside the CardOverflow if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/card/card.json b/docs/translations/api-docs-joy/card/card.json index 6888ced30db8d9..0229ed5d03de48 100644 --- a/docs/translations/api-docs-joy/card/card.json +++ b/docs/translations/api-docs-joy/card/card.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the Card if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "invertedColors": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "orientation": "The component orientation.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "Used to render icon or text elements inside the Card if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invertedColors": { + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/checkbox/checkbox.json b/docs/translations/api-docs-joy/checkbox/checkbox.json index ccb675749ddac1..05ea0a5aa84b53 100644 --- a/docs/translations/api-docs-joy/checkbox/checkbox.json +++ b/docs/translations/api-docs-joy/checkbox/checkbox.json @@ -1,29 +1,146 @@ { "componentDescription": "", "propDescriptions": { - "checked": "If true, the component is checked.", - "checkedIcon": "The icon to display when the component is checked.", - "className": "Class name applied to the root element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultChecked": "The default checked state. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "disableIcon": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", - "indeterminate": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", - "indeterminateIcon": "The icon to display when the component is indeterminate.", - "label": "The label element next to the checkbox.", - "name": "The name attribute of the input.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "overlay": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component.", - "readOnly": "If true, the component is read only.", - "required": "If true, the input element is required.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "uncheckedIcon": "The icon when checked is false.", - "value": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "checked": { + "description": "If true, the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "checkedIcon": { + "description": "The icon to display when the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "className": { + "description": "Class name applied to the root element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultChecked": { + "description": "The default checked state. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableIcon": { + "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "indeterminate": { + "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "indeterminateIcon": { + "description": "The icon to display when the component is indeterminate.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "The label element next to the checkbox.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "The name attribute of the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "overlay": { + "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "If true, the component is read only.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "uncheckedIcon": { + "description": "The icon when checked is false.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/chip-delete/chip-delete.json b/docs/translations/api-docs-joy/chip-delete/chip-delete.json index 3abc95a48f15b8..0f094a5ea3e26f 100644 --- a/docs/translations/api-docs-joy/chip-delete/chip-delete.json +++ b/docs/translations/api-docs-joy/chip-delete/chip-delete.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "children": "If provided, it will replace the default icon.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled. If undefined, the value inherits from the parent chip via a React context.", - "onDelete": "Callback fired when the component is not disabled and either: - Backspace, Enter or Delete is pressed. - The component is clicked.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "If provided, it will replace the default icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled. If undefined, the value inherits from the parent chip via a React context.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onDelete": { + "description": "Callback fired when the component is not disabled and either: - Backspace, Enter or Delete is pressed. - The component is clicked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/chip/chip.json b/docs/translations/api-docs-joy/chip/chip.json index f0443706901b0d..3eb3383ea7ac04 100644 --- a/docs/translations/api-docs-joy/chip/chip.json +++ b/docs/translations/api-docs-joy/chip/chip.json @@ -1,18 +1,78 @@ { "componentDescription": "Chips represent complex entities in small blocks, such as a contact.", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "endDecorator": "Element placed after the children.", - "onClick": "Element action click handler.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClick": { + "description": "Element action click handler.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/circular-progress/circular-progress.json b/docs/translations/api-docs-joy/circular-progress/circular-progress.json index cfc511917f4a38..9ce8036737309a 100644 --- a/docs/translations/api-docs-joy/circular-progress/circular-progress.json +++ b/docs/translations/api-docs-joy/circular-progress/circular-progress.json @@ -1,16 +1,66 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "determinate": "The boolean to select a variant. Use indeterminate when there is no progress value.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "thickness": "The thickness of the circle.", - "value": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "determinate": { + "description": "The boolean to select a variant. Use indeterminate when there is no progress value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "thickness": { + "description": "The thickness of the circle.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/css-baseline/css-baseline.json b/docs/translations/api-docs-joy/css-baseline/css-baseline.json index f2fcbd9425d184..0b1309cf042bb6 100644 --- a/docs/translations/api-docs-joy/css-baseline/css-baseline.json +++ b/docs/translations/api-docs-joy/css-baseline/css-baseline.json @@ -1,8 +1,18 @@ { "componentDescription": "Kickstart an elegant, consistent, and simple baseline to build upon.", "propDescriptions": { - "children": "You can wrap a node.", - "disableColorScheme": "Disable color-scheme CSS property.
    For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme" + "children": { + "description": "You can wrap a node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableColorScheme": { + "description": "Disable color-scheme CSS property.
    For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-joy/divider/divider.json b/docs/translations/api-docs-joy/divider/divider.json index 82a3af78429e10..8b9a407aa9b448 100644 --- a/docs/translations/api-docs-joy/divider/divider.json +++ b/docs/translations/api-docs-joy/divider/divider.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "inset": "Class name applied to the divider to shrink or stretch the line based on the orientation.", - "orientation": "The component orientation.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inset": { + "description": "Class name applied to the divider to shrink or stretch the line based on the orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/form-control/form-control.json b/docs/translations/api-docs-joy/form-control/form-control.json index 595dd81ec7ef20..5b00cf3be420bf 100644 --- a/docs/translations/api-docs-joy/form-control/form-control.json +++ b/docs/translations/api-docs-joy/form-control/form-control.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the children are in disabled state.", - "error": "If true, the children will indicate an error.", - "orientation": "The content direction flow.", - "required": "If true, the user must specify a value for the input before the owning form can be submitted. If true, the asterisk appears on the FormLabel.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the children are in disabled state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the children will indicate an error.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The content direction flow.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the user must specify a value for the input before the owning form can be submitted. If true, the asterisk appears on the FormLabel.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json b/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json index 3a039cdf5b968b..d51cca9ec95c84 100644 --- a/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json +++ b/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/form-label/form-label.json b/docs/translations/api-docs-joy/form-label/form-label.json index 4c11f8cccedcb5..c2ede40e662e20 100644 --- a/docs/translations/api-docs-joy/form-label/form-label.json +++ b/docs/translations/api-docs-joy/form-label/form-label.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "required": "The asterisk is added if required=true", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "The asterisk is added if required=true", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/icon-button/icon-button.json b/docs/translations/api-docs-joy/icon-button/icon-button.json index 423284b5d883f3..7c0a211f675b81 100644 --- a/docs/translations/api-docs-joy/icon-button/icon-button.json +++ b/docs/translations/api-docs-joy/icon-button/icon-button.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/input/input.json b/docs/translations/api-docs-joy/input/input.json index 10f8256303ed62..7db407bbb63798 100644 --- a/docs/translations/api-docs-joy/input/input.json +++ b/docs/translations/api-docs-joy/input/input.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "className": "Class name applied to the root element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "endDecorator": "Trailing adornment for this input.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "fullWidth": "If true, the button will take up the full width of its container.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "startDecorator": "Leading adornment for this input.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "className": { + "description": "Class name applied to the root element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Trailing adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the button will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Leading adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/linear-progress/linear-progress.json b/docs/translations/api-docs-joy/linear-progress/linear-progress.json index 3060b04436a2cb..8c3be50d727d35 100644 --- a/docs/translations/api-docs-joy/linear-progress/linear-progress.json +++ b/docs/translations/api-docs-joy/linear-progress/linear-progress.json @@ -1,16 +1,66 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "determinate": "The boolean to select a variant. Use indeterminate when there is no progress value.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "thickness": "The thickness of the bar.", - "value": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "determinate": { + "description": "The boolean to select a variant. Use indeterminate when there is no progress value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "thickness": { + "description": "The thickness of the bar.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/link/link.json b/docs/translations/api-docs-joy/link/link.json index 782e727b76dc4f..ce30631eaf5c67 100644 --- a/docs/translations/api-docs-joy/link/link.json +++ b/docs/translations/api-docs-joy/link/link.json @@ -1,20 +1,90 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the link. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "endDecorator": "Element placed after the children.", - "level": "Applies the theme typography styles.", - "overlay": "If true, the ::after pseudo element is added to cover the area of interaction. The parent of the overlay Link should have relative CSS position.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "textColor": "The system color.", - "underline": "Controls when the link should have an underline.", - "variant": "Applies the theme link styles. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the link.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "level": { + "description": "Applies the theme typography styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "overlay": { + "description": "If true, the ::after pseudo element is added to cover the area of interaction. The parent of the overlay Link should have relative CSS position.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "textColor": { + "description": "The system color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "underline": { + "description": "Controls when the link should have an underline.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "Applies the theme link styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list-divider/list-divider.json b/docs/translations/api-docs-joy/list-divider/list-divider.json index 04cebc2490afa4..606b38f2d89c64 100644 --- a/docs/translations/api-docs-joy/list-divider/list-divider.json +++ b/docs/translations/api-docs-joy/list-divider/list-divider.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "inset": "The empty space on the side(s) of the divider in a vertical list.
    For horizontal list (the nearest parent List has row prop set to true), only inset="gutter" affects the list divider.", - "orientation": "The component orientation.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inset": { + "description": "The empty space on the side(s) of the divider in a vertical list.
    For horizontal list (the nearest parent List has row prop set to true), only inset="gutter" affects the list divider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list-item-button/list-item-button.json b/docs/translations/api-docs-joy/list-item-button/list-item-button.json index 9c11527415767f..714f9040d55c48 100644 --- a/docs/translations/api-docs-joy/list-item-button/list-item-button.json +++ b/docs/translations/api-docs-joy/list-item-button/list-item-button.json @@ -1,19 +1,84 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "autoFocus": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "orientation": "The content direction flow.", - "selected": "If true, the component is selected.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The content direction flow.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selected": { + "description": "If true, the component is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list-item-content/list-item-content.json b/docs/translations/api-docs-joy/list-item-content/list-item-content.json index 3a039cdf5b968b..d51cca9ec95c84 100644 --- a/docs/translations/api-docs-joy/list-item-content/list-item-content.json +++ b/docs/translations/api-docs-joy/list-item-content/list-item-content.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json b/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json index 3a039cdf5b968b..d51cca9ec95c84 100644 --- a/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json +++ b/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/list-item/list-item.json b/docs/translations/api-docs-joy/list-item/list-item.json index 7caf906ef0a3bb..87cf2986696ec4 100644 --- a/docs/translations/api-docs-joy/list-item/list-item.json +++ b/docs/translations/api-docs-joy/list-item/list-item.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "endAction": "The element to display at the end of ListItem.", - "nested": "If true, the component can contain NestedList.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startAction": "The element to display at the start of ListItem.", - "sticky": "If true, the component has sticky position (with top = 0).", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endAction": { + "description": "The element to display at the end of ListItem.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "nested": { + "description": "If true, the component can contain NestedList.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startAction": { + "description": "The element to display at the start of ListItem.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sticky": { + "description": "If true, the component has sticky position (with top = 0).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list-subheader/list-subheader.json b/docs/translations/api-docs-joy/list-subheader/list-subheader.json index 45720b6993a8f0..ab913c634cc91a 100644 --- a/docs/translations/api-docs-joy/list-subheader/list-subheader.json +++ b/docs/translations/api-docs-joy/list-subheader/list-subheader.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sticky": "If true, the component has sticky position (with top = 0).", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sticky": { + "description": "If true, the component has sticky position (with top = 0).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list/list.json b/docs/translations/api-docs-joy/list/list.json index 1df1151c16e80f..066207a7e5c032 100644 --- a/docs/translations/api-docs-joy/list/list.json +++ b/docs/translations/api-docs-joy/list/list.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "orientation": "The component orientation.", - "size": "The size of the component (affect other nested list* components). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.", - "wrap": "Only for horizontal list. If true, the list sets the flex-wrap to "wrap" and adjust margin to have gap-like behavior (will move to gap in the future)." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component (affect other nested list* components).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "wrap": { + "description": "Only for horizontal list. If true, the list sets the flex-wrap to "wrap" and adjust margin to have gap-like behavior (will move to gap in the future).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Classname applied to the root element." }, diff --git a/docs/translations/api-docs-joy/menu-item/menu-item.json b/docs/translations/api-docs-joy/menu-item/menu-item.json index 9e0532aa4ded04..e4bbab7d7ac3a7 100644 --- a/docs/translations/api-docs-joy/menu-item/menu-item.json +++ b/docs/translations/api-docs-joy/menu-item/menu-item.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "orientation": "The content direction flow.", - "selected": "If true, the component is selected.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The content direction flow.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selected": { + "description": "If true, the component is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/menu-list/menu-list.json b/docs/translations/api-docs-joy/menu-list/menu-list.json index 6f2cb672147c2e..d1402bf0e40f6e 100644 --- a/docs/translations/api-docs-joy/menu-list/menu-list.json +++ b/docs/translations/api-docs-joy/menu-list/menu-list.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "actions": "A ref with imperative actions. It allows to select the first or last menu item.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component (affect other nested list* components because the Menu inherits List). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "actions": { + "description": "A ref with imperative actions. It allows to select the first or last menu item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component (affect other nested list* components because the Menu inherits List).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/menu/menu.json b/docs/translations/api-docs-joy/menu/menu.json index 22900511139739..91995c3c7d8873 100644 --- a/docs/translations/api-docs-joy/menu/menu.json +++ b/docs/translations/api-docs-joy/menu/menu.json @@ -1,21 +1,96 @@ { "componentDescription": "", "propDescriptions": { - "actions": "A ref with imperative actions. It allows to select the first or last menu item.", - "anchorEl": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "invertedColors": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "modifiers": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "onClose": "Triggered when focus leaves the menu and the menu should close.", - "open": "Controls whether the menu is displayed.", - "size": "The size of the component (affect other nested list* components because the Menu inherits List). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "actions": { + "description": "A ref with imperative actions. It allows to select the first or last menu item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "anchorEl": { + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invertedColors": { + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "modifiers": { + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Triggered when focus leaves the menu and the menu should close.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "open": { + "description": "Controls whether the menu is displayed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component (affect other nested list* components because the Menu inherits List).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Classname applied to the root element." }, diff --git a/docs/translations/api-docs-joy/modal-close/modal-close.json b/docs/translations/api-docs-joy/modal-close/modal-close.json index b0a6990f0afc30..edcda443e8c2bb 100644 --- a/docs/translations/api-docs-joy/modal-close/modal-close.json +++ b/docs/translations/api-docs-joy/modal-close/modal-close.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json b/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json index de938f84650863..e23b19c13fa444 100644 --- a/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json +++ b/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "layout": "The layout of the dialog", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "layout": { + "description": "The layout of the dialog", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json b/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json index 131bb9e1a8c9cd..4bd0a4c5670f12 100644 --- a/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json +++ b/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json @@ -1,7 +1,12 @@ { "componentDescription": "", "propDescriptions": { - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/modal/modal.json b/docs/translations/api-docs-joy/modal/modal.json index 4922e0ea35d15b..681838115ae4ac 100644 --- a/docs/translations/api-docs-joy/modal/modal.json +++ b/docs/translations/api-docs-joy/modal/modal.json @@ -1,22 +1,105 @@ { "componentDescription": "", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "container": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "disableAutoFocus": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEnforceFocus": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEscapeKeyDown": "If true, hitting escape will not fire the onClose callback.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "disableRestoreFocus": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "disableScrollLock": "Disable the scroll lock behavior.", - "hideBackdrop": "If true, the backdrop is not rendered.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick", "closeClick".
    ", - "open": "If true, the component is shown.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAutoFocus": { + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEnforceFocus": { + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEscapeKeyDown": { + "description": "If true, hitting escape will not fire the onClose callback.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRestoreFocus": { + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableScrollLock": { + "description": "Disable the scroll lock behavior.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hideBackdrop": { + "description": "If true, the backdrop is not rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "escapeKeyDown", "backdropClick", "closeClick"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/option/option.json b/docs/translations/api-docs-joy/option/option.json index a38126f4d6801c..6a52cb56849bf0 100644 --- a/docs/translations/api-docs-joy/option/option.json +++ b/docs/translations/api-docs-joy/option/option.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "label": "A text representation of the option's content. Used for keyboard text navigation matching.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The option value.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "A text representation of the option's content. Used for keyboard text navigation matching.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The option value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/radio-group/radio-group.json b/docs/translations/api-docs-joy/radio-group/radio-group.json index 85b10fb80de217..43cdbde07439d1 100644 --- a/docs/translations/api-docs-joy/radio-group/radio-group.json +++ b/docs/translations/api-docs-joy/radio-group/radio-group.json @@ -1,21 +1,98 @@ { "componentDescription": "", "propDescriptions": { - "className": "Class name applied to the root element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disableIcon": "The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element.", - "name": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.", - "onChange": "Callback fired when a radio button is selected.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", - "orientation": "The component orientation.", - "overlay": "The radio's overlay prop. If specified, the value is passed down to every radios under this element.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "Value of the selected radio button. The DOM API casts this to a string.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "className": { + "description": "Class name applied to the root element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableIcon": { + "description": "The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when a radio button is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." + } + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "overlay": { + "description": "The radio's overlay prop. If specified, the value is passed down to every radios under this element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "Value of the selected radio button. The DOM API casts this to a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/radio/radio.json b/docs/translations/api-docs-joy/radio/radio.json index ffd6290caafd08..9dcad533e7cb8c 100644 --- a/docs/translations/api-docs-joy/radio/radio.json +++ b/docs/translations/api-docs-joy/radio/radio.json @@ -1,27 +1,134 @@ { "componentDescription": "", "propDescriptions": { - "checked": "If true, the component is checked.", - "checkedIcon": "The icon to display when the component is checked.", - "className": "Class name applied to the root element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultChecked": "The default checked state. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "disableIcon": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", - "label": "The label element at the end the radio.", - "name": "The name attribute of the input.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "overlay": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component.", - "readOnly": "If true, the component is read only.", - "required": "If true, the input element is required.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "uncheckedIcon": "The icon to display when the component is not checked.", - "value": "The value of the component. The DOM API casts this to a string.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "checked": { + "description": "If true, the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "checkedIcon": { + "description": "The icon to display when the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "className": { + "description": "Class name applied to the root element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultChecked": { + "description": "The default checked state. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableIcon": { + "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "The label element at the end the radio.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "The name attribute of the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "overlay": { + "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "If true, the component is read only.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "uncheckedIcon": { + "description": "The icon to display when the component is not checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the component. The DOM API casts this to a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json b/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json index 261555f056fcdd..6b5d8d81050e1b 100644 --- a/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json +++ b/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "children": "You can wrap a node.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disableColorScheme": "Disable color-scheme CSS property. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "You can wrap a node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableColorScheme": { + "description": "Disable color-scheme CSS property. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/select/select.json b/docs/translations/api-docs-joy/select/select.json index a362701dee65df..ffe0d576c9ef0b 100644 --- a/docs/translations/api-docs-joy/select/select.json +++ b/docs/translations/api-docs-joy/select/select.json @@ -1,30 +1,150 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "autoFocus": "If true, the select element is focused during the first mount", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultListboxOpen": "If true, the select will be initially open.", - "defaultValue": "The default selected value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "endDecorator": "Trailing adornment for the select.", - "getSerializedValue": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", - "indicator": "The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾", - "listboxId": "id attribute of the listbox element. Also used to derive the id attributes of options.", - "listboxOpen": "Controls the open state of the select's listbox.", - "name": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", - "onChange": "Callback fired when an option is selected.", - "onClose": "Triggered when focus leaves the menu and the menu should close.", - "onListboxOpenChange": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", - "placeholder": "Text to show when there is no selected value.", - "renderValue": "Function that customizes the rendering of the selected value.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Leading adornment for the select.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The selected value. Set to null to deselect all options.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the select element is focused during the first mount", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultListboxOpen": { + "description": "If true, the select will be initially open.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default selected value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Trailing adornment for the select.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getSerializedValue": { + "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "indicator": { + "description": "The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "listboxId": { + "description": "id attribute of the listbox element. Also used to derive the id attributes of options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "listboxOpen": { + "description": "Controls the open state of the select's listbox.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when an option is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Triggered when focus leaves the menu and the menu should close.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onListboxOpenChange": { + "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placeholder": { + "description": "Text to show when there is no selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "renderValue": { + "description": "Function that customizes the rendering of the selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Leading adornment for the select.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The selected value. Set to null to deselect all options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the root slot" }, diff --git a/docs/translations/api-docs-joy/sheet/sheet.json b/docs/translations/api-docs-joy/sheet/sheet.json index 1f141290078461..e5d15a4f55fb82 100644 --- a/docs/translations/api-docs-joy/sheet/sheet.json +++ b/docs/translations/api-docs-joy/sheet/sheet.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "invertedColors": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invertedColors": { + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/slider/slider.json b/docs/translations/api-docs-joy/slider/slider.json index 0d052120b8a766..154d804ceb32c7 100644 --- a/docs/translations/api-docs-joy/slider/slider.json +++ b/docs/translations/api-docs-joy/slider/slider.json @@ -1,36 +1,196 @@ { "componentDescription": "", "propDescriptions": { - "aria-label": "The label of the slider.", - "aria-valuetext": "A string value that provides a user-friendly name for the current value of the slider.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "disableSwap": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "getAriaLabel": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

    Signature:
    function(index: number) => string
    • index: The thumb label's index to format.
    ", - "getAriaValueText": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.

    Signature:
    function(value: number, index: number) => string
    • value: The thumb label's value to format.
    • index: The thumb label's index to format.
    ", - "isRtl": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", - "marks": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", - "max": "The maximum allowed value of the slider. Should not be equal to min.", - "min": "The minimum allowed value of the slider. Should not be equal to max.", - "name": "Name attribute of the hidden input element.", - "onChange": "Callback function that is fired when the slider's value changed.

    Signature:
    function(event: Event, value: number | Array<number>, activeThumb: number) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.
    • value: The new value.
    • activeThumb: Index of the currently moved thumb.
    ", - "onChangeCommitted": "Callback function that is fired when the mouseup is triggered.

    Signature:
    function(event: React.SyntheticEvent | Event, value: number | Array<number>) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: The new value.
    ", - "orientation": "The component orientation.", - "scale": "A transformation function, to change the scale of the slider.

    Signature:
    function(x: any) => any
    ", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "step": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "tabIndex": "Tab index attribute of the hidden input element.", - "track": "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": "The value of the slider. For ranged sliders, provide an array with two values.", - "valueLabelDisplay": "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": "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", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "aria-label": { + "description": "The label of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-valuetext": { + "description": "A string value that provides a user-friendly name for the current value of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSwap": { + "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getAriaLabel": { + "description": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "index": "The thumb label's index to format." } + }, + "getAriaValueText": { + "description": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "value": "The thumb label's value to format.", + "index": "The thumb label's index to format." + } + }, + "isRtl": { + "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "marks": { + "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "The maximum allowed value of the slider. Should not be equal to min.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "min": { + "description": "The minimum allowed value of the slider. Should not be equal to max.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the hidden input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback function that is fired when the slider's value changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.", + "value": "The new value.", + "activeThumb": "Index of the currently moved thumb." + } + }, + "onChangeCommitted": { + "description": "Callback function that is fired when the mouseup is triggered.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. Warning: This is a generic event not a change event.", + "value": "The new value." + } + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "scale": { + "description": "A transformation function, to change the scale of the slider.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "step": { + "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "tabIndex": { + "description": "Tab index attribute of the hidden input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "track": { + "description": "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.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the slider. For ranged sliders, provide an array with two values.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "valueLabelDisplay": { + "description": "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.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "valueLabelFormat": { + "description": "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", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/stack/stack.json b/docs/translations/api-docs-joy/stack/stack.json index 35fc03a33573c0..752ee1db26273d 100644 --- a/docs/translations/api-docs-joy/stack/stack.json +++ b/docs/translations/api-docs-joy/stack/stack.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "direction": "Defines the flex-direction style property. It is applied for all screen sizes.", - "divider": "Add an element between each child.", - "spacing": "Defines the space between immediate children.", - "sx": "The system prop, which allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "useFlexGap": "If true, the CSS flexbox gap is used instead of applying margin to children.
    While CSS gap removes the known limitations, it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
    To enable this flag globally, follow the theme's default props configuration." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "Defines the flex-direction style property. It is applied for all screen sizes.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "divider": { + "description": "Add an element between each child.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "spacing": { + "description": "Defines the space between immediate children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop, which allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "useFlexGap": { + "description": "If true, the CSS flexbox gap is used instead of applying margin to children.
    While CSS gap removes the known limitations, it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
    To enable this flag globally, follow the theme's default props configuration.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs-joy/svg-icon/svg-icon.json b/docs/translations/api-docs-joy/svg-icon/svg-icon.json index 95ecb3f260c547..6e169bdb057dd9 100644 --- a/docs/translations/api-docs-joy/svg-icon/svg-icon.json +++ b/docs/translations/api-docs-joy/svg-icon/svg-icon.json @@ -1,18 +1,78 @@ { "componentDescription": "", "propDescriptions": { - "children": "Node passed into the SVG element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. You can use the htmlColor prop to apply a color attribute to the SVG element. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "fontSize": "The fontSize applied to the icon. Defaults to 1rem, but can be configure to inherit font size.", - "htmlColor": "Applies a color attribute to the SVG element.", - "inheritViewBox": "If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored. Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node.", - "shapeRendering": "The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "titleAccess": "Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent", - "viewBox": "Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px." + "children": { + "description": "Node passed into the SVG element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component. You can use the htmlColor prop to apply a color attribute to the SVG element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fontSize": { + "description": "The fontSize applied to the icon. Defaults to 1rem, but can be configure to inherit font size.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "htmlColor": { + "description": "Applies a color attribute to the SVG element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inheritViewBox": { + "description": "If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored. Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "shapeRendering": { + "description": "The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "titleAccess": { + "description": "Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "viewBox": { + "description": "Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/switch/switch.json b/docs/translations/api-docs-joy/switch/switch.json index e196bbae3df290..b14a20500e7364 100644 --- a/docs/translations/api-docs-joy/switch/switch.json +++ b/docs/translations/api-docs-joy/switch/switch.json @@ -1,21 +1,98 @@ { "componentDescription": "", "propDescriptions": { - "checked": "If true, the component is checked.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultChecked": "The default checked state. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "endDecorator": "The element that appears at the end of the switch.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "readOnly": "If true, the component is read only.", - "required": "If true, the input element is required.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "The element that appears at the end of the switch.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "checked": { + "description": "If true, the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultChecked": { + "description": "The default checked state. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "The element that appears at the end of the switch.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "readOnly": { + "description": "If true, the component is read only.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "The element that appears at the end of the switch.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/tab-list/tab-list.json b/docs/translations/api-docs-joy/tab-list/tab-list.json index 39dfa648bfeaab..830617df9036cf 100644 --- a/docs/translations/api-docs-joy/tab-list/tab-list.json +++ b/docs/translations/api-docs-joy/tab-list/tab-list.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "Used to render icon or text elements inside the TabList if src is not set. This can be an element, or just a string.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "Used to render icon or text elements inside the TabList if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/tab-panel/tab-panel.json b/docs/translations/api-docs-joy/tab-panel/tab-panel.json index eb37a0a8e71422..a2b6dc5827e8ab 100644 --- a/docs/translations/api-docs-joy/tab-panel/tab-panel.json +++ b/docs/translations/api-docs-joy/tab-panel/tab-panel.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Classname applied to the root element." }, diff --git a/docs/translations/api-docs-joy/tab/tab.json b/docs/translations/api-docs-joy/tab/tab.json index cf4c7c2d8de2cf..a5de60356fc4fc 100644 --- a/docs/translations/api-docs-joy/tab/tab.json +++ b/docs/translations/api-docs-joy/tab/tab.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "onChange": "Callback invoked when new value is being set.", - "orientation": "The content direction flow.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "You can provide your own value. Otherwise, it falls back to the child position index.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback invoked when new value is being set.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The content direction flow.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "You can provide your own value. Otherwise, it falls back to the child position index.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Classname applied to the root element." }, diff --git a/docs/translations/api-docs-joy/table/table.json b/docs/translations/api-docs-joy/table/table.json index df09f892b96ee6..edd2cba91179fb 100644 --- a/docs/translations/api-docs-joy/table/table.json +++ b/docs/translations/api-docs-joy/table/table.json @@ -1,20 +1,90 @@ { "componentDescription": "", "propDescriptions": { - "borderAxis": "The axis to display a border on the table cell.", - "children": "Children of the table", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "hoverRow": "If true, the table row will shade on hover.", - "noWrap": "If true, the body cells will not wrap, but instead will truncate with a text overflow ellipsis.
    Note: Header cells are always truncated with overflow ellipsis.", - "size": "The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "stickyFooter": "If true, the footer always appear at the bottom of the overflow table.
    ⚠️ It doesn't work with IE11.", - "stickyHeader": "If true, the header always appear at the top of the overflow table.
    ⚠️ It doesn't work with IE11.", - "stripe": "The odd or even row of the table body will have subtle background color.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "borderAxis": { + "description": "The axis to display a border on the table cell.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Children of the table", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hoverRow": { + "description": "If true, the table row will shade on hover.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "noWrap": { + "description": "If true, the body cells will not wrap, but instead will truncate with a text overflow ellipsis.
    Note: Header cells are always truncated with overflow ellipsis.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "stickyFooter": { + "description": "If true, the footer always appear at the bottom of the overflow table.
    ⚠️ It doesn't work with IE11.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "stickyHeader": { + "description": "If true, the header always appear at the top of the overflow table.
    ⚠️ It doesn't work with IE11.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "stripe": { + "description": "The odd or even row of the table body will have subtle background color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/tabs/tabs.json b/docs/translations/api-docs-joy/tabs/tabs.json index 321ce823397512..79b29fa665d4b9 100644 --- a/docs/translations/api-docs-joy/tabs/tabs.json +++ b/docs/translations/api-docs-joy/tabs/tabs.json @@ -1,20 +1,90 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultValue": "The default value. Use when the component is not controlled.", - "direction": "The direction of the text.", - "onChange": "Callback invoked when new value is being set.", - "orientation": "The component orientation (layout flow direction).", - "selectionFollowsFocus": "If true the selected tab changes on focus. Otherwise it only changes on activation.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "The direction of the text.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback invoked when new value is being set.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation (layout flow direction).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selectionFollowsFocus": { + "description": "If true the selected tab changes on focus. Otherwise it only changes on activation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Classname applied to the root element." }, diff --git a/docs/translations/api-docs-joy/textarea/textarea.json b/docs/translations/api-docs-joy/textarea/textarea.json index 0992dbc61999f3..a6794637e681bf 100644 --- a/docs/translations/api-docs-joy/textarea/textarea.json +++ b/docs/translations/api-docs-joy/textarea/textarea.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "endDecorator": "Trailing adornment for this input.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "maxRows": "Maximum number of rows to display.", - "minRows": "Minimum number of rows to display.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "startDecorator": "Leading adornment for this input.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Trailing adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxRows": { + "description": "Maximum number of rows to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Leading adornment for this input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/tooltip/tooltip.json b/docs/translations/api-docs-joy/tooltip/tooltip.json index 498699b273a463..c560ea27abfe81 100644 --- a/docs/translations/api-docs-joy/tooltip/tooltip.json +++ b/docs/translations/api-docs-joy/tooltip/tooltip.json @@ -1,36 +1,186 @@ { "componentDescription": "", "propDescriptions": { - "arrow": "If true, adds an arrow to the tooltip.", - "children": "Tooltip reference element.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "describeChild": "Set to true if the title acts as an accessible description. By default the title acts as an accessible label for the child.", - "direction": "Direction of the text.", - "disableFocusListener": "Do not respond to focus-visible events.", - "disableHoverListener": "Do not respond to hover events.", - "disableInteractive": "Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the leaveDelay is expired.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "disableTouchListener": "Do not respond to long press touch events.", - "enterDelay": "The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay).", - "enterNextDelay": "The number of milliseconds to wait before showing the tooltip when one was already recently opened.", - "enterTouchDelay": "The number of milliseconds a user must touch the element before showing the tooltip.", - "followCursor": "If true, the tooltip follow the cursor over the wrapped element.", - "id": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "leaveDelay": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).", - "leaveTouchDelay": "The number of milliseconds after the user stops touching an element before hiding the tooltip.", - "modifiers": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", - "onOpen": "Callback fired when the component requests to be open.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", - "open": "If true, the component is shown.", - "placement": "Tooltip placement.", - "size": "The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "title": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "arrow": { + "description": "If true, adds an arrow to the tooltip.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Tooltip reference element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "describeChild": { + "description": "Set to true if the title acts as an accessible description. By default the title acts as an accessible label for the child.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "Direction of the text.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableFocusListener": { + "description": "Do not respond to focus-visible events.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableHoverListener": { + "description": "Do not respond to hover events.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableInteractive": { + "description": "Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the leaveDelay is expired.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTouchListener": { + "description": "Do not respond to long press touch events.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "enterDelay": { + "description": "The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "enterNextDelay": { + "description": "The number of milliseconds to wait before showing the tooltip when one was already recently opened.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "enterTouchDelay": { + "description": "The number of milliseconds a user must touch the element before showing the tooltip.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "followCursor": { + "description": "If true, the tooltip follow the cursor over the wrapped element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "leaveDelay": { + "description": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "leaveTouchDelay": { + "description": "The number of milliseconds after the user stops touching an element before hiding the tooltip.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "modifiers": { + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "onOpen": { + "description": "Callback fired when the component requests to be open.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placement": { + "description": "Tooltip placement.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "title": { + "description": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/typography/typography.json b/docs/translations/api-docs-joy/typography/typography.json index fc995f10b485ef..d9ca8e568da74a 100644 --- a/docs/translations/api-docs-joy/typography/typography.json +++ b/docs/translations/api-docs-joy/typography/typography.json @@ -1,20 +1,90 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "color": "The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "endDecorator": "Element placed after the children.", - "gutterBottom": "If true, the text will have a bottom margin.", - "level": "Applies the theme typography styles.", - "levelMapping": "The component maps the variant prop to a range of different HTML element types. For instance, body1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop.", - "noWrap": "If true, the text will not wrap, but instead will truncate with a text overflow ellipsis.
    Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow).", - "slotProps": "The props used for each slot inside.", - "slots": "The components used for each slot inside. See Slots API below for more details.", - "startDecorator": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "textColor": "The system color.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endDecorator": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "gutterBottom": { + "description": "If true, the text will have a bottom margin.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "level": { + "description": "Applies the theme typography styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "levelMapping": { + "description": "The component maps the variant prop to a range of different HTML element types. For instance, body1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "noWrap": { + "description": "If true, the text will not wrap, but instead will truncate with a text overflow ellipsis.
    Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startDecorator": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "textColor": { + "description": "The system color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The global variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs/accordion-actions/accordion-actions.json b/docs/translations/api-docs/accordion-actions/accordion-actions.json index 5a86c9bd70a360..ce01b36ba37df7 100644 --- a/docs/translations/api-docs/accordion-actions/accordion-actions.json +++ b/docs/translations/api-docs/accordion-actions/accordion-actions.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableSpacing": "If true, the actions do not have additional margin.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSpacing": { + "description": "If true, the actions do not have additional margin.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/accordion-details/accordion-details.json b/docs/translations/api-docs/accordion-details/accordion-details.json index b196b58c3dfbc6..3fc8ceebe8157c 100644 --- a/docs/translations/api-docs/accordion-details/accordion-details.json +++ b/docs/translations/api-docs/accordion-details/accordion-details.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/accordion-summary/accordion-summary.json b/docs/translations/api-docs/accordion-summary/accordion-summary.json index 97df03d6fb53ab..6b5c246881d6a4 100644 --- a/docs/translations/api-docs/accordion-summary/accordion-summary.json +++ b/docs/translations/api-docs/accordion-summary/accordion-summary.json @@ -1,11 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "expandIcon": "The icon to display as the expand indicator.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "expandIcon": { + "description": "The icon to display as the expand indicator.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/accordion/accordion.json b/docs/translations/api-docs/accordion/accordion.json index b9964d97bb7c74..b4b389eb4678cd 100644 --- a/docs/translations/api-docs/accordion/accordion.json +++ b/docs/translations/api-docs/accordion/accordion.json @@ -1,17 +1,75 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "defaultExpanded": "If true, expands the accordion by default.", - "disabled": "If true, the component is disabled.", - "disableGutters": "If true, it removes the margin between two expanded accordion items and the increase of height.", - "expanded": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", - "onChange": "Callback fired when the expand/collapse state is changed.

    Signature:
    function(event: React.SyntheticEvent, expanded: boolean) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • expanded: The expanded state of the accordion.
    ", - "square": "If true, rounded corners are disabled.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "TransitionComponent": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "TransitionProps": "Props applied to the transition element. By default, the element is based on this Transition component." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultExpanded": { + "description": "If true, expands the accordion by default.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, it removes the margin between two expanded accordion items and the increase of height.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "expanded": { + "description": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the expand/collapse state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. Warning: This is a generic event not a change event.", + "expanded": "The expanded state of the accordion." + } + }, + "square": { + "description": "If true, rounded corners are disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionComponent": { + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionProps": { + "description": "Props applied to the transition element. By default, the element is based on this Transition component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/alert-title/alert-title.json b/docs/translations/api-docs/alert-title/alert-title.json index b196b58c3dfbc6..3fc8ceebe8157c 100644 --- a/docs/translations/api-docs/alert-title/alert-title.json +++ b/docs/translations/api-docs/alert-title/alert-title.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/alert/alert.json b/docs/translations/api-docs/alert/alert.json index e1219dd78ec0d4..1d357ab0b6fc53 100644 --- a/docs/translations/api-docs/alert/alert.json +++ b/docs/translations/api-docs/alert/alert.json @@ -1,22 +1,102 @@ { "componentDescription": "", "propDescriptions": { - "action": "The action to display. It renders after the message, at the end of the alert.", - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "closeText": "Override the default label for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "color": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "icon": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", - "iconMapping": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", - "onClose": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", - "role": "The ARIA role attribute of the element.", - "severity": "The severity of the alert. This defines the color and icon used.", - "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "action": { + "description": "The action to display. It renders after the message, at the end of the alert.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "closeText": { + "description": "Override the default label for the close popup icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "icon": { + "description": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "iconMapping": { + "description": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "role": { + "description": "The ARIA role attribute of the element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "severity": { + "description": "The severity of the alert. This defines the color and icon used.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/app-bar/app-bar.json b/docs/translations/api-docs/app-bar/app-bar.json index efaee9abe744ec..e7b5e251937a5a 100644 --- a/docs/translations/api-docs/app-bar/app-bar.json +++ b/docs/translations/api-docs/app-bar/app-bar.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "enableColorOnDark": "If true, the color prop is applied in dark mode.", - "position": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "enableColorOnDark": { + "description": "If true, the color prop is applied in dark mode.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "position": { + "description": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/autocomplete/autocomplete.json b/docs/translations/api-docs/autocomplete/autocomplete.json index 10f66ff2ff3466..ec18a758bb8d4e 100644 --- a/docs/translations/api-docs/autocomplete/autocomplete.json +++ b/docs/translations/api-docs/autocomplete/autocomplete.json @@ -1,68 +1,404 @@ { "componentDescription": "", "propDescriptions": { - "autoComplete": "If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.", - "autoHighlight": "If true, the first option is automatically highlighted.", - "autoSelect": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
    When using freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.", - "blurOnSelect": "Control if the input should be blurred when an option is selected:
    - false the input is not blurred. - true the input is always blurred. - touch the input is blurred after a touch event. - mouse the input is blurred after a mouse event.", - "ChipProps": "Props applied to the Chip element.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "clearIcon": "The icon to display in place of the default clear icon.", - "clearOnBlur": "If true, the input's text is cleared on blur if no value is selected.
    Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume their search.", - "clearOnEscape": "If true, clear all values when the user presses escape and the popup is closed.", - "clearText": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", - "closeText": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "componentsProps": "The props used for each slot inside.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disableClearable": "If true, the input can't be cleared.", - "disableCloseOnSelect": "If true, the popup won't close when a value is selected.", - "disabled": "If true, the component is disabled.", - "disabledItemsFocusable": "If true, will allow focus on disabled items.", - "disableListWrap": "If true, the list box in the popup will not wrap focus.", - "disablePortal": "If true, the Popper content will be under the DOM hierarchy of the parent component.", - "filterOptions": "A function that determines the filtered options to be rendered on search.

    Signature:
    function(options: Array<T>, state: object) => Array<T>
    • options: The options to render.
    • state: The state of the component.
    ", - "filterSelectedOptions": "If true, hide the selected options from the list box.", - "forcePopupIcon": "Force the visibility display of the popup icon.", - "freeSolo": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", - "fullWidth": "If true, the input will take up the full width of its container.", - "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

    Signature:
    function(more: number) => ReactNode
    • more: The number of truncated tags.
    ", - "getOptionDisabled": "Used to determine the disabled state for a given option.

    Signature:
    function(option: T) => boolean
    • option: The option to test.
    ", - "getOptionLabel": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.

    Signature:
    function(option: T) => string
    ", - "groupBy": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.

    Signature:
    function(options: T) => string
    • options: The options to group.
    ", - "handleHomeEndKeys": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.", - "id": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", - "includeInputInList": "If true, the highlight can move to the input.", - "inputValue": "The input value.", - "isOptionEqualToValue": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.

    Signature:
    function(option: T, value: T) => boolean
    • option: The option to test.
    • value: The value to test against.
    ", - "limitTags": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", - "ListboxComponent": "The component used to render the listbox.", - "ListboxProps": "Props applied to the Listbox element.", - "loading": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", - "loadingText": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", - "multiple": "If true, value must be an array and the menu will support multiple selections.", - "noOptionsText": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: T | Array<T>, reason: string, details?: string) => void
    • event: The event source of the callback.
    • value: The new value of the component.
    • reason: One of "createOption", "selectOption", "removeOption", "blur" or "clear".
    ", - "onClose": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur".
    ", - "onHighlightChange": "Callback fired when the highlight option changes.

    Signature:
    function(event: React.SyntheticEvent, option: T, reason: string) => void
    • event: The event source of the callback.
    • option: The highlighted option.
    • reason: Can be: "keyboard", "auto", "mouse", "touch".
    ", - "onInputChange": "Callback fired when the input value changes.

    Signature:
    function(event: React.SyntheticEvent, value: string, reason: string) => void
    • event: The event source of the callback.
    • value: The new value of the text input.
    • reason: Can be: "input" (user input), "reset" (programmatic change), "clear".
    ", - "onOpen": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback.
    ", - "open": "If true, the component is shown.", - "openOnFocus": "If true, the popup will open on input focus.", - "openText": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", - "options": "Array of options.", - "PaperComponent": "The component used to render the body of the popup.", - "PopperComponent": "The component used to position the popup.", - "popupIcon": "The icon to display in place of the default popup icon.", - "readOnly": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "renderGroup": "Render the group.

    Signature:
    function(params: AutocompleteRenderGroupParams) => ReactNode
    • params: The group to render.
    ", - "renderInput": "Render the input.

    Signature:
    function(params: object) => ReactNode
    ", - "renderOption": "Render the option, use getOptionLabel by default.

    Signature:
    function(props: object, option: T, state: object) => ReactNode
    • props: The props to apply on the li element.
    • option: The option to render.
    • state: The state of the component.
    ", - "renderTags": "Render the selected value.

    Signature:
    function(value: Array<T>, getTagProps: function, ownerState: object) => ReactNode
    • value: The value provided to the component.
    • getTagProps: A tag props getter.
    • ownerState: The state of the Autocomplete component.
    ", - "selectOnFocus": "If true, the input'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 `sx` page for more details.", - "value": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop." + "autoComplete": { + "description": "If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoHighlight": { + "description": "If true, the first option is automatically highlighted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoSelect": { + "description": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
    When using freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "blurOnSelect": { + "description": "Control if the input should be blurred when an option is selected:
    - false the input is not blurred. - true the input is always blurred. - touch the input is blurred after a touch event. - mouse the input is blurred after a mouse event.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ChipProps": { + "description": "Props applied to the Chip element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearIcon": { + "description": "The icon to display in place of the default clear icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearOnBlur": { + "description": "If true, the input's text is cleared on blur if no value is selected.
    Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume their search.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearOnEscape": { + "description": "If true, clear all values when the user presses escape and the popup is closed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clearText": { + "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "closeText": { + "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableClearable": { + "description": "If true, the input can't be cleared.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableCloseOnSelect": { + "description": "If true, the popup won't close when a value is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabledItemsFocusable": { + "description": "If true, will allow focus on disabled items.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableListWrap": { + "description": "If true, the list box in the popup will not wrap focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "If true, the Popper content will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "filterOptions": { + "description": "A function that determines the filtered options to be rendered on search.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "options": "The options to render.", + "state": "The state of the component." + } + }, + "filterSelectedOptions": { + "description": "If true, hide the selected options from the list box.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "forcePopupIcon": { + "description": "Force the visibility display of the popup icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "freeSolo": { + "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the input will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "getLimitTagsText": { + "description": "The label to display when the tags are truncated (limitTags).", + "notes": "", + "deprecated": "", + "typeDescriptions": { "more": "The number of truncated tags." } + }, + "getOptionDisabled": { + "description": "Used to determine the disabled state for a given option.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "option": "The option to test." } + }, + "getOptionLabel": { + "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "groupBy": { + "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "options": "The options to group." } + }, + "handleHomeEndKeys": { + "description": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "includeInputInList": { + "description": "If true, the highlight can move to the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputValue": { + "description": "The input value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "isOptionEqualToValue": { + "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "option": "The option to test.", "value": "The value to test against." } + }, + "limitTags": { + "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ListboxComponent": { + "description": "The component used to render the listbox.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ListboxProps": { + "description": "Props applied to the Listbox element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loading": { + "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingText": { + "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiple": { + "description": "If true, value must be an array and the menu will support multiple selections.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "noOptionsText": { + "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "value": "The new value of the component.", + "reason": "One of "createOption", "selectOption", "removeOption", "blur" or "clear"." + } + }, + "onClose": { + "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur"." + } + }, + "onHighlightChange": { + "description": "Callback fired when the highlight option changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "option": "The highlighted option.", + "reason": "Can be: "keyboard", "auto", "mouse", "touch"." + } + }, + "onInputChange": { + "description": "Callback fired when the input value changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "value": "The new value of the text input.", + "reason": "Can be: "input" (user input), "reset" (programmatic change), "clear"." + } + }, + "onOpen": { + "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "openOnFocus": { + "description": "If true, the popup will open on input focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "openText": { + "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "options": { + "description": "Array of options.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PaperComponent": { + "description": "The component used to render the body of the popup.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PopperComponent": { + "description": "The component used to position the popup.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "popupIcon": { + "description": "The icon to display in place of the default popup icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "renderGroup": { + "description": "Render the group.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "params": "The group to render." } + }, + "renderInput": { + "description": "Render the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "renderOption": { + "description": "Render the option, use getOptionLabel by default.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "props": "The props to apply on the li element.", + "option": "The option to render.", + "state": "The state of the component." + } + }, + "renderTags": { + "description": "Render the selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "value": "The value provided to the component.", + "getTagProps": "A tag props getter.", + "ownerState": "The state of the Autocomplete component." + } + }, + "selectOnFocus": { + "description": "If true, the input's text is selected on focus. It helps the user clear the selected value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/avatar-group/avatar-group.json b/docs/translations/api-docs/avatar-group/avatar-group.json index af216ecd52b34d..8b4cb651c03af9 100644 --- a/docs/translations/api-docs/avatar-group/avatar-group.json +++ b/docs/translations/api-docs/avatar-group/avatar-group.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "children": "The avatars to stack.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "max": "Max avatars to show before +x.", - "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "spacing": "Spacing between avatars.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "total": "The total number of avatars. Used for calculating the number of extra avatars.", - "variant": "The variant to use." + "children": { + "description": "The avatars to stack.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "Max avatars to show before +x.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "spacing": { + "description": "Spacing between avatars.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "total": { + "description": "The total number of avatars. Used for calculating the number of extra avatars.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/avatar/avatar.json b/docs/translations/api-docs/avatar/avatar.json index 585772ace3613f..a42fe440b87d72 100644 --- a/docs/translations/api-docs/avatar/avatar.json +++ b/docs/translations/api-docs/avatar/avatar.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "alt": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", - "children": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "imgProps": "Attributes applied to the img element if the component is used to display an image. It can be used to listen for the loading error event.", - "sizes": "The sizes attribute for the img element.", - "src": "The src attribute for the img element.", - "srcSet": "The srcSet attribute for the img element. Use this attribute for responsive image display.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The shape of the avatar." + "alt": { + "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "imgProps": { + "description": "Attributes applied to the img element if the component is used to display an image. It can be used to listen for the loading error event.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sizes": { + "description": "The sizes attribute for the img element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "src": { + "description": "The src attribute for the img element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "srcSet": { + "description": "The srcSet attribute for the img element. Use this attribute for responsive image display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The shape of the avatar.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/backdrop/backdrop.json b/docs/translations/api-docs/backdrop/backdrop.json index e9e00bc3a6b0a8..50c7e6cffa8e47 100644 --- a/docs/translations/api-docs/backdrop/backdrop.json +++ b/docs/translations/api-docs/backdrop/backdrop.json @@ -1,18 +1,78 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "invisible": "If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.", - "open": "If true, the component is shown.", - "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "TransitionComponent": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "transitionDuration": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invisible": { + "description": "If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionComponent": { + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "transitionDuration": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/badge/badge.json b/docs/translations/api-docs/badge/badge.json index d4581d9dd4ae06..5f9001b4582011 100644 --- a/docs/translations/api-docs/badge/badge.json +++ b/docs/translations/api-docs/badge/badge.json @@ -1,22 +1,102 @@ { "componentDescription": "", "propDescriptions": { - "anchorOrigin": "The anchor of the badge.", - "badgeContent": "The content rendered within the badge.", - "children": "The badge will be added relative to this node.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "invisible": "If true, the badge is invisible.", - "max": "Max count to show.", - "overlap": "Wrapped shape the badge should overlap.", - "showZero": "Controls whether the badge is hidden when badgeContent is zero.", - "slotProps": "The props used for each slot inside the Badge.", - "slots": "The components used for each slot inside the Badge. 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 `sx` page for more details.", - "variant": "The variant to use." + "anchorOrigin": { + "description": "The anchor of the badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "badgeContent": { + "description": "The content rendered within the badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The badge will be added relative to this node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "invisible": { + "description": "If true, the badge is invisible.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "max": { + "description": "Max count to show.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "overlap": { + "description": "Wrapped shape the badge should overlap.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "showZero": { + "description": "Controls whether the badge is hidden when badgeContent is zero.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Badge.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json b/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json index f3bdb45ecb5ad5..a5d0b67741452b 100644 --- a/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json +++ b/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "This prop isn't supported. Use the component prop if you need to change the children structure.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "icon": "The icon to display.", - "label": "The label element.", - "showLabel": "If true, the BottomNavigationAction will show its label. By default, only the selected BottomNavigationAction inside BottomNavigation will show its label.
    The prop defaults to the value (false) inherited from the parent BottomNavigation component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "You can provide your own value. Otherwise, we fallback to the child position index." + "children": { + "description": "This prop isn't supported. Use the component prop if you need to change the children structure.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "icon": { + "description": "The icon to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "The label element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "showLabel": { + "description": "If true, the BottomNavigationAction will show its label. By default, only the selected BottomNavigationAction inside BottomNavigation will show its label.
    The prop defaults to the value (false) inherited from the parent BottomNavigation component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "You can provide your own value. Otherwise, we fallback to the child position index.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json index 8f504f158a0eaf..bf840f57eb85e6 100644 --- a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json +++ b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json @@ -1,13 +1,51 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "onChange": "Callback fired when the value changes.

    Signature:
    function(event: React.SyntheticEvent, value: any) => void
    • event: The event source of the callback. Warning: This is a generic event not a change event.
    • value: We default to the index of the child.
    ", - "showLabels": "If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The value of the currently selected BottomNavigationAction." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value changes.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. Warning: This is a generic event not a change event.", + "value": "We default to the index of the child." + } + }, + "showLabels": { + "description": "If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the currently selected BottomNavigationAction.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/box/box.json b/docs/translations/api-docs/box/box.json index 8d9dab0756f81f..c4ec7a90747529 100644 --- a/docs/translations/api-docs/box/box.json +++ b/docs/translations/api-docs/box/box.json @@ -1,8 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "component": "The component used for the root node. 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 `sx` page for more details." + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json index 5ec041c625611f..eea322480d97c1 100644 --- a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json +++ b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "expandText": "Override the default label for the expand button.
    For localization purposes, you can use the provided translations.", - "itemsAfterCollapse": "If max items is exceeded, the number of items to show after the ellipsis.", - "itemsBeforeCollapse": "If max items is exceeded, the number of items to show before the ellipsis.", - "maxItems": "Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first itemsBeforeCollapse and last itemsAfterCollapse will be shown, with an ellipsis in between.", - "separator": "Custom separator node.", - "slotProps": "The props used for each slot inside the Breadcumb.", - "slots": "The components used for each slot inside the Breadcumb. 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 `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "expandText": { + "description": "Override the default label for the expand button.
    For localization purposes, you can use the provided translations.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "itemsAfterCollapse": { + "description": "If max items is exceeded, the number of items to show after the ellipsis.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "itemsBeforeCollapse": { + "description": "If max items is exceeded, the number of items to show before the ellipsis.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxItems": { + "description": "Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first itemsBeforeCollapse and last itemsAfterCollapse will be shown, with an ellipsis in between.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "separator": { + "description": "Custom separator node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Breadcumb.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/button-base/button-base.json b/docs/translations/api-docs/button-base/button-base.json index 2a978b2c831cd5..2aaf0908055da4 100644 --- a/docs/translations/api-docs/button-base/button-base.json +++ b/docs/translations/api-docs/button-base/button-base.json @@ -1,21 +1,96 @@ { "componentDescription": "`ButtonBase` contains as few styles as possible.\nIt aims to be a simple building block for creating a button.\nIt contains a load of style reset and some focus/ripple logic.", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "centerRipple": "If true, the ripples are centered. They won't start at the cursor interaction position.", - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", - "disabled": "If true, the component is disabled.", - "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "disableTouchRipple": "If true, the touch ripple effect is disabled.", - "focusRipple": "If true, the base button will have a keyboard focus ripple.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "LinkComponent": "The component used to render a link when the href prop is provided.", - "onFocusVisible": "Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "TouchRippleProps": "Props applied to the TouchRipple element.", - "touchRippleRef": "A ref that points to the TouchRipple element." + "action": { + "description": "A ref for imperative actions. It currently only supports focusVisible() action.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "centerRipple": { + "description": "If true, the ripples are centered. They won't start at the cursor interaction position.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTouchRipple": { + "description": "If true, the touch ripple effect is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusRipple": { + "description": "If true, the base button will have a keyboard focus ripple.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "LinkComponent": { + "description": "The component used to render a link when the href prop is provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onFocusVisible": { + "description": "Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TouchRippleProps": { + "description": "Props applied to the TouchRipple element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "touchRippleRef": { + "description": "A ref that points to the TouchRipple element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/button-group/button-group.json b/docs/translations/api-docs/button-group/button-group.json index a789221f9ff5c4..4b70c1307a237f 100644 --- a/docs/translations/api-docs/button-group/button-group.json +++ b/docs/translations/api-docs/button-group/button-group.json @@ -1,19 +1,84 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "disableElevation": "If true, no elevation is used.", - "disableFocusRipple": "If true, the button keyboard focus ripple is disabled.", - "disableRipple": "If true, the button ripple effect is disabled.", - "fullWidth": "If true, the buttons will take up the full width of its container.", - "orientation": "The component orientation (layout flow direction).", - "size": "The size of the component. small is equivalent to the dense button styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableElevation": { + "description": "If true, no elevation is used.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableFocusRipple": { + "description": "If true, the button keyboard focus ripple is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the button ripple effect is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the buttons will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation (layout flow direction).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. small is equivalent to the dense button styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/button/button.json b/docs/translations/api-docs/button/button.json index da71ba84da8ec4..f4336e26f95988 100644 --- a/docs/translations/api-docs/button/button.json +++ b/docs/translations/api-docs/button/button.json @@ -1,21 +1,96 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "disableElevation": "If true, no elevation is used.", - "disableFocusRipple": "If true, the keyboard focus ripple is disabled.", - "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "endIcon": "Element placed after the children.", - "fullWidth": "If true, the button will take up the full width of its container.", - "href": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", - "size": "The size of the component. small is equivalent to the dense button styling.", - "startIcon": "Element placed before the children.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableElevation": { + "description": "If true, no elevation is used.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableFocusRipple": { + "description": "If true, the keyboard focus ripple is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endIcon": { + "description": "Element placed after the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the button will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "href": { + "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. small is equivalent to the dense button styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startIcon": { + "description": "Element placed before the children.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card-action-area/card-action-area.json b/docs/translations/api-docs/card-action-area/card-action-area.json index 086fa5b50ddf11..adfbf3c3a9a6e9 100644 --- a/docs/translations/api-docs/card-action-area/card-action-area.json +++ b/docs/translations/api-docs/card-action-area/card-action-area.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card-actions/card-actions.json b/docs/translations/api-docs/card-actions/card-actions.json index 5a86c9bd70a360..ce01b36ba37df7 100644 --- a/docs/translations/api-docs/card-actions/card-actions.json +++ b/docs/translations/api-docs/card-actions/card-actions.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableSpacing": "If true, the actions do not have additional margin.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSpacing": { + "description": "If true, the actions do not have additional margin.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card-content/card-content.json b/docs/translations/api-docs/card-content/card-content.json index ff27adf5730304..6e17d494dc27f6 100644 --- a/docs/translations/api-docs/card-content/card-content.json +++ b/docs/translations/api-docs/card-content/card-content.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. 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 `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/card-header/card-header.json b/docs/translations/api-docs/card-header/card-header.json index acbe290e41da17..c8fcfdb6e0fef0 100644 --- a/docs/translations/api-docs/card-header/card-header.json +++ b/docs/translations/api-docs/card-header/card-header.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "action": "The action to display in the card header.", - "avatar": "The Avatar element to display.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disableTypography": "If true, subheader and title won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the title text, and optional subheader text with the Typography component.", - "subheader": "The content of the component.", - "subheaderTypographyProps": "These props will be forwarded to the subheader (as long as disableTypography is not true).", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "title": "The content of the component.", - "titleTypographyProps": "These props will be forwarded to the title (as long as disableTypography is not true)." + "action": { + "description": "The action to display in the card header.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "avatar": { + "description": "The Avatar element to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTypography": { + "description": "If true, subheader and title won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the title text, and optional subheader text with the Typography component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "subheader": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "subheaderTypographyProps": { + "description": "These props will be forwarded to the subheader (as long as disableTypography is not true).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "title": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "titleTypographyProps": { + "description": "These props will be forwarded to the title (as long as disableTypography is not true).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card-media/card-media.json b/docs/translations/api-docs/card-media/card-media.json index 0e5a92ab2779a3..5123bbe6e95ed8 100644 --- a/docs/translations/api-docs/card-media/card-media.json +++ b/docs/translations/api-docs/card-media/card-media.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "image": "Image to be displayed as a background image. Either image or src prop must be specified. Note that caller must specify height otherwise the image will not be visible.", - "src": "An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "image": { + "description": "Image to be displayed as a background image. Either image or src prop must be specified. Note that caller must specify height otherwise the image will not be visible.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "src": { + "description": "An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card/card.json b/docs/translations/api-docs/card/card.json index feb6f7366eddd9..8fc1c52209a508 100644 --- a/docs/translations/api-docs/card/card.json +++ b/docs/translations/api-docs/card/card.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "raised": "If true, the card will use raised styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "raised": { + "description": "If true, the card will use raised styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/checkbox/checkbox.json b/docs/translations/api-docs/checkbox/checkbox.json index 9e8b71173631a5..0305f31c4501e6 100644 --- a/docs/translations/api-docs/checkbox/checkbox.json +++ b/docs/translations/api-docs/checkbox/checkbox.json @@ -1,24 +1,116 @@ { "componentDescription": "", "propDescriptions": { - "checked": "If true, the component is checked.", - "checkedIcon": "The icon to display when the component is checked.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "defaultChecked": "The default checked state. Use when the component is not controlled.", - "disabled": "If true, the component is disabled.", - "disableRipple": "If true, the ripple effect is disabled.", - "icon": "The icon to display when the component is unchecked.", - "id": "The id of the input element.", - "indeterminate": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", - "indeterminateIcon": "The icon to display when the component is indeterminate.", - "inputProps": "Attributes applied to the input element.", - "inputRef": "Pass a ref to the input element.", - "onChange": "Callback fired when the state is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "required": "If true, the input element is required.", - "size": "The size of the component. small is equivalent to the dense checkbox styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value." + "checked": { + "description": "If true, the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "checkedIcon": { + "description": "The icon to display when the component is checked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultChecked": { + "description": "The default checked state. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the ripple effect is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "icon": { + "description": "The icon to display when the component is unchecked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "The id of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "indeterminate": { + "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "indeterminateIcon": { + "description": "The icon to display when the component is indeterminate.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputProps": { + "description": "Attributes applied to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputRef": { + "description": "Pass a ref to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "required": { + "description": "If true, the input element is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. small is equivalent to the dense checkbox styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/chip/chip.json b/docs/translations/api-docs/chip/chip.json index 2a39e6b8f90a2e..5d09e8600324ba 100644 --- a/docs/translations/api-docs/chip/chip.json +++ b/docs/translations/api-docs/chip/chip.json @@ -1,21 +1,96 @@ { "componentDescription": "Chips represent complex entities in small blocks, such as a contact.", "propDescriptions": { - "avatar": "The Avatar element to display.", - "children": "This prop isn't supported. Use the component prop if you need to change the children structure.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "clickable": "If true, the chip will appear clickable, and will raise when pressed, even if the onClick prop is not defined. If false, the chip will not appear clickable, even if onClick prop is defined. This can be used, for example, along with the component prop to indicate an anchor Chip is clickable. Note: this controls the UI and does not affect the onClick event.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "deleteIcon": "Override the default delete icon element. Shown only if onDelete is set.", - "disabled": "If true, the component is disabled.", - "icon": "Icon element.", - "label": "The content of the component.", - "onDelete": "Callback fired when the delete icon is clicked. If set, the delete icon will be shown.", - "size": "The size of the component.", - "skipFocusWhenDisabled": "If true, allows the disabled chip to escape focus. If false, allows the disabled chip to receive focus.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "avatar": { + "description": "The Avatar element to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "This prop isn't supported. Use the component prop if you need to change the children structure.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "clickable": { + "description": "If true, the chip will appear clickable, and will raise when pressed, even if the onClick prop is not defined. If false, the chip will not appear clickable, even if onClick prop is defined. This can be used, for example, along with the component prop to indicate an anchor Chip is clickable. Note: this controls the UI and does not affect the onClick event.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "deleteIcon": { + "description": "Override the default delete icon element. Shown only if onDelete is set.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "icon": { + "description": "Icon element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onDelete": { + "description": "Callback fired when the delete icon is clicked. If set, the delete icon will be shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "skipFocusWhenDisabled": { + "description": "If true, allows the disabled chip to escape focus. If false, allows the disabled chip to receive focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/circular-progress/circular-progress.json b/docs/translations/api-docs/circular-progress/circular-progress.json index 0536e31502071f..ca62be39afa91d 100644 --- a/docs/translations/api-docs/circular-progress/circular-progress.json +++ b/docs/translations/api-docs/circular-progress/circular-progress.json @@ -1,14 +1,54 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "disableShrink": "If true, the shrink animation is disabled. This only works if variant is indeterminate.", - "size": "The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "thickness": "The thickness of the circle.", - "value": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "variant": "The variant to use. Use indeterminate when there is no progress value." + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableShrink": { + "description": "If true, the shrink animation is disabled. This only works if variant is indeterminate.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "thickness": { + "description": "The thickness of the circle.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use. Use indeterminate when there is no progress value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/collapse/collapse.json b/docs/translations/api-docs/collapse/collapse.json index 54675b9c11e3a8..b649ec61e99283 100644 --- a/docs/translations/api-docs/collapse/collapse.json +++ b/docs/translations/api-docs/collapse/collapse.json @@ -1,16 +1,66 @@ { "componentDescription": "The Collapse transition is used by the\n[Vertical Stepper](/material-ui/react-stepper/#vertical-stepper) StepContent component.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { - "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "children": "The content node to be collapsed.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "collapsedSize": "The width (horizontal) or height (vertical) of the container when collapsed.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", - "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "in": "If true, the component will transition in.", - "orientation": "The transition orientation.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." + "addEndListener": { + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content node to be collapsed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "collapsedSize": { + "description": "The width (horizontal) or height (vertical) of the container when collapsed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "easing": { + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "in": { + "description": "If true, the component will transition in.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The transition orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "timeout": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/container/container.json b/docs/translations/api-docs/container/container.json index 96732024ffa060..91f0a0d57c07d5 100644 --- a/docs/translations/api-docs/container/container.json +++ b/docs/translations/api-docs/container/container.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disableGutters": "If true, the left and right padding is removed.", - "fixed": "Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default.", - "maxWidth": "Determine the max-width of the container. The container width grows with the size of the screen. Set to false to disable maxWidth.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, the left and right padding is removed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fixed": { + "description": "Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxWidth": { + "description": "Determine the max-width of the container. The container width grows with the size of the screen. Set to false to disable maxWidth.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/css-baseline/css-baseline.json b/docs/translations/api-docs/css-baseline/css-baseline.json index 4ee0b2b962dff0..33d27baaf15486 100644 --- a/docs/translations/api-docs/css-baseline/css-baseline.json +++ b/docs/translations/api-docs/css-baseline/css-baseline.json @@ -1,8 +1,18 @@ { "componentDescription": "Kickstart an elegant, consistent, and simple baseline to build upon.", "propDescriptions": { - "children": "You can wrap a node.", - "enableColorScheme": "Enable color-scheme CSS property to use theme.palette.mode. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme" + "children": { + "description": "You can wrap a node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "enableColorScheme": { + "description": "Enable color-scheme CSS property to use theme.palette.mode. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/dialog-actions/dialog-actions.json b/docs/translations/api-docs/dialog-actions/dialog-actions.json index 5a86c9bd70a360..ce01b36ba37df7 100644 --- a/docs/translations/api-docs/dialog-actions/dialog-actions.json +++ b/docs/translations/api-docs/dialog-actions/dialog-actions.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableSpacing": "If true, the actions do not have additional margin.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSpacing": { + "description": "If true, the actions do not have additional margin.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/dialog-content-text/dialog-content-text.json b/docs/translations/api-docs/dialog-content-text/dialog-content-text.json index b196b58c3dfbc6..3fc8ceebe8157c 100644 --- a/docs/translations/api-docs/dialog-content-text/dialog-content-text.json +++ b/docs/translations/api-docs/dialog-content-text/dialog-content-text.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/dialog-content/dialog-content.json b/docs/translations/api-docs/dialog-content/dialog-content.json index 68863704411284..46ab02c15c0f63 100644 --- a/docs/translations/api-docs/dialog-content/dialog-content.json +++ b/docs/translations/api-docs/dialog-content/dialog-content.json @@ -1,10 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "dividers": "Display the top and bottom dividers.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "dividers": { + "description": "Display the top and bottom dividers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/dialog-title/dialog-title.json b/docs/translations/api-docs/dialog-title/dialog-title.json index b196b58c3dfbc6..3fc8ceebe8157c 100644 --- a/docs/translations/api-docs/dialog-title/dialog-title.json +++ b/docs/translations/api-docs/dialog-title/dialog-title.json @@ -1,9 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/dialog/dialog.json b/docs/translations/api-docs/dialog/dialog.json index 2e8228018b4700..36ae5c87caf13f 100644 --- a/docs/translations/api-docs/dialog/dialog.json +++ b/docs/translations/api-docs/dialog/dialog.json @@ -1,25 +1,123 @@ { "componentDescription": "Dialogs are overlaid modal paper based components with a backdrop.", "propDescriptions": { - "aria-describedby": "The id(s) of the element(s) that describe the dialog.", - "aria-labelledby": "The id(s) of the element(s) that label the dialog.", - "BackdropComponent": "A backdrop component. This prop enables custom backdrop rendering.", - "children": "Dialog children, usually the included sub-components.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableEscapeKeyDown": "If true, hitting escape will not fire the onClose callback.", - "fullScreen": "If true, the dialog is full-screen.", - "fullWidth": "If true, the dialog stretches to maxWidth.
    Notice that the dialog width grow is limited by the default margin.", - "maxWidth": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.", - "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", - "open": "If true, the component is shown.", - "PaperComponent": "The component used to render the body of the dialog.", - "PaperProps": "Props applied to the Paper element.", - "scroll": "Determine the container for scrolling the dialog.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "TransitionComponent": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "transitionDuration": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", - "TransitionProps": "Props applied to the transition element. By default, the element is based on this Transition component." + "aria-describedby": { + "description": "The id(s) of the element(s) that describe the dialog.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "aria-labelledby": { + "description": "The id(s) of the element(s) that label the dialog.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "BackdropComponent": { + "description": "A backdrop component. This prop enables custom backdrop rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Dialog children, usually the included sub-components.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEscapeKeyDown": { + "description": "If true, hitting escape will not fire the onClose callback.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullScreen": { + "description": "If true, the dialog is full-screen.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the dialog stretches to maxWidth.
    Notice that the dialog width grow is limited by the default margin.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxWidth": { + "description": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onBackdropClick": { + "description": "Callback fired when the backdrop is clicked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "escapeKeyDown", "backdropClick"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PaperComponent": { + "description": "The component used to render the body of the dialog.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PaperProps": { + "description": "Props applied to the Paper element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "scroll": { + "description": "Determine the container for scrolling the dialog.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionComponent": { + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "transitionDuration": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionProps": { + "description": "Props applied to the transition element. By default, the element is based on this Transition component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/divider/divider.json b/docs/translations/api-docs/divider/divider.json index df91195b789978..016b87e6b77ddf 100644 --- a/docs/translations/api-docs/divider/divider.json +++ b/docs/translations/api-docs/divider/divider.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "absolute": "Absolutely position the element.", - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "flexItem": "If true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)", - "light": "If true, the divider will have a lighter color.", - "orientation": "The component orientation.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "textAlign": "The text alignment.", - "variant": "The variant to use." + "absolute": { + "description": "Absolutely position the element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "flexItem": { + "description": "If true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "light": { + "description": "If true, the divider will have a lighter color.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "orientation": { + "description": "The component orientation.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "textAlign": { + "description": "The text alignment.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/drawer/drawer.json b/docs/translations/api-docs/drawer/drawer.json index 40fbdd4e69eb1d..f0c688f4e4c0ca 100644 --- a/docs/translations/api-docs/drawer/drawer.json +++ b/docs/translations/api-docs/drawer/drawer.json @@ -1,19 +1,84 @@ { "componentDescription": "The props of the [Modal](/material-ui/api/modal/) component are available\nwhen `variant=\"temporary\"` is set.", "propDescriptions": { - "anchor": "Side from which the drawer will appear.", - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "elevation": "The elevation of the drawer.", - "hideBackdrop": "If true, the backdrop is not rendered.", - "ModalProps": "Props applied to the Modal element.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object) => void
    • event: The event source of the callback.
    ", - "open": "If true, the component is shown.", - "PaperProps": "Props applied to the Paper element.", - "SlideProps": "Props applied to the Slide element.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page 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.", - "variant": "The variant to use." + "anchor": { + "description": "Side from which the drawer will appear.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "elevation": { + "description": "The elevation of the drawer.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hideBackdrop": { + "description": "If true, the backdrop is not rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ModalProps": { + "description": "Props applied to the Modal element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { "event": "The event source of the callback." } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PaperProps": { + "description": "Props applied to the Paper element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "SlideProps": { + "description": "Props applied to the Slide element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "transitionDuration": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/fab/fab.json b/docs/translations/api-docs/fab/fab.json index 25d3b9029e829f..35c9a2b7920ad6 100644 --- a/docs/translations/api-docs/fab/fab.json +++ b/docs/translations/api-docs/fab/fab.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the component is disabled.", - "disableFocusRipple": "If true, the keyboard focus ripple is disabled.", - "disableRipple": "If true, the ripple effect is disabled.", - "href": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", - "size": "The size of the component. small is equivalent to the dense button styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableFocusRipple": { + "description": "If true, the keyboard focus ripple is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the ripple effect is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "href": { + "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. small is equivalent to the dense button styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/fade/fade.json b/docs/translations/api-docs/fade/fade.json index 0bba3e53438830..48a32c621a6f6a 100644 --- a/docs/translations/api-docs/fade/fade.json +++ b/docs/translations/api-docs/fade/fade.json @@ -1,12 +1,42 @@ { "componentDescription": "The Fade transition is used by the [Modal](/material-ui/react-modal/) component.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { - "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "in": "If true, the component will transition in.", - "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." + "addEndListener": { + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "appear": { + "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "easing": { + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "in": { + "description": "If true, the component will transition in.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "timeout": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/filled-input/filled-input.json b/docs/translations/api-docs/filled-input/filled-input.json index 378a21f8ad728b..298a555fe55d3b 100644 --- a/docs/translations/api-docs/filled-input/filled-input.json +++ b/docs/translations/api-docs/filled-input/filled-input.json @@ -1,39 +1,206 @@ { "componentDescription": "", "propDescriptions": { - "autoComplete": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "autoFocus": "If true, the input element is focused during the first mount.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "disableUnderline": "If true, the input will not have an underline.", - "endAdornment": "End InputAdornment for this component.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "fullWidth": "If true, the input will take up the full width of its container.", - "hiddenLabel": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", - "id": "The id of the input element.", - "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.", - "inputProps": "Attributes applied to the input element.", - "inputRef": "Pass a ref to the input element.", - "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "maxRows": "Maximum number of rows to display when multiline option is set to true.", - "minRows": "Minimum number of rows to display when multiline option is set to true.", - "multiline": "If true, a TextareaAutosize element is rendered.", - "name": "Name attribute of the input element.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", - "placeholder": "The short hint displayed in the input before the user enters a value.", - "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", - "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "rows": "Number of rows to display when multiline option is set to true.", - "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "startAdornment": "Start InputAdornment for this component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "type": "Type of the input element. It should be a valid HTML5 input type.", - "value": "The value of the input element, required for a controlled component." + "autoComplete": { + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the input element is focused during the first mount.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableUnderline": { + "description": "If true, the input will not have an underline.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endAdornment": { + "description": "End InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the input will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hiddenLabel": { + "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "The id of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputComponent": { + "description": "The component used for the input element. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputProps": { + "description": "Attributes applied to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputRef": { + "description": "Pass a ref to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxRows": { + "description": "Maximum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiline": { + "description": "If true, a TextareaAutosize element is rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." + } + }, + "placeholder": { + "description": "The short hint displayed in the input before the user enters a value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "It prevents the user from changing the value of the field (not from interacting with the field).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rows": { + "description": "Number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startAdornment": { + "description": "Start InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "type": { + "description": "Type of the input element. It should be a valid HTML5 input type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the input element, required for a controlled component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-control-label/form-control-label.json b/docs/translations/api-docs/form-control-label/form-control-label.json index 012f6ca13aba8a..a5311dcbe85e1f 100644 --- a/docs/translations/api-docs/form-control-label/form-control-label.json +++ b/docs/translations/api-docs/form-control-label/form-control-label.json @@ -1,20 +1,92 @@ { "componentDescription": "Drop-in replacement of the `Radio`, `Switch` and `Checkbox` component.\nUse this component if you want to display an extra label.", "propDescriptions": { - "checked": "If true, the component appears selected.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "componentsProps": "The props used for each slot inside.", - "control": "A control element. For instance, it can be a Radio, a Switch or a Checkbox.", - "disabled": "If true, the control is disabled.", - "disableTypography": "If true, the label is rendered as it is passed without an additional typography node.", - "inputRef": "Pass a ref to the input element.", - "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.

    Signature:
    function(event: React.SyntheticEvent) => void
    • event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
    ", - "required": "If true, the label will indicate that the input is required.", - "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 `sx` page for more details.", - "value": "The value of the component." + "checked": { + "description": "If true, the component appears selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "control": { + "description": "A control element. For instance, it can be a Radio, a Switch or a Checkbox.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the control is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTypography": { + "description": "If true, the label is rendered as it is passed without an additional typography node.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputRef": { + "description": "Pass a ref to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "label": { + "description": "A text or an element to be used in an enclosing label element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "labelPlacement": { + "description": "The position of the label.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the state is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean)." + } + }, + "required": { + "description": "If true, the label will indicate that the input is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-control/form-control.json b/docs/translations/api-docs/form-control/form-control.json index 31c98e255dbb53..f98bb7c670eaf4 100644 --- a/docs/translations/api-docs/form-control/form-control.json +++ b/docs/translations/api-docs/form-control/form-control.json @@ -1,20 +1,90 @@ { "componentDescription": "Provides context such as filled/focused/error/required for form inputs.\nRelying on the context provides high flexibility and ensures that the state always stays\nconsistent across the children of the `FormControl`.\nThis context is used by the following components:\n\n - FormLabel\n - FormHelperText\n - Input\n - InputLabel\n\nYou can find one composition example below and more going to [the demos](/material-ui/react-text-field/#components).\n\n```jsx\n\n Email address\n \n We'll never share your email.\n\n```\n\n⚠️ Only one `InputBase` can be used within a FormControl because it creates visual inconsistencies.\nFor instance, only one input can be focused at the same time, the state shouldn't be shared.", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the label, input and helper text should be displayed in a disabled state.", - "error": "If true, the label is displayed in an error state.", - "focused": "If true, the component is displayed in focused state.", - "fullWidth": "If true, the component will take up the full width of its container.", - "hiddenLabel": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", - "margin": "If dense or normal, will adjust vertical spacing of this and contained components.", - "required": "If true, the label will indicate that the input is required.", - "size": "The size of the component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the label, input and helper text should be displayed in a disabled state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the label is displayed in an error state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focused": { + "description": "If true, the component is displayed in focused state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the component will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hiddenLabel": { + "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense or normal, will adjust vertical spacing of this and contained components.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the label will indicate that the input is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-group/form-group.json b/docs/translations/api-docs/form-group/form-group.json index c44f05a7851a0b..e3edf11acde990 100644 --- a/docs/translations/api-docs/form-group/form-group.json +++ b/docs/translations/api-docs/form-group/form-group.json @@ -1,10 +1,30 @@ { "componentDescription": "`FormGroup` wraps controls such as `Checkbox` and `Switch`.\nIt provides compact row layout.\nFor the `Radio`, you should be using the `RadioGroup` component instead of this one.", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "row": "Display group of elements in a compact row.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "row": { + "description": "Display group of elements in a compact row.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-helper-text/form-helper-text.json b/docs/translations/api-docs/form-helper-text/form-helper-text.json index 5c305d80f923a9..f63d13d4fb39f5 100644 --- a/docs/translations/api-docs/form-helper-text/form-helper-text.json +++ b/docs/translations/api-docs/form-helper-text/form-helper-text.json @@ -1,17 +1,72 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.
    If ' ' is provided, the component reserves one line height for displaying a future message.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the helper text should be displayed in a disabled state.", - "error": "If true, helper text should be displayed in an error state.", - "filled": "If true, the helper text should use filled classes key.", - "focused": "If true, the helper text should use focused classes key.", - "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", - "required": "If true, the helper text should use required classes key.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.
    If ' ' is provided, the component reserves one line height for displaying a future message.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the helper text should be displayed in a disabled state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, helper text should be displayed in an error state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "filled": { + "description": "If true, the helper text should use filled classes key.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focused": { + "description": "If true, the helper text should use focused classes key.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the helper text should use required classes key.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-label/form-label.json b/docs/translations/api-docs/form-label/form-label.json index d4cb70dfdbaa70..7ccb08e7b86df6 100644 --- a/docs/translations/api-docs/form-label/form-label.json +++ b/docs/translations/api-docs/form-label/form-label.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disabled": "If true, the label should be displayed in a disabled state.", - "error": "If true, the label is displayed in an error state.", - "filled": "If true, the label should use filled classes key.", - "focused": "If true, the input of this label is focused (used by FormGroup components).", - "required": "If true, the label will indicate that the input is required.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the label should be displayed in a disabled state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the label is displayed in an error state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "filled": { + "description": "If true, the label should use filled classes key.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focused": { + "description": "If true, the input of this label is focused (used by FormGroup components).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the label will indicate that the input is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/global-styles/global-styles.json b/docs/translations/api-docs/global-styles/global-styles.json index c53a9a9eef06f3..4170f1b8a1383f 100644 --- a/docs/translations/api-docs/global-styles/global-styles.json +++ b/docs/translations/api-docs/global-styles/global-styles.json @@ -1,5 +1,12 @@ { "componentDescription": "", - "propDescriptions": { "styles": "The styles you want to apply globally." }, + "propDescriptions": { + "styles": { + "description": "The styles you want to apply globally.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } + }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/grid/grid.json b/docs/translations/api-docs/grid/grid.json index 5f47be155550d5..784fe6c7b17d2d 100644 --- a/docs/translations/api-docs/grid/grid.json +++ b/docs/translations/api-docs/grid/grid.json @@ -1,25 +1,120 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "columns": "The number of columns.", - "columnSpacing": "Defines the horizontal space between the type item components. It overrides the value of the spacing prop.", - "container": "If true, the component will have the flex container behavior. You should be wrapping items with a container.", - "direction": "Defines the flex-direction style property. It is applied for all screen sizes.", - "disableEqualOverflow": "If true, the negative margin and padding are apply only to the top and left sides of the grid.", - "lg": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the lg breakpoint and wider screens if not overridden.", - "lgOffset": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the lg breakpoint and wider screens if not overridden.", - "md": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the md breakpoint and wider screens if not overridden.", - "mdOffset": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the md breakpoint and wider screens if not overridden.", - "rowSpacing": "Defines the vertical space between the type item components. It overrides the value of the spacing prop.", - "sm": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the sm breakpoint and wider screens if not overridden.", - "smOffset": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the sm breakpoint and wider screens if not overridden.", - "spacing": "Defines the space between the type item components. It can only be used on a type container component.", - "wrap": "Defines the flex-wrap style property. It's applied for all screen sizes.", - "xl": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the xl breakpoint and wider screens if not overridden.", - "xlOffset": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xl breakpoint and wider screens if not overridden.", - "xs": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for all the screen sizes with the lowest priority.", - "xsOffset": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xs breakpoint and wider screens if not overridden." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "columns": { + "description": "The number of columns.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "columnSpacing": { + "description": "Defines the horizontal space between the type item components. It overrides the value of the spacing prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "If true, the component will have the flex container behavior. You should be wrapping items with a container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "direction": { + "description": "Defines the flex-direction style property. It is applied for all screen sizes.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEqualOverflow": { + "description": "If true, the negative margin and padding are apply only to the top and left sides of the grid.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "lg": { + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the lg breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "lgOffset": { + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the lg breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "md": { + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the md breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "mdOffset": { + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the md breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rowSpacing": { + "description": "Defines the vertical space between the type item components. It overrides the value of the spacing prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sm": { + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the sm breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "smOffset": { + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the sm breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "spacing": { + "description": "Defines the space between the type item components. It can only be used on a type container component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "wrap": { + "description": "Defines the flex-wrap style property. It's applied for all screen sizes.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xl": { + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the xl breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xlOffset": { + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xl breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xs": { + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for all the screen sizes with the lowest priority.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xsOffset": { + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xs breakpoint and wider screens if not overridden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/grow/grow.json b/docs/translations/api-docs/grow/grow.json index beca0e5c5384f3..d3219e2b83dca2 100644 --- a/docs/translations/api-docs/grow/grow.json +++ b/docs/translations/api-docs/grow/grow.json @@ -1,12 +1,42 @@ { "componentDescription": "The Grow transition is used by the [Tooltip](/material-ui/react-tooltip/) and\n[Popover](/material-ui/react-popover/) components.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { - "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "in": "If true, the component will transition in.", - "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." + "addEndListener": { + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "appear": { + "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "easing": { + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "in": { + "description": "If true, the component will transition in.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "timeout": { + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/hidden/hidden.json b/docs/translations/api-docs/hidden/hidden.json index 7bc5b483e804d3..db332f2268dd69 100644 --- a/docs/translations/api-docs/hidden/hidden.json +++ b/docs/translations/api-docs/hidden/hidden.json @@ -1,20 +1,90 @@ { "componentDescription": "Responsively hides children based on the selected implementation.", "propDescriptions": { - "children": "The content of the component.", - "implementation": "Specify which implementation to use. 'js' is the default, 'css' works better for server-side rendering.", - "initialWidth": "You can use this prop when choosing the js implementation with server-side rendering.
    As window.innerWidth is unavailable on the server, we default to rendering an empty component during the first mount. You might want to use a heuristic to approximate the screen width of the client browser screen width.
    For instance, you could be using the user-agent or the client-hints. https://caniuse.com/#search=client%20hint", - "lgDown": "If true, screens this size and down are hidden.", - "lgUp": "If true, screens this size and up are hidden.", - "mdDown": "If true, screens this size and down are hidden.", - "mdUp": "If true, screens this size and up are hidden.", - "only": "Hide the given breakpoint(s).", - "smDown": "If true, screens this size and down are hidden.", - "smUp": "If true, screens this size and up are hidden.", - "xlDown": "If true, screens this size and down are hidden.", - "xlUp": "If true, screens this size and up are hidden.", - "xsDown": "If true, screens this size and down are hidden.", - "xsUp": "If true, screens this size and up are hidden." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "implementation": { + "description": "Specify which implementation to use. 'js' is the default, 'css' works better for server-side rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "initialWidth": { + "description": "You can use this prop when choosing the js implementation with server-side rendering.
    As window.innerWidth is unavailable on the server, we default to rendering an empty component during the first mount. You might want to use a heuristic to approximate the screen width of the client browser screen width.
    For instance, you could be using the user-agent or the client-hints. https://caniuse.com/#search=client%20hint", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "lgDown": { + "description": "If true, screens this size and down are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "lgUp": { + "description": "If true, screens this size and up are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "mdDown": { + "description": "If true, screens this size and down are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "mdUp": { + "description": "If true, screens this size and up are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "only": { + "description": "Hide the given breakpoint(s).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "smDown": { + "description": "If true, screens this size and down are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "smUp": { + "description": "If true, screens this size and up are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xlDown": { + "description": "If true, screens this size and down are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xlUp": { + "description": "If true, screens this size and up are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xsDown": { + "description": "If true, screens this size and down are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "xsUp": { + "description": "If true, screens this size and up are hidden.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/icon-button/icon-button.json b/docs/translations/api-docs/icon-button/icon-button.json index 627a0420deb213..e07ee6bd65a829 100644 --- a/docs/translations/api-docs/icon-button/icon-button.json +++ b/docs/translations/api-docs/icon-button/icon-button.json @@ -1,15 +1,60 @@ { "componentDescription": "Refer to the [Icons](/material-ui/icons/) section of the documentation\nregarding the available icon options.", "propDescriptions": { - "children": "The icon to display.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "disabled": "If true, the component is disabled.", - "disableFocusRipple": "If true, the keyboard focus ripple is disabled.", - "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "edge": "If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).", - "size": "The size of the component. small is equivalent to the dense button styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The icon to display.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableFocusRipple": { + "description": "If true, the keyboard focus ripple is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRipple": { + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "edge": { + "description": "If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component. small is equivalent to the dense button styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/icon/icon.json b/docs/translations/api-docs/icon/icon.json index 89667522f02c42..cb120de58fd42c 100644 --- a/docs/translations/api-docs/icon/icon.json +++ b/docs/translations/api-docs/icon/icon.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "baseClassName": "The base class applied to the icon. Defaults to 'material-icons', but can be changed to any other base class that suits the icon font you're using (e.g. material-icons-rounded, fas, etc).", - "children": "The name of the icon font ligature.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "fontSize": "The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "baseClassName": { + "description": "The base class applied to the icon. Defaults to 'material-icons', but can be changed to any other base class that suits the icon font you're using (e.g. material-icons-rounded, fas, etc).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The name of the icon font ligature.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fontSize": { + "description": "The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json b/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json index d734114166b690..afae7add43b61b 100644 --- a/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json +++ b/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "actionIcon": "An IconButton element to be used as secondary action target (primary action target is the item itself).", - "actionPosition": "Position of secondary action IconButton.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "position": "Position of the title bar.", - "subtitle": "String or element serving as subtitle (support text).", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "title": "Title to be displayed." + "actionIcon": { + "description": "An IconButton element to be used as secondary action target (primary action target is the item itself).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "actionPosition": { + "description": "Position of secondary action IconButton.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "position": { + "description": "Position of the title bar.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "subtitle": { + "description": "String or element serving as subtitle (support text).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "title": { + "description": "Title to be displayed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/image-list-item/image-list-item.json b/docs/translations/api-docs/image-list-item/image-list-item.json index 78410d59c61065..98491346a09d7a 100644 --- a/docs/translations/api-docs/image-list-item/image-list-item.json +++ b/docs/translations/api-docs/image-list-item/image-list-item.json @@ -1,12 +1,42 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component, normally an <img>.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "cols": "Width of the item in number of grid columns.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "rows": "Height of the item in number of grid rows.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component, normally an <img>.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "cols": { + "description": "Width of the item in number of grid columns.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rows": { + "description": "Height of the item in number of grid rows.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/image-list/image-list.json b/docs/translations/api-docs/image-list/image-list.json index 0027c364f2124d..7aeec55d7d6d47 100644 --- a/docs/translations/api-docs/image-list/image-list.json +++ b/docs/translations/api-docs/image-list/image-list.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component, normally ImageListItems.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "cols": "Number of columns.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "gap": "The gap between items in px.", - "rowHeight": "The height of one row in px.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component, normally ImageListItems.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "cols": { + "description": "Number of columns.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "gap": { + "description": "The gap between items in px.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rowHeight": { + "description": "The height of one row in px.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input-adornment/input-adornment.json b/docs/translations/api-docs/input-adornment/input-adornment.json index 5a1a8310fa81f6..862c6287c41add 100644 --- a/docs/translations/api-docs/input-adornment/input-adornment.json +++ b/docs/translations/api-docs/input-adornment/input-adornment.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component, normally an IconButton or string.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disablePointerEvents": "Disable pointer events on the root. This allows for the content of the adornment to focus the input on click.", - "disableTypography": "If children is a string then disable wrapping in a Typography component.", - "position": "The position this adornment should appear relative to the Input.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use. Note: If you are using the TextField component or the FormControl component you do not have to set this manually." + "children": { + "description": "The content of the component, normally an IconButton or string.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePointerEvents": { + "description": "Disable pointer events on the root. This allows for the content of the adornment to focus the input on click.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTypography": { + "description": "If children is a string then disable wrapping in a Typography component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "position": { + "description": "The position this adornment should appear relative to the Input.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use. Note: If you are using the TextField component or the FormControl component you do not have to set this manually.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input-base/input-base.json b/docs/translations/api-docs/input-base/input-base.json index be46a905030b5d..eb25764fed7a91 100644 --- a/docs/translations/api-docs/input-base/input-base.json +++ b/docs/translations/api-docs/input-base/input-base.json @@ -1,41 +1,218 @@ { "componentDescription": "`InputBase` contains as few styles as possible.\nIt aims to be a simple building block for creating an input.\nIt contains a load of style reset and some state logic.", "propDescriptions": { - "autoComplete": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "autoFocus": "If true, the input element is focused during the first mount.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "disableInjectingGlobalStyles": "If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.", - "endAdornment": "End InputAdornment for this component.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "fullWidth": "If true, the input will take up the full width of its container.", - "id": "The id of the input element.", - "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", - "inputProps": "Attributes applied to the input element.", - "inputRef": "Pass a ref to the input element.", - "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "maxRows": "Maximum number of rows to display when multiline option is set to true.", - "minRows": "Minimum number of rows to display when multiline option is set to true.", - "multiline": "If true, a TextareaAutosize element is rendered.", - "name": "Name attribute of the input element.", - "onBlur": "Callback fired when the input is blurred.
    Notice that the first argument (event) might be undefined.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", - "onInvalid": "Callback fired when the input doesn't satisfy its constraints.", - "placeholder": "The short hint displayed in the input before the user enters a value.", - "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", - "required": "If true, the input element is required. The prop defaults to the value (false) 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 extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "startAdornment": "Start InputAdornment for this component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "type": "Type of the input element. It should be a valid HTML5 input type.", - "value": "The value of the input element, required for a controlled component." + "autoComplete": { + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the input element is focused during the first mount.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableInjectingGlobalStyles": { + "description": "If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endAdornment": { + "description": "End InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the input will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "The id of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputComponent": { + "description": "The component used for the input element. Either a string to use a HTML element or a component.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "inputProps": { + "description": "Attributes applied to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputRef": { + "description": "Pass a ref to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxRows": { + "description": "Maximum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiline": { + "description": "If true, a TextareaAutosize element is rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onBlur": { + "description": "Callback fired when the input is blurred.
    Notice that the first argument (event) might be undefined.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." + } + }, + "onInvalid": { + "description": "Callback fired when the input doesn't satisfy its constraints.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "placeholder": { + "description": "The short hint displayed in the input before the user enters a value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "It prevents the user from changing the value of the field (not from interacting with the field).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rows": { + "description": "Number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startAdornment": { + "description": "Start InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "type": { + "description": "Type of the input element. It should be a valid HTML5 input type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the input element, required for a controlled component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input-label/input-label.json b/docs/translations/api-docs/input-label/input-label.json index 6940ada98fb859..1fb7475c8dccc0 100644 --- a/docs/translations/api-docs/input-label/input-label.json +++ b/docs/translations/api-docs/input-label/input-label.json @@ -1,19 +1,84 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "disableAnimation": "If true, the transition animation is disabled.", - "disabled": "If true, the component is disabled.", - "error": "If true, the label is displayed in an error state.", - "focused": "If true, the input of this label is focused.", - "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", - "required": "if true, the label will indicate that the input is required.", - "shrink": "If true, the label is shrunk.", - "size": "The size of the component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAnimation": { + "description": "If true, the transition animation is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the label is displayed in an error state.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focused": { + "description": "If true, the input of this label is focused.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "if true, the label will indicate that the input is required.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "shrink": { + "description": "If true, the label is shrunk.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "size": { + "description": "The size of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input/input.json b/docs/translations/api-docs/input/input.json index 9d66d2118fd08a..6a5b181229e4a3 100644 --- a/docs/translations/api-docs/input/input.json +++ b/docs/translations/api-docs/input/input.json @@ -1,38 +1,200 @@ { "componentDescription": "", "propDescriptions": { - "autoComplete": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "autoFocus": "If true, the input element is focused during the first mount.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "defaultValue": "The default value. Use when the component is not controlled.", - "disabled": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "disableUnderline": "If true, the input will not have an underline.", - "endAdornment": "End InputAdornment for this component.", - "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "fullWidth": "If true, the input will take up the full width of its container.", - "id": "The id of the input element.", - "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.", - "inputProps": "Attributes applied to the input element.", - "inputRef": "Pass a ref to the input element.", - "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "maxRows": "Maximum number of rows to display when multiline option is set to true.", - "minRows": "Minimum number of rows to display when multiline option is set to true.", - "multiline": "If true, a TextareaAutosize element is rendered.", - "name": "Name attribute of the input element.", - "onChange": "Callback fired when the value is changed.

    Signature:
    function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
    • event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
    ", - "placeholder": "The short hint displayed in the input before the user enters a value.", - "readOnly": "It prevents the user from changing the value of the field (not from interacting with the field).", - "required": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "rows": "Number of rows to display when multiline option is set to true.", - "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "startAdornment": "Start InputAdornment for this component.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "type": "Type of the input element. It should be a valid HTML5 input type.", - "value": "The value of the input element, required for a controlled component." + "autoComplete": { + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the input element is focused during the first mount.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultValue": { + "description": "The default value. Use when the component is not controlled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableUnderline": { + "description": "If true, the input will not have an underline.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "endAdornment": { + "description": "End InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "error": { + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "fullWidth": { + "description": "If true, the input will take up the full width of its container.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "id": { + "description": "The id of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputComponent": { + "description": "The component used for the input element. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputProps": { + "description": "Attributes applied to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inputRef": { + "description": "Pass a ref to the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "margin": { + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "maxRows": { + "description": "Maximum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "minRows": { + "description": "Minimum number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "multiline": { + "description": "If true, a TextareaAutosize element is rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "name": { + "description": "Name attribute of the input element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onChange": { + "description": "Callback fired when the value is changed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." + } + }, + "placeholder": { + "description": "The short hint displayed in the input before the user enters a value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "readOnly": { + "description": "It prevents the user from changing the value of the field (not from interacting with the field).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "required": { + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "rows": { + "description": "Number of rows to display when multiline option is set to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "startAdornment": { + "description": "Start InputAdornment for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "type": { + "description": "Type of the input element. It should be a valid HTML5 input type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the input element, required for a controlled component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/linear-progress/linear-progress.json b/docs/translations/api-docs/linear-progress/linear-progress.json index 002004676364fb..7844a74cd6bda1 100644 --- a/docs/translations/api-docs/linear-progress/linear-progress.json +++ b/docs/translations/api-docs/linear-progress/linear-progress.json @@ -1,12 +1,42 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "value": "The value of the progress indicator for the determinate and buffer variants. Value between 0 and 100.", - "valueBuffer": "The value for the buffer variant. Value between 0 and 100.", - "variant": "The variant to use. Use indeterminate or query when there is no progress value." + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "value": { + "description": "The value of the progress indicator for the determinate and buffer variants. Value between 0 and 100.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "valueBuffer": { + "description": "The value for the buffer variant. Value between 0 and 100.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use. Use indeterminate or query when there is no progress value.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/link/link.json b/docs/translations/api-docs/link/link.json index cad1c837105e1b..2fa24c46d79eec 100644 --- a/docs/translations/api-docs/link/link.json +++ b/docs/translations/api-docs/link/link.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the link.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "TypographyClasses": "classes prop applied to the Typography element.", - "underline": "Controls when the link should have an underline.", - "variant": "Applies the theme typography styles." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the link.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TypographyClasses": { + "description": "classes prop applied to the Typography element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "underline": { + "description": "Controls when the link should have an underline.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "Applies the theme typography styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-avatar/list-item-avatar.json b/docs/translations/api-docs/list-item-avatar/list-item-avatar.json index 3990f79f5a3fdb..ab02c515bb3212 100644 --- a/docs/translations/api-docs/list-item-avatar/list-item-avatar.json +++ b/docs/translations/api-docs/list-item-avatar/list-item-avatar.json @@ -1,9 +1,24 @@ { "componentDescription": "A simple wrapper to apply `List` styles to an `Avatar`.", "propDescriptions": { - "children": "The content of the component, normally an Avatar.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component, normally an Avatar.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-button/list-item-button.json b/docs/translations/api-docs/list-item-button/list-item-button.json index 8341f6efc9a6c4..dfd9dbd848f477 100644 --- a/docs/translations/api-docs/list-item-button/list-item-button.json +++ b/docs/translations/api-docs/list-item-button/list-item-button.json @@ -1,18 +1,78 @@ { "componentDescription": "", "propDescriptions": { - "alignItems": "Defines the align-items style property.", - "autoFocus": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "children": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "dense": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", - "disabled": "If true, the component is disabled.", - "disableGutters": "If true, the left and right padding is removed.", - "divider": "If true, a 1px light border is added to the bottom of the list item.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "selected": "Use to apply selected styling.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "alignItems": { + "description": "Defines the align-items style property.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "dense": { + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, the left and right padding is removed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "divider": { + "description": "If true, a 1px light border is added to the bottom of the list item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selected": { + "description": "Use to apply selected styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-icon/list-item-icon.json b/docs/translations/api-docs/list-item-icon/list-item-icon.json index 17b5c1357db65e..1eba9f1c3734b4 100644 --- a/docs/translations/api-docs/list-item-icon/list-item-icon.json +++ b/docs/translations/api-docs/list-item-icon/list-item-icon.json @@ -1,9 +1,24 @@ { "componentDescription": "A simple wrapper to apply `List` styles to an `Icon` or `SvgIcon`.", "propDescriptions": { - "children": "The content of the component, normally Icon, SvgIcon, or a @mui/icons-material SVG icon element.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component, normally Icon, SvgIcon, or a @mui/icons-material SVG icon element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json b/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json index 97c82f9cd6b28d..38ebae13e915f1 100644 --- a/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json +++ b/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json @@ -1,9 +1,24 @@ { "componentDescription": "Must be used as the last child of ListItem to function properly.", "propDescriptions": { - "children": "The content of the component, normally an IconButton or selection control.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component, normally an IconButton or selection control.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-text/list-item-text.json b/docs/translations/api-docs/list-item-text/list-item-text.json index 7ead1b3455670f..7ed2ed2c3fe40c 100644 --- a/docs/translations/api-docs/list-item-text/list-item-text.json +++ b/docs/translations/api-docs/list-item-text/list-item-text.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "children": "Alias for the primary prop.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableTypography": "If true, the children won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the children (or primary) text, and optional secondary text with the Typography component.", - "inset": "If true, the children are indented. This should be used if there is no left avatar or left icon.", - "primary": "The main content element.", - "primaryTypographyProps": "These props will be forwarded to the primary typography component (as long as disableTypography is not true).", - "secondary": "The secondary content element.", - "secondaryTypographyProps": "These props will be forwarded to the secondary typography component (as long as disableTypography is not true).", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "Alias for the primary prop.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableTypography": { + "description": "If true, the children won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the children (or primary) text, and optional secondary text with the Typography component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inset": { + "description": "If true, the children are indented. This should be used if there is no left avatar or left icon.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "primary": { + "description": "The main content element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "primaryTypographyProps": { + "description": "These props will be forwarded to the primary typography component (as long as disableTypography is not true).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "secondary": { + "description": "The secondary content element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "secondaryTypographyProps": { + "description": "These props will be forwarded to the secondary typography component (as long as disableTypography is not true).", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item/list-item.json b/docs/translations/api-docs/list-item/list-item.json index 00611759e2cd21..5c7088d474b607 100644 --- a/docs/translations/api-docs/list-item/list-item.json +++ b/docs/translations/api-docs/list-item/list-item.json @@ -1,26 +1,126 @@ { "componentDescription": "Uses an additional container component if `ListItemSecondaryAction` is the last child.", "propDescriptions": { - "alignItems": "Defines the align-items style property.", - "autoFocus": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "button": "If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.", - "children": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "ContainerComponent": "The container component used when a ListItemSecondaryAction is the last child.
    ⚠️ Needs to be able to hold a ref.", - "ContainerProps": "Props applied to the container component if used.", - "dense": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", - "disabled": "If true, the component is disabled.", - "disableGutters": "If true, the left and right padding is removed.", - "disablePadding": "If true, all padding is removed.", - "divider": "If true, 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 extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "slots": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "alignItems": { + "description": "Defines the align-items style property.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "button": { + "description": "If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "ContainerComponent": { + "description": "The container component used when a ListItemSecondaryAction is the last child.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "ContainerProps": { + "description": "Props applied to the container component if used.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "dense": { + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, the left and right padding is removed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePadding": { + "description": "If true, all padding is removed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "divider": { + "description": "If true, a 1px light border is added to the bottom of the list item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "secondaryAction": { + "description": "The element to display at the end of ListItem.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selected": { + "description": "Use to apply selected styling.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { diff --git a/docs/translations/api-docs/list-subheader/list-subheader.json b/docs/translations/api-docs/list-subheader/list-subheader.json index 33932ec54d3552..32264c077da205 100644 --- a/docs/translations/api-docs/list-subheader/list-subheader.json +++ b/docs/translations/api-docs/list-subheader/list-subheader.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "color": "The color of the component. It supports those theme colors that make sense for this component.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "disableGutters": "If true, the List Subheader will not have gutters.", - "disableSticky": "If true, the List Subheader will not stick to the top during scroll.", - "inset": "If true, the List Subheader is indented.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "color": { + "description": "The color of the component. It supports those theme colors that make sense for this component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, the List Subheader will not have gutters.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableSticky": { + "description": "If true, the List Subheader will not stick to the top during scroll.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "inset": { + "description": "If true, the List Subheader is indented.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list/list.json b/docs/translations/api-docs/list/list.json index f90e8bf1693b4a..ff8324838da987 100644 --- a/docs/translations/api-docs/list/list.json +++ b/docs/translations/api-docs/list/list.json @@ -1,13 +1,48 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "dense": "If true, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context.", - "disablePadding": "If true, vertical padding is removed from the list.", - "subheader": "The content of the subheader, normally ListSubheader.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "dense": { + "description": "If true, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePadding": { + "description": "If true, vertical padding is removed from the list.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "subheader": { + "description": "The content of the subheader, normally ListSubheader.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/loading-button/loading-button.json b/docs/translations/api-docs/loading-button/loading-button.json index bfc4e6343701a3..3a2bb9698d059b 100644 --- a/docs/translations/api-docs/loading-button/loading-button.json +++ b/docs/translations/api-docs/loading-button/loading-button.json @@ -1,14 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disabled": "If true, the component is disabled.", - "loading": "If true, the loading indicator is shown.", - "loadingIndicator": "Element placed before the children if the button is in loading state. The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", - "loadingPosition": "The loading indicator can be positioned on the start, end, or the center of the button.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabled": { + "description": "If true, the component is disabled.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loading": { + "description": "If true, the loading indicator is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingIndicator": { + "description": "Element placed before the children if the button is in loading state. The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "loadingPosition": { + "description": "The loading indicator can be positioned on the start, end, or the center of the button.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/masonry/masonry.json b/docs/translations/api-docs/masonry/masonry.json index 6fd5d474642be3..80bfcfbfc09eff 100644 --- a/docs/translations/api-docs/masonry/masonry.json +++ b/docs/translations/api-docs/masonry/masonry.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "columns": "Number of columns.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "defaultColumns": "The default number of columns of the component. This is provided for server-side rendering.", - "defaultHeight": "The default height of the component in px. This is provided for server-side rendering.", - "defaultSpacing": "The default spacing of the component. Like spacing, it is a factor of the theme's spacing. This is provided for server-side rendering.", - "spacing": "Defines the space between children. It is a factor of the theme's spacing.", - "sx": "Allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "columns": { + "description": "Number of columns.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultColumns": { + "description": "The default number of columns of the component. This is provided for server-side rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultHeight": { + "description": "The default height of the component in px. This is provided for server-side rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "defaultSpacing": { + "description": "The default spacing of the component. Like spacing, it is a factor of the theme's spacing. This is provided for server-side rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "spacing": { + "description": "Defines the space between children. It is a factor of the theme's spacing.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "Allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/menu-item/menu-item.json b/docs/translations/api-docs/menu-item/menu-item.json index 007092738de45b..e760cd6c2a59dd 100644 --- a/docs/translations/api-docs/menu-item/menu-item.json +++ b/docs/translations/api-docs/menu-item/menu-item.json @@ -1,16 +1,66 @@ { "componentDescription": "", "propDescriptions": { - "autoFocus": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "children": "The content of the component.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "dense": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent Menu component.", - "disableGutters": "If true, the left and right padding is removed.", - "divider": "If true, a 1px light border is added to the bottom of the menu item.", - "focusVisibleClassName": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "selected": "If true, the component is selected.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." + "autoFocus": { + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "The content of the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "dense": { + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent Menu component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableGutters": { + "description": "If true, the left and right padding is removed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "divider": { + "description": "If true, a 1px light border is added to the bottom of the menu item.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "focusVisibleClassName": { + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "selected": { + "description": "If true, the component is selected.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/menu-list/menu-list.json b/docs/translations/api-docs/menu-list/menu-list.json index 95d35092ebacc3..f79f543aa85228 100644 --- a/docs/translations/api-docs/menu-list/menu-list.json +++ b/docs/translations/api-docs/menu-list/menu-list.json @@ -1,12 +1,42 @@ { "componentDescription": "A permanently displayed menu following https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/.\nIt's exposed to help customization of the [`Menu`](/material-ui/api/menu/) component if you\nuse it separately you need to move focus into the component manually. Once\nthe focus is placed inside the component it is fully keyboard accessible.", "propDescriptions": { - "autoFocus": "If true, will focus the [role="menu"] container and move into tab order.", - "autoFocusItem": "If true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu".", - "children": "MenuList contents, normally MenuItems.", - "disabledItemsFocusable": "If true, will allow focus on disabled items.", - "disableListWrap": "If true, the menu items will not wrap focus.", - "variant": "The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element." + "autoFocus": { + "description": "If true, will focus the [role="menu"] container and move into tab order.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocusItem": { + "description": "If true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu".", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "MenuList contents, normally MenuItems.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disabledItemsFocusable": { + "description": "If true, will allow focus on disabled items.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableListWrap": { + "description": "If true, the menu items will not wrap focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/menu/menu.json b/docs/translations/api-docs/menu/menu.json index 1eeaf54d5cba06..b72fe26b42407e 100644 --- a/docs/translations/api-docs/menu/menu.json +++ b/docs/translations/api-docs/menu/menu.json @@ -1,19 +1,87 @@ { "componentDescription": "", "propDescriptions": { - "anchorEl": "An HTML element, or a function that returns one. It's used to set the position of the menu.", - "autoFocus": "If true (Default) will focus the [role="menu"] if no focusable child is found. Disabled children are not focusable. If you set this prop to false focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise.", - "children": "Menu contents, normally MenuItems.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "disableAutoFocusItem": "When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications.", - "MenuListProps": "Props applied to the MenuList element.", - "onClose": "Callback fired when the component requests to be closed.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick", "tabKeyDown".
    ", - "open": "If true, the component is shown.", - "PopoverClasses": "classes prop applied to the Popover element.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "transitionDuration": "The length of the transition in ms, or 'auto'", - "TransitionProps": "Props applied to the transition element. By default, the element is based on this Transition component.", - "variant": "The variant to use. Use menu to prevent selected items from impacting the initial focus." + "anchorEl": { + "description": "An HTML element, or a function that returns one. It's used to set the position of the menu.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "autoFocus": { + "description": "If true (Default) will focus the [role="menu"] if no focusable child is found. Disabled children are not focusable. If you set this prop to false focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "Menu contents, normally MenuItems.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAutoFocusItem": { + "description": "When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "MenuListProps": { + "description": "Props applied to the MenuList element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "escapeKeyDown", "backdropClick", "tabKeyDown"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "PopoverClasses": { + "description": "classes prop applied to the Popover element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "transitionDuration": { + "description": "The length of the transition in ms, or 'auto'", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "TransitionProps": { + "description": "Props applied to the transition element. By default, the element is based on this Transition component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/mobile-stepper/mobile-stepper.json b/docs/translations/api-docs/mobile-stepper/mobile-stepper.json index b3f48db222c951..e043d6cb0200ad 100644 --- a/docs/translations/api-docs/mobile-stepper/mobile-stepper.json +++ b/docs/translations/api-docs/mobile-stepper/mobile-stepper.json @@ -1,15 +1,60 @@ { "componentDescription": "", "propDescriptions": { - "activeStep": "Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.", - "backButton": "A back button element. For instance, it can be a Button or an IconButton.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "LinearProgressProps": "Props applied to the LinearProgress element.", - "nextButton": "A next button element. For instance, it can be a Button or an IconButton.", - "position": "Set the positioning type.", - "steps": "The total steps.", - "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", - "variant": "The variant to use." + "activeStep": { + "description": "Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "backButton": { + "description": "A back button element. For instance, it can be a Button or an IconButton.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "LinearProgressProps": { + "description": "Props applied to the LinearProgress element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "nextButton": { + "description": "A next button element. For instance, it can be a Button or an IconButton.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "position": { + "description": "Set the positioning type.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "steps": { + "description": "The total steps.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "variant": { + "description": "The variant to use.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index 3d961574b68eb6..9fbc263c1d4a75 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -1,29 +1,147 @@ { "componentDescription": "Modal is a lower-level construct that is leveraged by the following components:\n\n- [Dialog](/material-ui/api/dialog/)\n- [Drawer](/material-ui/api/drawer/)\n- [Menu](/material-ui/api/menu/)\n- [Popover](/material-ui/api/popover/)\n\nIf you are creating a modal dialog, you probably want to use the [Dialog](/material-ui/api/dialog/) component\nrather than directly using Modal.\n\nThis component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).", "propDescriptions": { - "BackdropComponent": "A backdrop component. This prop enables custom backdrop rendering.", - "BackdropProps": "Props applied to the Backdrop element.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", - "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "closeAfterTransition": "When set to true the Modal waits until a nested Transition is completed before closing.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "components": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "componentsProps": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "container": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "disableAutoFocus": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEnforceFocus": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "disableEscapeKeyDown": "If true, hitting escape will not fire the onClose callback.", - "disablePortal": "The children will be under the DOM hierarchy of the parent component.", - "disableRestoreFocus": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "disableScrollLock": "Disable the scroll lock behavior.", - "hideBackdrop": "If true, the backdrop is not rendered.", - "keepMounted": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "onBackdropClick": "Callback fired when the backdrop is clicked.", - "onClose": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

    Signature:
    function(event: object, reason: string) => void
    • event: The event source of the callback.
    • reason: Can be: "escapeKeyDown", "backdropClick".
    ", - "open": "If true, the component is shown.", - "slotProps": "The props used for each slot inside the Modal.", - "slots": "The components used for each slot inside the Modal. 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 `sx` page for more details." + "BackdropComponent": { + "description": "A backdrop component. This prop enables custom backdrop rendering.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "BackdropProps": { + "description": "Props applied to the Backdrop element.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "children": { + "description": "A single child content element.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", + "deprecated": "", + "typeDescriptions": {} + }, + "classes": { + "description": "Override or extend the styles applied to the component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "closeAfterTransition": { + "description": "When set to true the Modal waits until a nested Transition is completed before closing.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "component": { + "description": "The component used for the root node. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "components": { + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "componentsProps": { + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "container": { + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableAutoFocus": { + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEnforceFocus": { + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableEscapeKeyDown": { + "description": "If true, hitting escape will not fire the onClose callback.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disablePortal": { + "description": "The children will be under the DOM hierarchy of the parent component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableRestoreFocus": { + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "disableScrollLock": { + "description": "Disable the scroll lock behavior.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "hideBackdrop": { + "description": "If true, the backdrop is not rendered.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "keepMounted": { + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onBackdropClick": { + "description": "Callback fired when the backdrop is clicked.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "onClose": { + "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", + "notes": "", + "deprecated": "", + "typeDescriptions": { + "event": "The event source of the callback.", + "reason": "Can be: "escapeKeyDown", "backdropClick"." + } + }, + "open": { + "description": "If true, the component is shown.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slotProps": { + "description": "The props used for each slot inside the Modal.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "slots": { + "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + }, + "sx": { + "description": "The system prop that allows defining system overrides as well as additional CSS styles.", + "notes": "", + "deprecated": "", + "typeDescriptions": {} + } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs/native-select/native-select.json b/docs/translations/api-docs/native-select/native-select.json index 839cccb07ca32c..607ab46a3ce3a7 100644 --- a/docs/translations/api-docs/native-select/native-select.json +++ b/docs/translations/api-docs/native-select/native-select.json @@ -1,15 +1,62 @@ { "componentDescription": "An alternative to `", "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDropDownIcon" }, + "input": { "type": { "name": "element" }, "default": "" }, + "inputProps": { "type": { "name": "object" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, "sx": { "type": { @@ -28,13 +23,12 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" - }, - "additionalPropsInfo": {} + } } }, "name": "NativeSelect", diff --git a/docs/pages/material-ui/api/outlined-input.json b/docs/pages/material-ui/api/outlined-input.json index f7ae62fbc6d133..17cfe54d54195b 100644 --- a/docs/pages/material-ui/api/outlined-input.json +++ b/docs/pages/material-ui/api/outlined-input.json @@ -1,70 +1,50 @@ { "props": { - "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "autoFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "autoComplete": { "type": { "name": "string" } }, + "autoFocus": { "type": { "name": "bool" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" - }, - "additionalPropsInfo": {} + } }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Root?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} - }, - "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "endAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "error": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "inputComponent": { - "type": { "name": "elementType" }, - "default": "'input'", - "additionalPropsInfo": {} - }, - "inputProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, - "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, - "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "margin": { - "type": { "name": "enum", "description": "'dense'
    | 'none'" }, - "additionalPropsInfo": {} - }, - "maxRows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} + "default": "{}" }, - "minRows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - }, - "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "notched": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" } }, + "disabled": { "type": { "name": "bool" } }, + "endAdornment": { "type": { "name": "node" } }, + "error": { "type": { "name": "bool" } }, + "fullWidth": { "type": { "name": "bool" }, "default": "false" }, + "id": { "type": { "name": "string" } }, + "inputComponent": { "type": { "name": "elementType" }, "default": "'input'" }, + "inputProps": { "type": { "name": "object" }, "default": "{}" }, + "inputRef": { "type": { "name": "custom", "description": "ref" } }, + "label": { "type": { "name": "node" } }, + "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'" } }, + "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, + "minRows": { "type": { "name": "union", "description": "number
    | string" } }, + "multiline": { "type": { "name": "bool" }, "default": "false" }, + "name": { "type": { "name": "string" } }, + "notched": { "type": { "name": "bool" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} - }, - "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "readOnly": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "required": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "rows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} + } }, + "placeholder": { "type": { "name": "string" } }, + "readOnly": { "type": { "name": "bool" } }, + "required": { "type": { "name": "bool" } }, + "rows": { "type": { "name": "union", "description": "number
    | string" } }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, root?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "startAdornment": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "startAdornment": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", @@ -72,8 +52,8 @@ }, "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "default": "'text'", "additionalPropsInfo": {} }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } + "type": { "type": { "name": "string" }, "default": "'text'" }, + "value": { "type": { "name": "any" } } }, "name": "OutlinedInput", "styles": { diff --git a/docs/pages/material-ui/api/pagination-item.json b/docs/pages/material-ui/api/pagination-item.json index a0acf72b62d522..5e3766cb318b2b 100644 --- a/docs/pages/material-ui/api/pagination-item.json +++ b/docs/pages/material-ui/api/pagination-item.json @@ -6,41 +6,36 @@ "name": "union", "description": "'primary'
    | 'secondary'
    | 'standard'
    | string" }, - "default": "'standard'", - "additionalPropsInfo": {} + "default": "'standard'" }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "components": { "type": { "name": "shape", "description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "page": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "page": { "type": { "name": "node" } }, + "selected": { "type": { "name": "bool" }, "default": "false" }, "shape": { "type": { "name": "enum", "description": "'circular'
    | 'rounded'" }, - "default": "'circular'", - "additionalPropsInfo": {} + "default": "'circular'" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "slots": { "type": { "name": "shape", "description": "{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { @@ -54,16 +49,14 @@ "name": "enum", "description": "'end-ellipsis'
    | 'first'
    | 'last'
    | 'next'
    | 'page'
    | 'previous'
    | 'start-ellipsis'" }, - "default": "'page'", - "additionalPropsInfo": {} + "default": "'page'" }, "variant": { "type": { "name": "union", "description": "'outlined'
    | 'text'
    | string" }, - "default": "'text'", - "additionalPropsInfo": {} + "default": "'text'" } }, "name": "PaginationItem", diff --git a/docs/pages/material-ui/api/pagination.json b/docs/pages/material-ui/api/pagination.json index af0f18733f3c8f..490a4b72caffcf 100644 --- a/docs/pages/material-ui/api/pagination.json +++ b/docs/pages/material-ui/api/pagination.json @@ -1,81 +1,55 @@ { "props": { - "boundaryCount": { - "type": { "name": "custom", "description": "integer" }, - "default": "1", - "additionalPropsInfo": {} - }, + "boundaryCount": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'standard'
    | string" }, - "default": "'standard'", - "additionalPropsInfo": {} - }, - "count": { - "type": { "name": "custom", "description": "integer" }, - "default": "1", - "additionalPropsInfo": {} + "default": "'standard'" }, - "defaultPage": { - "type": { "name": "custom", "description": "integer" }, - "default": "1", - "additionalPropsInfo": {} - }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "count": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, + "defaultPage": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, "getItemAriaLabel": { "type": { "name": "func" }, "signature": { "type": "function(type: string, page: number, selected: bool) => string", "describedArgs": ["type", "page", "selected"] - }, - "additionalPropsInfo": {} + } }, - "hideNextButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "hidePrevButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "hideNextButton": { "type": { "name": "bool" }, "default": "false" }, + "hidePrevButton": { "type": { "name": "bool" }, "default": "false" }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent, page: number) => void", "describedArgs": ["event", "page"] - }, - "additionalPropsInfo": {} + } }, - "page": { "type": { "name": "custom", "description": "integer" }, "additionalPropsInfo": {} }, + "page": { "type": { "name": "custom", "description": "integer" } }, "renderItem": { "type": { "name": "func" }, "default": "(item) => ", "signature": { "type": "function(params: PaginationRenderItemParams) => ReactNode", "describedArgs": ["params"] - }, - "additionalPropsInfo": {} + } }, "shape": { "type": { "name": "enum", "description": "'circular'
    | 'rounded'" }, - "default": "'circular'", - "additionalPropsInfo": {} - }, - "showFirstButton": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "showLastButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "siblingCount": { - "type": { "name": "custom", "description": "integer" }, - "default": "1", - "additionalPropsInfo": {} + "default": "'circular'" }, + "showFirstButton": { "type": { "name": "bool" }, "default": "false" }, + "showLastButton": { "type": { "name": "bool" }, "default": "false" }, + "siblingCount": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { @@ -89,8 +63,7 @@ "name": "union", "description": "'outlined'
    | 'text'
    | string" }, - "default": "'text'", - "additionalPropsInfo": {} + "default": "'text'" } }, "name": "Pagination", diff --git a/docs/pages/material-ui/api/paper.json b/docs/pages/material-ui/api/paper.json index 15bef43296a52f..5fce5bbd2ac68d 100644 --- a/docs/pages/material-ui/api/paper.json +++ b/docs/pages/material-ui/api/paper.json @@ -1,14 +1,10 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "elevation": { - "type": { "name": "custom", "description": "integer" }, - "default": "1", - "additionalPropsInfo": {} - }, - "square": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "elevation": { "type": { "name": "custom", "description": "integer" }, "default": "1" }, + "square": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", @@ -21,8 +17,7 @@ "name": "union", "description": "'elevation'
    | 'outlined'
    | string" }, - "default": "'elevation'", - "additionalPropsInfo": {} + "default": "'elevation'" } }, "name": "Paper", diff --git a/docs/pages/material-ui/api/popover.json b/docs/pages/material-ui/api/popover.json index 1dcd80f72ddcf7..d2d78fc2bf0dd6 100644 --- a/docs/pages/material-ui/api/popover.json +++ b/docs/pages/material-ui/api/popover.json @@ -1,63 +1,47 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, - "action": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, - "anchorEl": { - "type": { "name": "custom", "description": "HTML element
    | func" }, - "additionalPropsInfo": {} - }, + "open": { "type": { "name": "bool" }, "required": true }, + "action": { "type": { "name": "custom", "description": "ref" } }, + "anchorEl": { "type": { "name": "custom", "description": "HTML element
    | func" } }, "anchorOrigin": { "type": { "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right'
    | number, vertical: 'bottom'
    | 'center'
    | 'top'
    | number }" }, - "default": "{\n vertical: 'top',\n horizontal: 'left',\n}", - "additionalPropsInfo": {} + "default": "{\n vertical: 'top',\n horizontal: 'left',\n}" }, "anchorPosition": { - "type": { "name": "shape", "description": "{ left: number, top: number }" }, - "additionalPropsInfo": {} + "type": { "name": "shape", "description": "{ left: number, top: number }" } }, "anchorReference": { "type": { "name": "enum", "description": "'anchorEl'
    | 'anchorPosition'
    | 'none'" }, - "default": "'anchorEl'", - "additionalPropsInfo": {} + "default": "'anchorEl'" }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "container": { - "type": { "name": "union", "description": "HTML element
    | func" }, - "additionalPropsInfo": {} - }, - "elevation": { - "type": { "name": "custom", "description": "integer" }, - "default": "8", - "additionalPropsInfo": {} - }, - "marginThreshold": { "type": { "name": "number" }, "default": "16", "additionalPropsInfo": {} }, - "onClose": { "type": { "name": "func" }, "additionalPropsInfo": {} }, + "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, + "elevation": { "type": { "name": "custom", "description": "integer" }, "default": "8" }, + "marginThreshold": { "type": { "name": "number" }, "default": "16" }, + "onClose": { "type": { "name": "func" } }, "PaperProps": { "type": { "name": "shape", "description": "{ component?: element type }" }, "default": "{}", "deprecated": true, - "deprecationInfo": "Use slotProps.paper instead.", - "additionalPropsInfo": {} + "deprecationInfo": "Use slotProps.paper instead." }, "slotProps": { "type": { "name": "shape", "description": "{ paper?: func
    | object, root?: func
    | object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ paper?: elementType, root?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { @@ -71,23 +55,17 @@ "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right'
    | number, vertical: 'bottom'
    | 'center'
    | 'top'
    | number }" }, - "default": "{\n vertical: 'top',\n horizontal: 'left',\n}", - "additionalPropsInfo": {} - }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Grow", - "additionalPropsInfo": {} + "default": "{\n vertical: 'top',\n horizontal: 'left',\n}" }, + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, "transitionDuration": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'", - "additionalPropsInfo": {} + "default": "'auto'" }, - "TransitionProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} } + "TransitionProps": { "type": { "name": "object" }, "default": "{}" } }, "name": "Popover", "styles": { "classes": ["root", "paper"], "globalClasses": {}, "name": "MuiPopover" }, diff --git a/docs/pages/material-ui/api/popper.json b/docs/pages/material-ui/api/popper.json index efe5f7a0833d22..4f4e8effcebf41 100644 --- a/docs/pages/material-ui/api/popper.json +++ b/docs/pages/material-ui/api/popper.json @@ -1,67 +1,53 @@ { "props": { - "open": { "type": { "name": "bool" }, "required": true, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" }, "required": true }, "anchorEl": { "type": { "name": "union", "description": "HTML element
    | object
    | func" - }, - "additionalPropsInfo": {} - }, - "children": { - "type": { "name": "union", "description": "node
    | func" }, - "additionalPropsInfo": {} + } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "union", "description": "node
    | func" } }, + "component": { "type": { "name": "elementType" } }, "components": { "type": { "name": "shape", "description": "{ Root?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "componentsProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "container": { - "type": { "name": "union", "description": "HTML element
    | func" }, - "additionalPropsInfo": {} - }, - "disablePortal": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "keepMounted": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "container": { "type": { "name": "union", "description": "HTML element
    | func" } }, + "disablePortal": { "type": { "name": "bool" }, "default": "false" }, + "keepMounted": { "type": { "name": "bool" }, "default": "false" }, "modifiers": { "type": { "name": "arrayOf", "description": "Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain'
    | 'afterRead'
    | 'afterWrite'
    | 'beforeMain'
    | 'beforeRead'
    | 'beforeWrite'
    | 'main'
    | 'read'
    | 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>" - }, - "additionalPropsInfo": {} + } }, "placement": { "type": { "name": "enum", "description": "'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'", - "additionalPropsInfo": {} + "default": "'bottom'" }, "popperOptions": { "type": { "name": "shape", "description": "{ modifiers?: array, onFirstUpdate?: func, placement?: 'auto-end'
    | 'auto-start'
    | 'auto'
    | 'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top', strategy?: 'absolute'
    | 'fixed' }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "popperRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "popperRef": { "type": { "name": "custom", "description": "ref" } }, "slotProps": { "type": { "name": "shape", "description": "{ root?: func
    | object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ root?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { @@ -70,7 +56,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "transition": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } + "transition": { "type": { "name": "bool" }, "default": "false" } }, "name": "Popper", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/radio-group.json b/docs/pages/material-ui/api/radio-group.json index de5945ac34f4bd..4e90c94b26b163 100644 --- a/docs/pages/material-ui/api/radio-group.json +++ b/docs/pages/material-ui/api/radio-group.json @@ -1,17 +1,16 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, + "defaultValue": { "type": { "name": "any" } }, + "name": { "type": { "name": "string" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent, value: string) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "any" } } }, "name": "RadioGroup", "styles": { diff --git a/docs/pages/material-ui/api/radio.json b/docs/pages/material-ui/api/radio.json index 41df0bd7cb037b..5cad3f69a6d244 100644 --- a/docs/pages/material-ui/api/radio.json +++ b/docs/pages/material-ui/api/radio.json @@ -1,47 +1,36 @@ { "props": { - "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "checkedIcon": { - "type": { "name": "node" }, - "default": "", - "additionalPropsInfo": {} - }, + "checked": { "type": { "name": "bool" } }, + "checkedIcon": { "type": { "name": "node" }, "default": "" }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'", - "additionalPropsInfo": {} - }, - "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "icon": { - "type": { "name": "node" }, - "default": "", - "additionalPropsInfo": {} + "default": "'primary'" }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" } }, + "disableRipple": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" }, "default": "" }, + "id": { "type": { "name": "string" } }, + "inputProps": { "type": { "name": "object" } }, + "inputRef": { "type": { "name": "custom", "description": "ref" } }, + "name": { "type": { "name": "string" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, - "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "default": "false" }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { @@ -50,7 +39,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "any" } } }, "name": "Radio", "styles": { diff --git a/docs/pages/material-ui/api/rating.json b/docs/pages/material-ui/api/rating.json index 0509a26dba5f01..8689731c7d44c8 100644 --- a/docs/pages/material-ui/api/rating.json +++ b/docs/pages/material-ui/api/rating.json @@ -1,70 +1,45 @@ { "props": { "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "defaultValue": { "type": { "name": "number" }, "default": "null", "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "emptyIcon": { - "type": { "name": "node" }, - "default": "", - "additionalPropsInfo": {} - }, - "emptyLabelText": { - "type": { "name": "node" }, - "default": "'Empty'", - "additionalPropsInfo": {} - }, + "defaultValue": { "type": { "name": "number" }, "default": "null" }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "emptyIcon": { "type": { "name": "node" }, "default": "" }, + "emptyLabelText": { "type": { "name": "node" }, "default": "'Empty'" }, "getLabelText": { "type": { "name": "func" }, "default": "function defaultLabelText(value) {\n return `${value} Star${value !== 1 ? 's' : ''}`;\n}", - "signature": { "type": "function(value: number) => string", "describedArgs": ["value"] }, - "additionalPropsInfo": {} - }, - "highlightSelectedOnly": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "icon": { - "type": { "name": "node" }, - "default": "", - "additionalPropsInfo": {} + "signature": { "type": "function(value: number) => string", "describedArgs": ["value"] } }, + "highlightSelectedOnly": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" }, "default": "" }, "IconContainerComponent": { "type": { "name": "elementType" }, - "default": "function IconContainer(props) {\n const { value, ...other } = props;\n return ;\n}", - "additionalPropsInfo": {} + "default": "function IconContainer(props) {\n const { value, ...other } = props;\n return ;\n}" }, - "max": { "type": { "name": "number" }, "default": "5", "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "max": { "type": { "name": "number" }, "default": "5" }, + "name": { "type": { "name": "string" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, value: number | null) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "onChangeActive": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, value: number) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} - }, - "precision": { - "type": { "name": "custom", "description": "number" }, - "default": "1", - "additionalPropsInfo": {} + } }, - "readOnly": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "precision": { "type": { "name": "custom", "description": "number" }, "default": "1" }, + "readOnly": { "type": { "name": "bool" }, "default": "false" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { @@ -73,7 +48,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "number" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "number" } } }, "name": "Rating", "styles": { diff --git a/docs/pages/material-ui/api/scoped-css-baseline.json b/docs/pages/material-ui/api/scoped-css-baseline.json index b5b2bffab0b49a..4640fb53a75ad0 100644 --- a/docs/pages/material-ui/api/scoped-css-baseline.json +++ b/docs/pages/material-ui/api/scoped-css-baseline.json @@ -1,9 +1,9 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "enableColorScheme": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "enableColorScheme": { "type": { "name": "bool" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/select.json b/docs/pages/material-ui/api/select.json index 9b30b9358afbba..31b6e8a7674ed4 100644 --- a/docs/pages/material-ui/api/select.json +++ b/docs/pages/material-ui/api/select.json @@ -1,53 +1,45 @@ { "props": { - "autoWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "autoWidth": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": { "cssApi": true } }, - "defaultOpen": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, - "displayEmpty": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "IconComponent": { - "type": { "name": "elementType" }, - "default": "ArrowDropDownIcon", - "additionalPropsInfo": {} - }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "input": { "type": { "name": "element" }, "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "labelId": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "MenuProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "multiple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "native": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "defaultOpen": { "type": { "name": "bool" }, "default": "false" }, + "defaultValue": { "type": { "name": "any" } }, + "displayEmpty": { "type": { "name": "bool" }, "default": "false" }, + "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDropDownIcon" }, + "id": { "type": { "name": "string" } }, + "input": { "type": { "name": "element" } }, + "inputProps": { "type": { "name": "object" } }, + "label": { "type": { "name": "node" } }, + "labelId": { "type": { "name": "string" } }, + "MenuProps": { "type": { "name": "object" } }, + "multiple": { "type": { "name": "bool" }, "default": "false" }, + "native": { "type": { "name": "bool" }, "default": "false" }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: SelectChangeEvent, child?: object) => void", "describedArgs": ["event", "child"] - }, - "additionalPropsInfo": {} + } }, "onClose": { "type": { "name": "func" }, - "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] } }, "onOpen": { "type": { "name": "func" }, - "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] } }, - "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" } }, "renderValue": { "type": { "name": "func" }, - "signature": { "type": "function(value: any) => ReactNode", "describedArgs": ["value"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(value: any) => ReactNode", "describedArgs": ["value"] } }, - "SelectDisplayProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "SelectDisplayProps": { "type": { "name": "object" } }, "sx": { "type": { "name": "union", @@ -55,17 +47,13 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { - "type": { "name": "union", "description": "''
    | any" }, - "additionalPropsInfo": {} - }, + "value": { "type": { "name": "union", "description": "''
    | any" } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" }, - "default": "'outlined'", - "additionalPropsInfo": {} + "default": "'outlined'" } }, "name": "Select", diff --git a/docs/pages/material-ui/api/skeleton.json b/docs/pages/material-ui/api/skeleton.json index 65c47fc03aee3d..bc69efbf206ac5 100644 --- a/docs/pages/material-ui/api/skeleton.json +++ b/docs/pages/material-ui/api/skeleton.json @@ -5,16 +5,12 @@ "name": "enum", "description": "'pulse'
    | 'wave'
    | false" }, - "default": "'pulse'", - "additionalPropsInfo": {} + "default": "'pulse'" }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "height": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - }, + "component": { "type": { "name": "elementType" } }, + "height": { "type": { "name": "union", "description": "number
    | string" } }, "sx": { "type": { "name": "union", @@ -27,13 +23,9 @@ "name": "union", "description": "'circular'
    | 'rectangular'
    | 'rounded'
    | 'text'
    | string" }, - "default": "'text'", - "additionalPropsInfo": {} + "default": "'text'" }, - "width": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - } + "width": { "type": { "name": "union", "description": "number
    | string" } } }, "name": "Skeleton", "styles": { diff --git a/docs/pages/material-ui/api/slide.json b/docs/pages/material-ui/api/slide.json index 9d2731bbc44334..0c3613f4888470 100644 --- a/docs/pages/material-ui/api/slide.json +++ b/docs/pages/material-ui/api/slide.json @@ -1,40 +1,32 @@ { "props": { - "children": { - "type": { "name": "custom", "description": "element" }, - "required": true, - "additionalPropsInfo": {} - }, - "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, - "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, + "children": { "type": { "name": "custom", "description": "element" }, "required": true }, + "addEndListener": { "type": { "name": "func" } }, + "appear": { "type": { "name": "bool" }, "default": "true" }, "container": { - "type": { "name": "custom", "description": "HTML element
    | func" }, - "additionalPropsInfo": {} + "type": { "name": "custom", "description": "HTML element
    | func" } }, "direction": { "type": { "name": "enum", "description": "'down'
    | 'left'
    | 'right'
    | 'up'" }, - "default": "'down'", - "additionalPropsInfo": {} + "default": "'down'" }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" }, - "default": "{\n enter: theme.transitions.easing.easeOut,\n exit: theme.transitions.easing.sharp,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.easing.easeOut,\n exit: theme.transitions.easing.sharp,\n}" }, - "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "in": { "type": { "name": "bool" } }, "timeout": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" } }, "name": "Slide", diff --git a/docs/pages/material-ui/api/slider.json b/docs/pages/material-ui/api/slider.json index a53235811ebdd1..cd7b43f11f3011 100644 --- a/docs/pages/material-ui/api/slider.json +++ b/docs/pages/material-ui/api/slider.json @@ -1,121 +1,101 @@ { "props": { - "aria-label": { - "type": { "name": "custom", "description": "string" }, - "additionalPropsInfo": {} - }, - "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "aria-valuetext": { - "type": { "name": "custom", "description": "string" }, - "additionalPropsInfo": {} - }, + "aria-label": { "type": { "name": "custom", "description": "string" } }, + "aria-labelledby": { "type": { "name": "string" } }, + "aria-valuetext": { "type": { "name": "custom", "description": "string" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" }, - "default": "'primary'", - "additionalPropsInfo": {} + "default": "'primary'" }, "components": { "type": { "name": "shape", "description": "{ Input?: elementType, Mark?: elementType, MarkLabel?: elementType, Rail?: elementType, Root?: elementType, Thumb?: elementType, Track?: elementType, ValueLabel?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "componentsProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: func
    | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto'
    | 'off'
    | 'on' } }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "defaultValue": { - "type": { "name": "union", "description": "Array<number>
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "Array<number>
    | number" } }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "disableSwap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "disableSwap": { "type": { "name": "bool" }, "default": "false" }, "getAriaLabel": { "type": { "name": "func" }, - "signature": { "type": "function(index: number) => string", "describedArgs": ["index"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(index: number) => string", "describedArgs": ["index"] } }, "getAriaValueText": { "type": { "name": "func" }, "signature": { "type": "function(value: number, index: number) => string", "describedArgs": ["value", "index"] - }, - "additionalPropsInfo": {} + } }, "marks": { "type": { "name": "union", "description": "Array<{ label?: node, value: number }>
    | bool" }, - "default": "false", - "additionalPropsInfo": {} + "default": "false" }, - "max": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, - "min": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "max": { "type": { "name": "number" }, "default": "100" }, + "min": { "type": { "name": "number" }, "default": "0" }, + "name": { "type": { "name": "string" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: Event, value: number | Array, activeThumb: number) => void", "describedArgs": ["event", "value", "activeThumb"] - }, - "additionalPropsInfo": {} + } }, "onChangeCommitted": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent | Event, value: number | Array) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'", - "additionalPropsInfo": {} + "default": "'horizontal'" }, "scale": { "type": { "name": "func" }, "default": "function Identity(x) {\n return x;\n}", - "signature": { "type": "function(x: any) => any", "describedArgs": [] }, - "additionalPropsInfo": {} + "signature": { "type": "function(x: any) => any", "describedArgs": [] } }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "slotProps": { "type": { "name": "shape", "description": "{ input?: func
    | object, mark?: func
    | object, markLabel?: func
    | object, rail?: func
    | object, root?: func
    | object, thumb?: func
    | object, track?: func
    | object, valueLabel?: func
    | { children?: element, className?: string, open?: bool, style?: object, value?: number, valueLabelDisplay?: 'auto'
    | 'off'
    | 'on' } }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "step": { "type": { "name": "number" }, "default": "1", "additionalPropsInfo": {} }, + "step": { "type": { "name": "number" }, "default": "1" }, "sx": { "type": { "name": "union", @@ -123,28 +103,24 @@ }, "additionalPropsInfo": { "sx": true } }, - "tabIndex": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "tabIndex": { "type": { "name": "number" } }, "track": { "type": { "name": "enum", "description": "'inverted'
    | 'normal'
    | false" }, - "default": "'normal'", - "additionalPropsInfo": {} + "default": "'normal'" }, "value": { - "type": { "name": "union", "description": "Array<number>
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "Array<number>
    | number" } }, "valueLabelDisplay": { "type": { "name": "enum", "description": "'auto'
    | 'off'
    | 'on'" }, - "default": "'off'", - "additionalPropsInfo": {} + "default": "'off'" }, "valueLabelFormat": { "type": { "name": "union", "description": "func
    | string" }, - "default": "function Identity(x) {\n return x;\n}", - "additionalPropsInfo": {} + "default": "function Identity(x) {\n return x;\n}" } }, "name": "Slider", diff --git a/docs/pages/material-ui/api/snackbar-content.json b/docs/pages/material-ui/api/snackbar-content.json index cb83d2884413a7..9c82968acc6554 100644 --- a/docs/pages/material-ui/api/snackbar-content.json +++ b/docs/pages/material-ui/api/snackbar-content.json @@ -1,9 +1,9 @@ { "props": { - "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "action": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "message": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "role": { "type": { "name": "string" }, "default": "'alert'", "additionalPropsInfo": {} }, + "message": { "type": { "name": "node" } }, + "role": { "type": { "name": "string" }, "default": "'alert'" }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/snackbar.json b/docs/pages/material-ui/api/snackbar.json index 0ca78954580912..0d0ecb4431e4ed 100644 --- a/docs/pages/material-ui/api/snackbar.json +++ b/docs/pages/material-ui/api/snackbar.json @@ -1,40 +1,30 @@ { "props": { - "action": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "action": { "type": { "name": "node" } }, "anchorOrigin": { "type": { "name": "shape", "description": "{ horizontal: 'center'
    | 'left'
    | 'right', vertical: 'bottom'
    | 'top' }" }, - "default": "{ vertical: 'bottom', horizontal: 'left' }", - "additionalPropsInfo": {} + "default": "{ vertical: 'bottom', horizontal: 'left' }" }, - "autoHideDuration": { - "type": { "name": "number" }, - "default": "null", - "additionalPropsInfo": {} - }, - "children": { "type": { "name": "element" }, "additionalPropsInfo": {} }, + "autoHideDuration": { "type": { "name": "number" }, "default": "null" }, + "children": { "type": { "name": "element" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "ClickAwayListenerProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "ContentProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "disableWindowBlurListener": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "key": { "type": { "name": "custom", "description": "any" }, "additionalPropsInfo": {} }, - "message": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "ClickAwayListenerProps": { "type": { "name": "object" } }, + "ContentProps": { "type": { "name": "object" } }, + "disableWindowBlurListener": { "type": { "name": "bool" }, "default": "false" }, + "key": { "type": { "name": "custom", "description": "any" } }, + "message": { "type": { "name": "node" } }, "onClose": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent | Event, reason: string) => void", "describedArgs": ["event", "reason"] - }, - "additionalPropsInfo": {} + } }, - "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "resumeHideDuration": { "type": { "name": "number" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" } }, + "resumeHideDuration": { "type": { "name": "number" } }, "sx": { "type": { "name": "union", @@ -42,20 +32,15 @@ }, "additionalPropsInfo": { "sx": true } }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Grow", - "additionalPropsInfo": {} - }, + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" }, - "TransitionProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} } + "TransitionProps": { "type": { "name": "object" }, "default": "{}" } }, "name": "Snackbar", "styles": { diff --git a/docs/pages/material-ui/api/speed-dial-action.json b/docs/pages/material-ui/api/speed-dial-action.json index 58c2f476086f1f..87f841d728cd6c 100644 --- a/docs/pages/material-ui/api/speed-dial-action.json +++ b/docs/pages/material-ui/api/speed-dial-action.json @@ -1,11 +1,11 @@ { "props": { "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "delay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, - "FabProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "delay": { "type": { "name": "number" }, "default": "0" }, + "FabProps": { "type": { "name": "object" }, "default": "{}" }, + "icon": { "type": { "name": "node" } }, + "id": { "type": { "name": "string" } }, + "open": { "type": { "name": "bool" } }, "sx": { "type": { "name": "union", @@ -13,17 +13,16 @@ }, "additionalPropsInfo": { "sx": true } }, - "TooltipClasses": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "tooltipOpen": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "TooltipClasses": { "type": { "name": "object" } }, + "tooltipOpen": { "type": { "name": "bool" }, "default": "false" }, "tooltipPlacement": { "type": { "name": "enum", "description": "'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'left'", - "additionalPropsInfo": {} + "default": "'left'" }, - "tooltipTitle": { "type": { "name": "node" }, "additionalPropsInfo": {} } + "tooltipTitle": { "type": { "name": "node" } } }, "name": "SpeedDialAction", "styles": { diff --git a/docs/pages/material-ui/api/speed-dial-icon.json b/docs/pages/material-ui/api/speed-dial-icon.json index 231cfe7844a7b5..343579a8a46e89 100644 --- a/docs/pages/material-ui/api/speed-dial-icon.json +++ b/docs/pages/material-ui/api/speed-dial-icon.json @@ -1,8 +1,8 @@ { "props": { "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "openIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" } }, + "openIcon": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/speed-dial.json b/docs/pages/material-ui/api/speed-dial.json index 79b203d30bf288..6af10b5e3a5a74 100644 --- a/docs/pages/material-ui/api/speed-dial.json +++ b/docs/pages/material-ui/api/speed-dial.json @@ -1,37 +1,34 @@ { "props": { - "ariaLabel": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "ariaLabel": { "type": { "name": "string" }, "required": true }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "direction": { "type": { "name": "enum", "description": "'down'
    | 'left'
    | 'right'
    | 'up'" }, - "default": "'up'", - "additionalPropsInfo": {} + "default": "'up'" }, - "FabProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, - "hidden": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "FabProps": { "type": { "name": "object" }, "default": "{}" }, + "hidden": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" } }, "onClose": { "type": { "name": "func" }, "signature": { "type": "function(event: object, reason: string) => void", "describedArgs": ["event", "reason"] - }, - "additionalPropsInfo": {} + } }, "onOpen": { "type": { "name": "func" }, "signature": { "type": "function(event: object, reason: string) => void", "describedArgs": ["event", "reason"] - }, - "additionalPropsInfo": {} + } }, - "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "openIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" } }, + "openIcon": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", @@ -39,20 +36,15 @@ }, "additionalPropsInfo": { "sx": true } }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Zoom", - "additionalPropsInfo": {} - }, + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Zoom" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" }, - "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } + "TransitionProps": { "type": { "name": "object" } } }, "name": "SpeedDial", "styles": { diff --git a/docs/pages/material-ui/api/stack.json b/docs/pages/material-ui/api/stack.json index eb63e03d5dda9e..5692c9d32bae3c 100644 --- a/docs/pages/material-ui/api/stack.json +++ b/docs/pages/material-ui/api/stack.json @@ -1,21 +1,19 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, + "component": { "type": { "name": "elementType" } }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - }, - "additionalPropsInfo": {} + } }, - "divider": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "divider": { "type": { "name": "node" } }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - }, - "additionalPropsInfo": {} + } }, "sx": { "type": { @@ -24,7 +22,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "useFlexGap": { "type": { "name": "bool" }, "additionalPropsInfo": {} } + "useFlexGap": { "type": { "name": "bool" } } }, "name": "Stack", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/step-button.json b/docs/pages/material-ui/api/step-button.json index 20206480389fdd..b137b4a94b9793 100644 --- a/docs/pages/material-ui/api/step-button.json +++ b/docs/pages/material-ui/api/step-button.json @@ -1,9 +1,9 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "optional": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" } }, + "optional": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/step-content.json b/docs/pages/material-ui/api/step-content.json index 75662aaf56d81f..51aaf750b62031 100644 --- a/docs/pages/material-ui/api/step-content.json +++ b/docs/pages/material-ui/api/step-content.json @@ -1,6 +1,6 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { @@ -9,20 +9,15 @@ }, "additionalPropsInfo": { "sx": true } }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Collapse", - "additionalPropsInfo": {} - }, + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Collapse" }, "transitionDuration": { "type": { "name": "union", "description": "'auto'
    | number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "'auto'", - "additionalPropsInfo": {} + "default": "'auto'" }, - "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } + "TransitionProps": { "type": { "name": "object" } } }, "name": "StepContent", "styles": { diff --git a/docs/pages/material-ui/api/step-icon.json b/docs/pages/material-ui/api/step-icon.json index db7a1669f3c9aa..26fd18055562c1 100644 --- a/docs/pages/material-ui/api/step-icon.json +++ b/docs/pages/material-ui/api/step-icon.json @@ -1,10 +1,10 @@ { "props": { - "active": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "active": { "type": { "name": "bool" }, "default": "false" }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "completed": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "completed": { "type": { "name": "bool" }, "default": "false" }, + "error": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/step-label.json b/docs/pages/material-ui/api/step-label.json index 96f8b6efc802ec..d72d8170af1a25 100644 --- a/docs/pages/material-ui/api/step-label.json +++ b/docs/pages/material-ui/api/step-label.json @@ -1,22 +1,20 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "componentsProps": { "type": { "name": "shape", "description": "{ label?: object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "optional": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "error": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "node" } }, + "optional": { "type": { "name": "node" } }, "slotProps": { "type": { "name": "shape", "description": "{ label?: object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, - "StepIconComponent": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "StepIconProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "StepIconComponent": { "type": { "name": "elementType" } }, + "StepIconProps": { "type": { "name": "object" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/step.json b/docs/pages/material-ui/api/step.json index 235093ec38441a..c557fb64f4d39c 100644 --- a/docs/pages/material-ui/api/step.json +++ b/docs/pages/material-ui/api/step.json @@ -1,14 +1,14 @@ { "props": { - "active": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "active": { "type": { "name": "bool" } }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "completed": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "expanded": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "index": { "type": { "name": "custom", "description": "integer" }, "additionalPropsInfo": {} }, - "last": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "completed": { "type": { "name": "bool" } }, + "component": { "type": { "name": "elementType" } }, + "disabled": { "type": { "name": "bool" } }, + "expanded": { "type": { "name": "bool" }, "default": "false" }, + "index": { "type": { "name": "custom", "description": "integer" } }, + "last": { "type": { "name": "bool" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/stepper.json b/docs/pages/material-ui/api/stepper.json index 63130fd750a3d3..a6ae3f5694b1a4 100644 --- a/docs/pages/material-ui/api/stepper.json +++ b/docs/pages/material-ui/api/stepper.json @@ -1,28 +1,15 @@ { "props": { - "activeStep": { - "type": { "name": "custom", "description": "integer" }, - "default": "0", - "additionalPropsInfo": {} - }, - "alternativeLabel": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "activeStep": { "type": { "name": "custom", "description": "integer" }, "default": "0" }, + "alternativeLabel": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "connector": { - "type": { "name": "element" }, - "default": "", - "additionalPropsInfo": {} - }, - "nonLinear": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "connector": { "type": { "name": "element" }, "default": "" }, + "nonLinear": { "type": { "name": "bool" }, "default": "false" }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'", - "additionalPropsInfo": {} + "default": "'horizontal'" }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/svg-icon.json b/docs/pages/material-ui/api/svg-icon.json index d0b1fede2cc849..2eb9bb06de746d 100644 --- a/docs/pages/material-ui/api/svg-icon.json +++ b/docs/pages/material-ui/api/svg-icon.json @@ -1,27 +1,25 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'inherit'
    | 'action'
    | 'disabled'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'inherit'", - "additionalPropsInfo": {} + "default": "'inherit'" }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "fontSize": { "type": { "name": "union", "description": "'inherit'
    | 'large'
    | 'medium'
    | 'small'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, - "htmlColor": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "inheritViewBox": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "shapeRendering": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "htmlColor": { "type": { "name": "string" } }, + "inheritViewBox": { "type": { "name": "bool" }, "default": "false" }, + "shapeRendering": { "type": { "name": "string" } }, "sx": { "type": { "name": "union", @@ -29,8 +27,8 @@ }, "additionalPropsInfo": { "sx": true } }, - "titleAccess": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'", "additionalPropsInfo": {} } + "titleAccess": { "type": { "name": "string" } }, + "viewBox": { "type": { "name": "string" }, "default": "'0 0 24 24'" } }, "name": "SvgIcon", "styles": { diff --git a/docs/pages/material-ui/api/swipeable-drawer.json b/docs/pages/material-ui/api/swipeable-drawer.json index 45ff3c4960b3da..80e9ed7146a776 100644 --- a/docs/pages/material-ui/api/swipeable-drawer.json +++ b/docs/pages/material-ui/api/swipeable-drawer.json @@ -3,52 +3,35 @@ "onClose": { "type": { "name": "func" }, "required": true, - "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] } }, "onOpen": { "type": { "name": "func" }, "required": true, - "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] } }, "allowSwipeInChildren": { "type": { "name": "union", "description": "bool
    | func" }, - "default": "false", - "additionalPropsInfo": {} - }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "disableBackdropTransition": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableDiscovery": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} + "default": "false" }, + "children": { "type": { "name": "node" } }, + "disableBackdropTransition": { "type": { "name": "bool" }, "default": "false" }, + "disableDiscovery": { "type": { "name": "bool" }, "default": "false" }, "disableSwipeToOpen": { "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)", - "additionalPropsInfo": {} - }, - "hysteresis": { "type": { "name": "number" }, "default": "0.52", "additionalPropsInfo": {} }, - "minFlingVelocity": { - "type": { "name": "number" }, - "default": "450", - "additionalPropsInfo": {} + "default": "typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)" }, - "open": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "SwipeAreaProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "swipeAreaWidth": { "type": { "name": "number" }, "default": "20", "additionalPropsInfo": {} }, + "hysteresis": { "type": { "name": "number" }, "default": "0.52" }, + "minFlingVelocity": { "type": { "name": "number" }, "default": "450" }, + "open": { "type": { "name": "bool" }, "default": "false" }, + "SwipeAreaProps": { "type": { "name": "object" } }, + "swipeAreaWidth": { "type": { "name": "number" }, "default": "20" }, "transitionDuration": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" } }, "name": "SwipeableDrawer", diff --git a/docs/pages/material-ui/api/switch.json b/docs/pages/material-ui/api/switch.json index 5dc9499b90f28e..b560356082987e 100644 --- a/docs/pages/material-ui/api/switch.json +++ b/docs/pages/material-ui/api/switch.json @@ -1,47 +1,43 @@ { "props": { - "checked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "checkedIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "checked": { "type": { "name": "bool" } }, + "checkedIcon": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'default'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'", - "additionalPropsInfo": {} + "default": "'primary'" }, - "defaultChecked": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "defaultChecked": { "type": { "name": "bool" } }, + "disabled": { "type": { "name": "bool" } }, + "disableRipple": { "type": { "name": "bool" }, "default": "false" }, "edge": { "type": { "name": "enum", "description": "'end'
    | 'start'
    | false" }, - "default": "false", - "additionalPropsInfo": {} + "default": "false" }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, + "icon": { "type": { "name": "node" } }, + "id": { "type": { "name": "string" } }, + "inputProps": { "type": { "name": "object" } }, + "inputRef": { "type": { "name": "custom", "description": "ref" } }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, - "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "required": { "type": { "name": "bool" }, "default": "false" }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { @@ -50,7 +46,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "any" } } }, "name": "Switch", "styles": { diff --git a/docs/pages/material-ui/api/tab-context.json b/docs/pages/material-ui/api/tab-context.json index de69f2f2de30d2..e01cf33a941639 100644 --- a/docs/pages/material-ui/api/tab-context.json +++ b/docs/pages/material-ui/api/tab-context.json @@ -1,7 +1,7 @@ { "props": { - "value": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "string" }, "required": true }, + "children": { "type": { "name": "node" } } }, "name": "TabContext", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/material-ui/api/tab-list.json b/docs/pages/material-ui/api/tab-list.json index 650dbfda529882..f965cdc48d5951 100644 --- a/docs/pages/material-ui/api/tab-list.json +++ b/docs/pages/material-ui/api/tab-list.json @@ -1,5 +1,5 @@ { - "props": { "children": { "type": { "name": "node" }, "additionalPropsInfo": {} } }, + "props": { "children": { "type": { "name": "node" } } }, "name": "TabList", "styles": { "classes": [ diff --git a/docs/pages/material-ui/api/tab-panel.json b/docs/pages/material-ui/api/tab-panel.json index 46ae3e81499848..6460133e3207b7 100644 --- a/docs/pages/material-ui/api/tab-panel.json +++ b/docs/pages/material-ui/api/tab-panel.json @@ -1,7 +1,7 @@ { "props": { - "value": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "string" }, "required": true }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/tab-scroll-button.json b/docs/pages/material-ui/api/tab-scroll-button.json index 6250e83c5dd10d..2d0dc7d6b4cc85 100644 --- a/docs/pages/material-ui/api/tab-scroll-button.json +++ b/docs/pages/material-ui/api/tab-scroll-button.json @@ -2,32 +2,28 @@ "props": { "direction": { "type": { "name": "enum", "description": "'left'
    | 'right'" }, - "required": true, - "additionalPropsInfo": {} + "required": true }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "required": true, - "additionalPropsInfo": {} + "required": true }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, "slotProps": { "type": { "name": "shape", "description": "{ endScrollButtonIcon?: func
    | object, startScrollButtonIcon?: func
    | object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ EndScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/tab.json b/docs/pages/material-ui/api/tab.json index a6b87f5c9cdb10..6fd4712a4ea81f 100644 --- a/docs/pages/material-ui/api/tab.json +++ b/docs/pages/material-ui/api/tab.json @@ -1,30 +1,19 @@ { "props": { - "children": { - "type": { "name": "custom", "description": "unsupportedProp" }, - "additionalPropsInfo": {} - }, + "children": { "type": { "name": "custom", "description": "unsupportedProp" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "disableFocusRipple": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "icon": { - "type": { "name": "union", "description": "element
    | string" }, - "additionalPropsInfo": {} - }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, + "disableRipple": { "type": { "name": "bool" }, "default": "false" }, + "icon": { "type": { "name": "union", "description": "element
    | string" } }, "iconPosition": { "type": { "name": "enum", "description": "'bottom'
    | 'end'
    | 'start'
    | 'top'" }, - "default": "'top'", - "additionalPropsInfo": {} + "default": "'top'" }, - "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "label": { "type": { "name": "node" } }, "sx": { "type": { "name": "union", @@ -32,8 +21,8 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, - "wrapped": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} } + "value": { "type": { "name": "any" } }, + "wrapped": { "type": { "name": "bool" }, "default": "false" } }, "name": "Tab", "styles": { diff --git a/docs/pages/material-ui/api/table-body.json b/docs/pages/material-ui/api/table-body.json index e2f84d06828c23..a55961a581dc22 100644 --- a/docs/pages/material-ui/api/table-body.json +++ b/docs/pages/material-ui/api/table-body.json @@ -1,8 +1,8 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-cell.json b/docs/pages/material-ui/api/table-cell.json index 2c47b067f5a5a0..ea43f62b9cddd0 100644 --- a/docs/pages/material-ui/api/table-cell.json +++ b/docs/pages/material-ui/api/table-cell.json @@ -5,30 +5,26 @@ "name": "enum", "description": "'center'
    | 'inherit'
    | 'justify'
    | 'left'
    | 'right'" }, - "default": "'inherit'", - "additionalPropsInfo": {} + "default": "'inherit'" }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "padding": { "type": { "name": "enum", "description": "'checkbox'
    | 'none'
    | 'normal'" - }, - "additionalPropsInfo": {} + } }, - "scope": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "scope": { "type": { "name": "string" } }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" - }, - "additionalPropsInfo": {} + } }, "sortDirection": { - "type": { "name": "enum", "description": "'asc'
    | 'desc'
    | false" }, - "additionalPropsInfo": {} + "type": { "name": "enum", "description": "'asc'
    | 'desc'
    | false" } }, "sx": { "type": { @@ -41,8 +37,7 @@ "type": { "name": "union", "description": "'body'
    | 'footer'
    | 'head'
    | string" - }, - "additionalPropsInfo": {} + } } }, "name": "TableCell", diff --git a/docs/pages/material-ui/api/table-container.json b/docs/pages/material-ui/api/table-container.json index 298cc40d5e9870..fd72a86c59cb6e 100644 --- a/docs/pages/material-ui/api/table-container.json +++ b/docs/pages/material-ui/api/table-container.json @@ -1,8 +1,8 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-footer.json b/docs/pages/material-ui/api/table-footer.json index 3614ee6b24a34e..58ad477e608a28 100644 --- a/docs/pages/material-ui/api/table-footer.json +++ b/docs/pages/material-ui/api/table-footer.json @@ -1,8 +1,8 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-head.json b/docs/pages/material-ui/api/table-head.json index cb29fe6ce28327..cd3379ca1f92db 100644 --- a/docs/pages/material-ui/api/table-head.json +++ b/docs/pages/material-ui/api/table-head.json @@ -1,8 +1,8 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-pagination.json b/docs/pages/material-ui/api/table-pagination.json index 8a8949418636cb..4d473568a83fc9 100644 --- a/docs/pages/material-ui/api/table-pagination.json +++ b/docs/pages/material-ui/api/table-pagination.json @@ -1,77 +1,48 @@ { "props": { - "count": { - "type": { "name": "custom", "description": "integer" }, - "required": true, - "additionalPropsInfo": {} - }, + "count": { "type": { "name": "custom", "description": "integer" }, "required": true }, "onPageChange": { "type": { "name": "func" }, "required": true, "signature": { "type": "function(event: React.MouseEvent | null, page: number) => void", "describedArgs": ["event", "page"] - }, - "additionalPropsInfo": {} + } }, - "page": { - "type": { "name": "custom", "description": "integer" }, - "required": true, - "additionalPropsInfo": {} - }, - "rowsPerPage": { - "type": { "name": "custom", "description": "integer" }, - "required": true, - "additionalPropsInfo": {} - }, - "ActionsComponent": { - "type": { "name": "elementType" }, - "default": "TablePaginationActions", - "additionalPropsInfo": {} - }, - "backIconButtonProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "page": { "type": { "name": "custom", "description": "integer" }, "required": true }, + "rowsPerPage": { "type": { "name": "custom", "description": "integer" }, "required": true }, + "ActionsComponent": { "type": { "name": "elementType" }, "default": "TablePaginationActions" }, + "backIconButtonProps": { "type": { "name": "object" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "getItemAriaLabel": { "type": { "name": "func" }, "default": "function defaultGetAriaLabel(type) {\n return `Go to ${type} page`;\n}", - "signature": { "type": "function(type: string) => string", "describedArgs": ["type"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(type: string) => string", "describedArgs": ["type"] } }, "labelDisplayedRows": { "type": { "name": "func" }, - "default": "function defaultLabelDisplayedRows({ from, to, count }) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}", - "additionalPropsInfo": {} - }, - "labelRowsPerPage": { - "type": { "name": "node" }, - "default": "'Rows per page:'", - "additionalPropsInfo": {} + "default": "function defaultLabelDisplayedRows({ from, to, count }) {\n return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`;\n}" }, - "nextIconButtonProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "labelRowsPerPage": { "type": { "name": "node" }, "default": "'Rows per page:'" }, + "nextIconButtonProps": { "type": { "name": "object" } }, "onRowsPerPageChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.ChangeEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, "rowsPerPageOptions": { "type": { "name": "arrayOf", "description": "Array<number
    | { label: string, value: number }>" }, - "default": "[10, 25, 50, 100]", - "additionalPropsInfo": {} - }, - "SelectProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, - "showFirstButton": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} + "default": "[10, 25, 50, 100]" }, - "showLastButton": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "SelectProps": { "type": { "name": "object" }, "default": "{}" }, + "showFirstButton": { "type": { "name": "bool" }, "default": "false" }, + "showLastButton": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-row.json b/docs/pages/material-ui/api/table-row.json index 35e5eb05d34e04..bda6df486fdd40 100644 --- a/docs/pages/material-ui/api/table-row.json +++ b/docs/pages/material-ui/api/table-row.json @@ -1,10 +1,10 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "hover": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "selected": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "hover": { "type": { "name": "bool" }, "default": "false" }, + "selected": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table-sort-label.json b/docs/pages/material-ui/api/table-sort-label.json index 3a23429209a1dd..cf8650307ea062 100644 --- a/docs/pages/material-ui/api/table-sort-label.json +++ b/docs/pages/material-ui/api/table-sort-label.json @@ -1,19 +1,14 @@ { "props": { - "active": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "active": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "direction": { "type": { "name": "enum", "description": "'asc'
    | 'desc'" }, - "default": "'asc'", - "additionalPropsInfo": {} - }, - "hideSortIcon": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "IconComponent": { - "type": { "name": "elementType" }, - "default": "ArrowDownwardIcon", - "additionalPropsInfo": {} + "default": "'asc'" }, + "hideSortIcon": { "type": { "name": "bool" }, "default": "false" }, + "IconComponent": { "type": { "name": "elementType" }, "default": "ArrowDownwardIcon" }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/table.json b/docs/pages/material-ui/api/table.json index 4b576985f3a3d7..baf5edc2b6f6ae 100644 --- a/docs/pages/material-ui/api/table.json +++ b/docs/pages/material-ui/api/table.json @@ -1,25 +1,23 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "padding": { "type": { "name": "enum", "description": "'checkbox'
    | 'none'
    | 'normal'" }, - "default": "'normal'", - "additionalPropsInfo": {} + "default": "'normal'" }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, - "stickyHeader": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "stickyHeader": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/tabs.json b/docs/pages/material-ui/api/tabs.json index 953121ec75bee3..410c0264f56848 100644 --- a/docs/pages/material-ui/api/tabs.json +++ b/docs/pages/material-ui/api/tabs.json @@ -1,64 +1,50 @@ { "props": { - "action": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, - "allowScrollButtonsMobile": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "aria-label": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "aria-labelledby": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "centered": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "action": { "type": { "name": "custom", "description": "ref" } }, + "allowScrollButtonsMobile": { "type": { "name": "bool" }, "default": "false" }, + "aria-label": { "type": { "name": "string" } }, + "aria-labelledby": { "type": { "name": "string" } }, + "centered": { "type": { "name": "bool" }, "default": "false" }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "indicatorColor": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | string" }, - "default": "'primary'", - "additionalPropsInfo": {} + "default": "'primary'" }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, value: any) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'", - "additionalPropsInfo": {} - }, - "ScrollButtonComponent": { - "type": { "name": "elementType" }, - "default": "TabScrollButton", - "additionalPropsInfo": {} + "default": "'horizontal'" }, + "ScrollButtonComponent": { "type": { "name": "elementType" }, "default": "TabScrollButton" }, "scrollButtons": { "type": { "name": "enum", "description": "'auto'
    | false
    | true" }, - "default": "'auto'", - "additionalPropsInfo": {} + "default": "'auto'" }, - "selectionFollowsFocus": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "selectionFollowsFocus": { "type": { "name": "bool" } }, "slotProps": { "type": { "name": "shape", "description": "{ endScrollButtonIcon?: func
    | object, startScrollButtonIcon?: func
    | object }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ EndScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { @@ -67,38 +53,24 @@ }, "additionalPropsInfo": { "sx": true } }, - "TabIndicatorProps": { - "type": { "name": "object" }, - "default": "{}", - "additionalPropsInfo": {} - }, - "TabScrollButtonProps": { - "type": { "name": "object" }, - "default": "{}", - "additionalPropsInfo": {} - }, + "TabIndicatorProps": { "type": { "name": "object" }, "default": "{}" }, + "TabScrollButtonProps": { "type": { "name": "object" }, "default": "{}" }, "textColor": { "type": { "name": "enum", "description": "'inherit'
    | 'primary'
    | 'secondary'" }, - "default": "'primary'", - "additionalPropsInfo": {} + "default": "'primary'" }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" } }, "variant": { "type": { "name": "enum", "description": "'fullWidth'
    | 'scrollable'
    | 'standard'" }, - "default": "'standard'", - "additionalPropsInfo": {} + "default": "'standard'" }, - "visibleScrollbar": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - } + "visibleScrollbar": { "type": { "name": "bool" }, "default": "false" } }, "name": "Tabs", "styles": { diff --git a/docs/pages/material-ui/api/text-field.json b/docs/pages/material-ui/api/text-field.json index 151bed48a71061..e7bc20163047ad 100644 --- a/docs/pages/material-ui/api/text-field.json +++ b/docs/pages/material-ui/api/text-field.json @@ -1,65 +1,52 @@ { "props": { - "autoComplete": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "autoFocus": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "autoComplete": { "type": { "name": "string" } }, + "autoFocus": { "type": { "name": "bool" }, "default": "false" }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'primary'", - "additionalPropsInfo": {} + "default": "'primary'" }, - "defaultValue": { "type": { "name": "any" }, "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "error": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "FormHelperTextProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "helperText": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "InputLabelProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "inputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "InputProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "inputRef": { "type": { "name": "custom", "description": "ref" }, "additionalPropsInfo": {} }, - "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultValue": { "type": { "name": "any" } }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "error": { "type": { "name": "bool" }, "default": "false" }, + "FormHelperTextProps": { "type": { "name": "object" } }, + "fullWidth": { "type": { "name": "bool" }, "default": "false" }, + "helperText": { "type": { "name": "node" } }, + "id": { "type": { "name": "string" } }, + "InputLabelProps": { "type": { "name": "object" } }, + "inputProps": { "type": { "name": "object" } }, + "InputProps": { "type": { "name": "object" } }, + "inputRef": { "type": { "name": "custom", "description": "ref" } }, + "label": { "type": { "name": "node" } }, "margin": { "type": { "name": "enum", "description": "'dense'
    | 'none'
    | 'normal'" }, - "default": "'none'", - "additionalPropsInfo": {} + "default": "'none'" }, - "maxRows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - }, - "minRows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - }, - "multiline": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "name": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "maxRows": { "type": { "name": "union", "description": "number
    | string" } }, + "minRows": { "type": { "name": "union", "description": "number
    | string" } }, + "multiline": { "type": { "name": "bool" }, "default": "false" }, + "name": { "type": { "name": "string" } }, "onChange": { "type": { "name": "func" }, - "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] }, - "additionalPropsInfo": {} + "signature": { "type": "function(event: object) => void", "describedArgs": ["event"] } }, - "placeholder": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "required": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "rows": { - "type": { "name": "union", "description": "number
    | string" }, - "additionalPropsInfo": {} - }, - "select": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "SelectProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, + "placeholder": { "type": { "name": "string" } }, + "required": { "type": { "name": "bool" }, "default": "false" }, + "rows": { "type": { "name": "union", "description": "number
    | string" } }, + "select": { "type": { "name": "bool" }, "default": "false" }, + "SelectProps": { "type": { "name": "object" } }, "size": { "type": { "name": "union", "description": "'medium'
    | 'small'
    | string" - }, - "additionalPropsInfo": {} + } }, "sx": { "type": { @@ -68,15 +55,14 @@ }, "additionalPropsInfo": { "sx": true } }, - "type": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} }, + "type": { "type": { "name": "string" } }, + "value": { "type": { "name": "any" } }, "variant": { "type": { "name": "enum", "description": "'filled'
    | 'outlined'
    | 'standard'" }, - "default": "'outlined'", - "additionalPropsInfo": {} + "default": "'outlined'" } }, "name": "TextField", diff --git a/docs/pages/material-ui/api/timeline-connector.json b/docs/pages/material-ui/api/timeline-connector.json index 4f7b1b0323b5b7..b5bfc71f540e14 100644 --- a/docs/pages/material-ui/api/timeline-connector.json +++ b/docs/pages/material-ui/api/timeline-connector.json @@ -1,6 +1,6 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/timeline-content.json b/docs/pages/material-ui/api/timeline-content.json index 1d798e23c1fc8c..5e57f38a28560a 100644 --- a/docs/pages/material-ui/api/timeline-content.json +++ b/docs/pages/material-ui/api/timeline-content.json @@ -1,6 +1,6 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/timeline-dot.json b/docs/pages/material-ui/api/timeline-dot.json index 274ff93fde8033..cfbef94961ed2c 100644 --- a/docs/pages/material-ui/api/timeline-dot.json +++ b/docs/pages/material-ui/api/timeline-dot.json @@ -1,14 +1,13 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'error'
    | 'grey'
    | 'info'
    | 'inherit'
    | 'primary'
    | 'secondary'
    | 'success'
    | 'warning'
    | string" }, - "default": "'grey'", - "additionalPropsInfo": {} + "default": "'grey'" }, "sx": { "type": { @@ -22,8 +21,7 @@ "name": "union", "description": "'filled'
    | 'outlined'
    | string" }, - "default": "'filled'", - "additionalPropsInfo": {} + "default": "'filled'" } }, "name": "TimelineDot", diff --git a/docs/pages/material-ui/api/timeline-item.json b/docs/pages/material-ui/api/timeline-item.json index 09850f35378b7c..f175dfc211b2a8 100644 --- a/docs/pages/material-ui/api/timeline-item.json +++ b/docs/pages/material-ui/api/timeline-item.json @@ -1,11 +1,8 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "position": { - "type": { "name": "enum", "description": "'left'
    | 'right'" }, - "additionalPropsInfo": {} - }, + "position": { "type": { "name": "enum", "description": "'left'
    | 'right'" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/material-ui/api/timeline-opposite-content.json b/docs/pages/material-ui/api/timeline-opposite-content.json index b6073c5920f715..81f9b3a5252d94 100644 --- a/docs/pages/material-ui/api/timeline-opposite-content.json +++ b/docs/pages/material-ui/api/timeline-opposite-content.json @@ -1,6 +1,6 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/timeline-separator.json b/docs/pages/material-ui/api/timeline-separator.json index 72fcf22715b766..3cfee05ac7eb40 100644 --- a/docs/pages/material-ui/api/timeline-separator.json +++ b/docs/pages/material-ui/api/timeline-separator.json @@ -1,6 +1,6 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/timeline.json b/docs/pages/material-ui/api/timeline.json index 34c674d30b7e6a..a0c188cdc68c21 100644 --- a/docs/pages/material-ui/api/timeline.json +++ b/docs/pages/material-ui/api/timeline.json @@ -1,15 +1,14 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "className": { "type": { "name": "string" }, "additionalPropsInfo": {} }, + "className": { "type": { "name": "string" } }, "position": { "type": { "name": "enum", "description": "'alternate'
    | 'left'
    | 'right'" }, - "default": "'right'", - "additionalPropsInfo": {} + "default": "'right'" }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/toggle-button-group.json b/docs/pages/material-ui/api/toggle-button-group.json index 1d7ffe7422ecd8..3723eefac50418 100644 --- a/docs/pages/material-ui/api/toggle-button-group.json +++ b/docs/pages/material-ui/api/toggle-button-group.json @@ -1,38 +1,34 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'standard'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'standard'", - "additionalPropsInfo": {} + "default": "'standard'" }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "exclusive": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "exclusive": { "type": { "name": "bool" }, "default": "false" }, + "fullWidth": { "type": { "name": "bool" }, "default": "false" }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.MouseEvent, value: any) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "orientation": { "type": { "name": "enum", "description": "'horizontal'
    | 'vertical'" }, - "default": "'horizontal'", - "additionalPropsInfo": {} + "default": "'horizontal'" }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { @@ -41,7 +37,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "value": { "type": { "name": "any" }, "additionalPropsInfo": {} } + "value": { "type": { "name": "any" } } }, "name": "ToggleButtonGroup", "styles": { diff --git a/docs/pages/material-ui/api/toggle-button.json b/docs/pages/material-ui/api/toggle-button.json index f4fd26341caff3..b25f9289756908 100644 --- a/docs/pages/material-ui/api/toggle-button.json +++ b/docs/pages/material-ui/api/toggle-button.json @@ -1,48 +1,40 @@ { "props": { - "value": { "type": { "name": "any" }, "required": true, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "value": { "type": { "name": "any" }, "required": true }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "color": { "type": { "name": "union", "description": "'standard'
    | 'primary'
    | 'secondary'
    | 'error'
    | 'info'
    | 'success'
    | 'warning'
    | string" }, - "default": "'standard'", - "additionalPropsInfo": {} + "default": "'standard'" }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "disableFocusRipple": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableRipple": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "fullWidth": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "disableFocusRipple": { "type": { "name": "bool" }, "default": "false" }, + "disableRipple": { "type": { "name": "bool" }, "default": "false" }, + "fullWidth": { "type": { "name": "bool" }, "default": "false" }, "onChange": { "type": { "name": "func" }, "signature": { "type": "function(event: React.MouseEvent, value: any) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "onClick": { "type": { "name": "func" }, "signature": { "type": "function(event: React.MouseEvent, value: any) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, - "selected": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "selected": { "type": { "name": "bool" } }, "size": { "type": { "name": "union", "description": "'small'
    | 'medium'
    | 'large'
    | string" }, - "default": "'medium'", - "additionalPropsInfo": {} + "default": "'medium'" }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/toolbar.json b/docs/pages/material-ui/api/toolbar.json index 5203185fdbb155..a5064038d15b48 100644 --- a/docs/pages/material-ui/api/toolbar.json +++ b/docs/pages/material-ui/api/toolbar.json @@ -1,9 +1,9 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "disableGutters": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "disableGutters": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", @@ -16,8 +16,7 @@ "name": "union", "description": "'dense'
    | 'regular'
    | string" }, - "default": "'regular'", - "additionalPropsInfo": {} + "default": "'regular'" } }, "name": "Toolbar", diff --git a/docs/pages/material-ui/api/tooltip.json b/docs/pages/material-ui/api/tooltip.json index f6090d25c5384b..384a11ff147f04 100644 --- a/docs/pages/material-ui/api/tooltip.json +++ b/docs/pages/material-ui/api/tooltip.json @@ -1,110 +1,71 @@ { "props": { - "children": { - "type": { "name": "custom", "description": "element" }, - "required": true, - "additionalPropsInfo": {} - }, - "arrow": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "children": { "type": { "name": "custom", "description": "element" }, "required": true }, + "arrow": { "type": { "name": "bool" }, "default": "false" }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, "components": { "type": { "name": "shape", "description": "{ Arrow?: elementType, Popper?: elementType, Tooltip?: elementType, Transition?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "componentsProps": { "type": { "name": "shape", "description": "{ arrow?: object, popper?: object, tooltip?: object, transition?: object }" }, - "default": "{}", - "additionalPropsInfo": {} - }, - "describeChild": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "disableFocusListener": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableHoverListener": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableInteractive": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableTouchListener": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "enterDelay": { "type": { "name": "number" }, "default": "100", "additionalPropsInfo": {} }, - "enterNextDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, - "enterTouchDelay": { - "type": { "name": "number" }, - "default": "700", - "additionalPropsInfo": {} - }, - "followCursor": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "leaveDelay": { "type": { "name": "number" }, "default": "0", "additionalPropsInfo": {} }, - "leaveTouchDelay": { - "type": { "name": "number" }, - "default": "1500", - "additionalPropsInfo": {} - }, + "default": "{}" + }, + "describeChild": { "type": { "name": "bool" }, "default": "false" }, + "disableFocusListener": { "type": { "name": "bool" }, "default": "false" }, + "disableHoverListener": { "type": { "name": "bool" }, "default": "false" }, + "disableInteractive": { "type": { "name": "bool" }, "default": "false" }, + "disableTouchListener": { "type": { "name": "bool" }, "default": "false" }, + "enterDelay": { "type": { "name": "number" }, "default": "100" }, + "enterNextDelay": { "type": { "name": "number" }, "default": "0" }, + "enterTouchDelay": { "type": { "name": "number" }, "default": "700" }, + "followCursor": { "type": { "name": "bool" }, "default": "false" }, + "id": { "type": { "name": "string" } }, + "leaveDelay": { "type": { "name": "number" }, "default": "0" }, + "leaveTouchDelay": { "type": { "name": "number" }, "default": "1500" }, "onClose": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, "onOpen": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent) => void", "describedArgs": ["event"] - }, - "additionalPropsInfo": {} + } }, - "open": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "open": { "type": { "name": "bool" } }, "placement": { "type": { "name": "enum", "description": "'bottom-end'
    | 'bottom-start'
    | 'bottom'
    | 'left-end'
    | 'left-start'
    | 'left'
    | 'right-end'
    | 'right-start'
    | 'right'
    | 'top-end'
    | 'top-start'
    | 'top'" }, - "default": "'bottom'", - "additionalPropsInfo": {} - }, - "PopperComponent": { - "type": { "name": "elementType" }, - "default": "Popper", - "additionalPropsInfo": {} + "default": "'bottom'" }, - "PopperProps": { "type": { "name": "object" }, "default": "{}", "additionalPropsInfo": {} }, + "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": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "slots": { "type": { "name": "shape", "description": "{ arrow?: elementType, popper?: elementType, tooltip?: elementType, transition?: elementType }" }, - "default": "{}", - "additionalPropsInfo": {} + "default": "{}" }, "sx": { "type": { @@ -113,13 +74,9 @@ }, "additionalPropsInfo": { "sx": true } }, - "title": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Grow", - "additionalPropsInfo": {} - }, - "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } + "title": { "type": { "name": "node" } }, + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Grow" }, + "TransitionProps": { "type": { "name": "object" } } }, "name": "Tooltip", "styles": { diff --git a/docs/pages/material-ui/api/tree-item.json b/docs/pages/material-ui/api/tree-item.json index 3fcb668dd2821d..15e147c5d3f074 100644 --- a/docs/pages/material-ui/api/tree-item.json +++ b/docs/pages/material-ui/api/tree-item.json @@ -1,24 +1,20 @@ { "props": { - "nodeId": { "type": { "name": "string" }, "required": true, "additionalPropsInfo": {} }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "nodeId": { "type": { "name": "string" }, "required": true }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "collapseIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "collapseIcon": { "type": { "name": "node" } }, "ContentComponent": { "type": { "name": "custom", "description": "element type" }, - "default": "TreeItemContent", - "additionalPropsInfo": {} - }, - "ContentProps": { "type": { "name": "object" }, "additionalPropsInfo": {} }, - "disabled": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "endIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "expandIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "icon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "label": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "onFocus": { - "type": { "name": "custom", "description": "unsupportedProp" }, - "additionalPropsInfo": {} + "default": "TreeItemContent" }, + "ContentProps": { "type": { "name": "object" } }, + "disabled": { "type": { "name": "bool" }, "default": "false" }, + "endIcon": { "type": { "name": "node" } }, + "expandIcon": { "type": { "name": "node" } }, + "icon": { "type": { "name": "node" } }, + "label": { "type": { "name": "node" } }, + "onFocus": { "type": { "name": "custom", "description": "unsupportedProp" } }, "sx": { "type": { "name": "union", @@ -26,12 +22,8 @@ }, "additionalPropsInfo": { "sx": true } }, - "TransitionComponent": { - "type": { "name": "elementType" }, - "default": "Collapse", - "additionalPropsInfo": {} - }, - "TransitionProps": { "type": { "name": "object" }, "additionalPropsInfo": {} } + "TransitionComponent": { "type": { "name": "elementType" }, "default": "Collapse" }, + "TransitionProps": { "type": { "name": "object" } } }, "name": "TreeItem", "styles": { diff --git a/docs/pages/material-ui/api/tree-view.json b/docs/pages/material-ui/api/tree-view.json index 92677a6cc6e07f..2d86530842a826 100644 --- a/docs/pages/material-ui/api/tree-view.json +++ b/docs/pages/material-ui/api/tree-view.json @@ -1,64 +1,47 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "defaultCollapseIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "defaultEndIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultCollapseIcon": { "type": { "name": "node" } }, + "defaultEndIcon": { "type": { "name": "node" } }, "defaultExpanded": { "type": { "name": "arrayOf", "description": "Array<string>" }, - "default": "[]", - "additionalPropsInfo": {} + "default": "[]" }, - "defaultExpandIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "defaultParentIcon": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "defaultExpandIcon": { "type": { "name": "node" } }, + "defaultParentIcon": { "type": { "name": "node" } }, "defaultSelected": { "type": { "name": "union", "description": "Array<string>
    | string" }, - "default": "[]", - "additionalPropsInfo": {} + "default": "[]" }, - "disabledItemsFocusable": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "disableSelection": { - "type": { "name": "bool" }, - "default": "false", - "additionalPropsInfo": {} - }, - "expanded": { - "type": { "name": "arrayOf", "description": "Array<string>" }, - "additionalPropsInfo": {} - }, - "id": { "type": { "name": "string" }, "additionalPropsInfo": {} }, - "multiSelect": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "disabledItemsFocusable": { "type": { "name": "bool" }, "default": "false" }, + "disableSelection": { "type": { "name": "bool" }, "default": "false" }, + "expanded": { "type": { "name": "arrayOf", "description": "Array<string>" } }, + "id": { "type": { "name": "string" } }, + "multiSelect": { "type": { "name": "bool" }, "default": "false" }, "onNodeFocus": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, value: string) => void", "describedArgs": ["event", "value"] - }, - "additionalPropsInfo": {} + } }, "onNodeSelect": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, nodeIds: Array | string) => void", "describedArgs": ["event", "nodeIds"] - }, - "additionalPropsInfo": {} + } }, "onNodeToggle": { "type": { "name": "func" }, "signature": { "type": "function(event: React.SyntheticEvent, nodeIds: array) => void", "describedArgs": ["event", "nodeIds"] - }, - "additionalPropsInfo": {} + } }, "selected": { - "type": { "name": "union", "description": "Array<string>
    | string" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "Array<string>
    | string" } }, "sx": { "type": { diff --git a/docs/pages/material-ui/api/typography.json b/docs/pages/material-ui/api/typography.json index 77d4928fe472b9..2b50b32cabc35f 100644 --- a/docs/pages/material-ui/api/typography.json +++ b/docs/pages/material-ui/api/typography.json @@ -5,15 +5,14 @@ "name": "enum", "description": "'center'
    | 'inherit'
    | 'justify'
    | 'left'
    | 'right'" }, - "default": "'inherit'", - "additionalPropsInfo": {} + "default": "'inherit'" }, - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "gutterBottom": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "noWrap": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, - "paragraph": { "type": { "name": "bool" }, "default": "false", "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "gutterBottom": { "type": { "name": "bool" }, "default": "false" }, + "noWrap": { "type": { "name": "bool" }, "default": "false" }, + "paragraph": { "type": { "name": "bool" }, "default": "false" }, "sx": { "type": { "name": "union", @@ -26,13 +25,11 @@ "name": "union", "description": "'body1'
    | 'body2'
    | 'button'
    | 'caption'
    | 'h1'
    | 'h2'
    | 'h3'
    | 'h4'
    | 'h5'
    | 'h6'
    | 'inherit'
    | 'overline'
    | 'subtitle1'
    | 'subtitle2'
    | string" }, - "default": "'body1'", - "additionalPropsInfo": {} + "default": "'body1'" }, "variantMapping": { "type": { "name": "object" }, - "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n subtitle1: 'h6',\n subtitle2: 'h6',\n body1: 'p',\n body2: 'p',\n inherit: 'p',\n}", - "additionalPropsInfo": {} + "default": "{\n h1: 'h1',\n h2: 'h2',\n h3: 'h3',\n h4: 'h4',\n h5: 'h5',\n h6: 'h6',\n subtitle1: 'h6',\n subtitle2: 'h6',\n body1: 'p',\n body2: 'p',\n inherit: 'p',\n}" } }, "name": "Typography", diff --git a/docs/pages/material-ui/api/zoom.json b/docs/pages/material-ui/api/zoom.json index e1f4bf4135cff9..38a6f4b55ff8d3 100644 --- a/docs/pages/material-ui/api/zoom.json +++ b/docs/pages/material-ui/api/zoom.json @@ -1,27 +1,21 @@ { "props": { - "children": { - "type": { "name": "custom", "description": "element" }, - "required": true, - "additionalPropsInfo": {} - }, - "addEndListener": { "type": { "name": "func" }, "additionalPropsInfo": {} }, - "appear": { "type": { "name": "bool" }, "default": "true", "additionalPropsInfo": {} }, + "children": { "type": { "name": "custom", "description": "element" }, "required": true }, + "addEndListener": { "type": { "name": "func" } }, + "appear": { "type": { "name": "bool" }, "default": "true" }, "easing": { "type": { "name": "union", "description": "{ enter?: string, exit?: string }
    | string" - }, - "additionalPropsInfo": {} + } }, - "in": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "in": { "type": { "name": "bool" } }, "timeout": { "type": { "name": "union", "description": "number
    | { appear?: number, enter?: number, exit?: number }" }, - "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}", - "additionalPropsInfo": {} + "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" } }, "name": "Zoom", diff --git a/docs/pages/system/api/box.json b/docs/pages/system/api/box.json index 4eeb2a418ee964..de55f7f9d96240 100644 --- a/docs/pages/system/api/box.json +++ b/docs/pages/system/api/box.json @@ -1,6 +1,6 @@ { "props": { - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, "sx": { "type": { "name": "union", diff --git a/docs/pages/system/api/container.json b/docs/pages/system/api/container.json index 181d1cf4649b6e..320e2e74e33384 100644 --- a/docs/pages/system/api/container.json +++ b/docs/pages/system/api/container.json @@ -1,15 +1,14 @@ { "props": { "classes": { "type": { "name": "object" }, "additionalPropsInfo": { "cssApi": true } }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, - "disableGutters": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, - "fixed": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "component": { "type": { "name": "elementType" } }, + "disableGutters": { "type": { "name": "bool" } }, + "fixed": { "type": { "name": "bool" } }, "maxWidth": { "type": { "name": "union", "description": "'xs'
    | 'sm'
    | 'md'
    | 'lg'
    | 'xl'
    | false
    | string" - }, - "additionalPropsInfo": {} + } }, "sx": { "type": { diff --git a/docs/pages/system/api/grid.json b/docs/pages/system/api/grid.json index e22817cab252b3..241eff5da0f4b9 100644 --- a/docs/pages/system/api/grid.json +++ b/docs/pages/system/api/grid.json @@ -1,105 +1,64 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, "columns": { "type": { "name": "union", "description": "Array<number>
    | number
    | object" - }, - "additionalPropsInfo": {} + } }, "columnSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - }, - "additionalPropsInfo": {} + } }, - "container": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "container": { "type": { "name": "bool" } }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - }, - "additionalPropsInfo": {} + } }, - "disableEqualOverflow": { "type": { "name": "bool" }, "additionalPropsInfo": {} }, + "disableEqualOverflow": { "type": { "name": "bool" } }, "lg": { - "type": { - "name": "union", - "description": "'auto'
    | number
    | bool" - }, - "additionalPropsInfo": {} - }, - "lgOffset": { - "type": { "name": "union", "description": "'auto'
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "'auto'
    | number
    | bool" } }, + "lgOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "md": { - "type": { - "name": "union", - "description": "'auto'
    | number
    | bool" - }, - "additionalPropsInfo": {} - }, - "mdOffset": { - "type": { "name": "union", "description": "'auto'
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "'auto'
    | number
    | bool" } }, + "mdOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "rowSpacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - }, - "additionalPropsInfo": {} + } }, "sm": { - "type": { - "name": "union", - "description": "'auto'
    | number
    | bool" - }, - "additionalPropsInfo": {} - }, - "smOffset": { - "type": { "name": "union", "description": "'auto'
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "'auto'
    | number
    | bool" } }, + "smOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - }, - "additionalPropsInfo": {} + } }, "wrap": { "type": { "name": "enum", "description": "'nowrap'
    | 'wrap-reverse'
    | 'wrap'" - }, - "additionalPropsInfo": {} + } }, "xl": { - "type": { - "name": "union", - "description": "'auto'
    | number
    | bool" - }, - "additionalPropsInfo": {} - }, - "xlOffset": { - "type": { "name": "union", "description": "'auto'
    | number" }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "'auto'
    | number
    | bool" } }, + "xlOffset": { "type": { "name": "union", "description": "'auto'
    | number" } }, "xs": { - "type": { - "name": "union", - "description": "'auto'
    | number
    | bool" - }, - "additionalPropsInfo": {} + "type": { "name": "union", "description": "'auto'
    | number
    | bool" } }, - "xsOffset": { - "type": { "name": "union", "description": "'auto'
    | number" }, - "additionalPropsInfo": {} - } + "xsOffset": { "type": { "name": "union", "description": "'auto'
    | number" } } }, "name": "Grid", "styles": { "classes": [], "globalClasses": {}, "name": null }, diff --git a/docs/pages/system/api/stack.json b/docs/pages/system/api/stack.json index 4143214bbd12bc..2342bf5a38c3a7 100644 --- a/docs/pages/system/api/stack.json +++ b/docs/pages/system/api/stack.json @@ -1,21 +1,19 @@ { "props": { - "children": { "type": { "name": "node" }, "additionalPropsInfo": {} }, - "component": { "type": { "name": "elementType" }, "additionalPropsInfo": {} }, + "children": { "type": { "name": "node" } }, + "component": { "type": { "name": "elementType" } }, "direction": { "type": { "name": "union", "description": "'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'
    | Array<'column-reverse'
    | 'column'
    | 'row-reverse'
    | 'row'>
    | object" - }, - "additionalPropsInfo": {} + } }, - "divider": { "type": { "name": "node" }, "additionalPropsInfo": {} }, + "divider": { "type": { "name": "node" } }, "spacing": { "type": { "name": "union", "description": "Array<number
    | string>
    | number
    | object
    | string" - }, - "additionalPropsInfo": {} + } }, "sx": { "type": { @@ -24,7 +22,7 @@ }, "additionalPropsInfo": { "sx": true } }, - "useFlexGap": { "type": { "name": "bool" }, "additionalPropsInfo": {} } + "useFlexGap": { "type": { "name": "bool" } } }, "name": "Stack", "styles": { "classes": [], "globalClasses": {}, "name": null }, From 1e205814a65a75a02cf44cba2b2e03b4b02950fa Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Wed, 14 Jun 2023 19:28:54 -0300 Subject: [PATCH 41/85] a few styling tweaks --- docs/src/modules/components/ApiPage/ApiItem.tsx | 9 +++++---- docs/src/modules/components/MarkdownElement.js | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 1ee17d0413ed7b..ebac8389ca746a 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -38,7 +38,7 @@ const Root = styled('div')( span: { fontWeight: theme.typography.fontWeightRegular, borderBottom: 'solid 1px', - borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + borderColor: `var(--muidocs-palette-divider, ${lightTheme.palette.divider})`, }, '& .MuiApi-item-title': { flexShrink: 0, @@ -81,6 +81,7 @@ const Root = styled('div')( }, }, '& .MuiAlert-standardWarning': { + padding: '6px 12px', fontWeight: theme.typography.fontWeightMedium, border: '1px solid', borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, @@ -130,13 +131,13 @@ const Root = styled('div')( backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, }, }, - marginBottom: 40, + marginBottom: 36, }), ({ theme }) => ({ [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { '& .MuiApi-item-header': { '& span': { - borderColor: `var(--muidocs-palette-primaryDark-600, ${darkTheme.palette.primaryDark[600]})`, + borderColor: `var(--muidocs-palette-divider, ${darkTheme.palette.divider})`, }, '& .MuiApi-item-title': { color: `var(--muidocs-palette-primary-100, ${darkTheme.palette.primary[100]})`, @@ -168,7 +169,7 @@ const Root = styled('div')( '& .MuiAlert-standardWarning': { borderColor: alpha(darkTheme.palette.warning[600], 0.2), backgroundColor: alpha(darkTheme.palette.warning[800], 0.2), - color: `var(--muidocs-palette-warning-300, ${darkTheme.palette.warning[300]})`, + color: `var(--muidocs-palette-warning-100, ${darkTheme.palette.warning[100]})`, '.MuiAlert-icon svg': { fill: `var(--muidocs-palette-warning-400, ${darkTheme.palette.warning[400]})`, }, diff --git a/docs/src/modules/components/MarkdownElement.js b/docs/src/modules/components/MarkdownElement.js index bafbb4978d8cad..a992fc9cfbc392 100644 --- a/docs/src/modules/components/MarkdownElement.js +++ b/docs/src/modules/components/MarkdownElement.js @@ -55,7 +55,7 @@ const Root = styled('div')( color: `var(--muidocs-palette-text-primary, ${lightTheme.palette.text.primary})`, backgroundColor: alpha(lightTheme.palette.primary.light, 0.1), border: '1px solid', - borderColor: alpha(lightTheme.palette.primary.light, 0.15), + borderColor: alpha(lightTheme.palette.primary.light, 0.1), borderRadius: 5, fontSize: lightTheme.typography.pxToRem(13), direction: 'ltr /*! @noflip */', From 6df9fdaec4957addfb6595fae56fe69c975b7d24 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 15 Jun 2023 10:06:36 +0200 Subject: [PATCH 42/85] danail proposal --- docs/src/modules/components/ApiPage/ApiItem.tsx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index ebac8389ca746a..d65ef6c0a1111d 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -58,6 +58,9 @@ const Root = styled('div')( padding: '6px 10px', paddingBottom: 3, flexGrow: 1, + textOverflow: 'ellipsis', + overflow: 'hidden', + whiteSpace: 'nowrap', }, '& .MuiApi-item-note': { padding: '2px 6px', @@ -225,6 +228,7 @@ function ApiItem(props: ApiItemProps) { dangerouslySetInnerHTML={{ __html: (description ?? '').replace(/
    /g, ' '), }} + title={(description ?? '').replace(/
    /g, ' ')} /> {note && {note}}
    From 4309a8beac84133ffb5d8042d8ce95d1daf6a1e1 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 15 Jun 2023 10:13:22 +0200 Subject: [PATCH 43/85] fix special characters --- docs/src/modules/components/ApiPage/ApiItem.tsx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index d65ef6c0a1111d..9dbf2bd0ad7a23 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -228,7 +228,10 @@ function ApiItem(props: ApiItemProps) { dangerouslySetInnerHTML={{ __html: (description ?? '').replace(/
    /g, ' '), }} - title={(description ?? '').replace(/
    /g, ' ')} + title={(description ?? '') + .replace(/
    /g, ' ') + .replace(/ /g, ' ') + .replace(/|/g, '|')} /> {note && {note}}
    From ece6fa033fe083bf263b76cfe21f70478fb8e167 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 16 Jun 2023 17:05:44 +0200 Subject: [PATCH 44/85] add extensions --- .../modules/components/ApiPage/ApiItem.tsx | 60 ++++++++++++++++--- 1 file changed, 53 insertions(+), 7 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 9dbf2bd0ad7a23..be6e954c80e0b5 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -6,6 +6,8 @@ import { brandingDarkTheme as darkTheme, brandingLightTheme as lightTheme, } from 'docs/src/modules/brandingTheme'; +import KeyboardArrowDownIcon from '@mui/icons-material/KeyboardArrowDown'; +import { IconButton } from '@mui/material'; const Root = styled('div')( ({ theme }) => ({ @@ -14,7 +16,7 @@ const Root = styled('div')( fontSize: 13, fontFamily: theme.typography.fontFamilyCode, display: 'flex', - alignItems: 'flex-end', + alignItems: 'flex-start', position: 'relative', marginBottom: 12, marginLeft: -32, @@ -35,15 +37,17 @@ const Root = styled('div')( width: '14px', }, }, - span: { + '&>span, &>div': { fontWeight: theme.typography.fontWeightRegular, borderBottom: 'solid 1px', borderColor: `var(--muidocs-palette-divider, ${lightTheme.palette.divider})`, }, + '&>*': { + height: 26, + }, '& .MuiApi-item-title': { flexShrink: 0, padding: '2px 6px', - height: 'fit-content', marginLeft: 32, borderWidth: '1px', borderStyle: 'solid', @@ -55,12 +59,23 @@ const Root = styled('div')( backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, }, '& .MuiApi-item-description': { - padding: '6px 10px', + padding: '0 10px 6px 10px', paddingBottom: 3, flexGrow: 1, textOverflow: 'ellipsis', overflow: 'hidden', whiteSpace: 'nowrap', + + '&.MuiApi-item-description-extended': { + whiteSpace: 'normal', + alignSelf: 'start', + height: 'auto', + }, + }, + '& .MuiApi-item-extend-description': { + alignItems: 'center', + display: 'flex', + placeItems: 'end', }, '& .MuiApi-item-note': { padding: '2px 6px', @@ -139,7 +154,7 @@ const Root = styled('div')( ({ theme }) => ({ [`:where(${theme.vars ? '[data-mui-color-scheme="dark"]' : '.mode-dark'}) &`]: { '& .MuiApi-item-header': { - '& span': { + '&>span, &>div': { borderColor: `var(--muidocs-palette-divider, ${darkTheme.palette.divider})`, }, '& .MuiApi-item-title': { @@ -205,6 +220,26 @@ export type ApiItemProps = { function ApiItem(props: ApiItemProps) { const { title, description, note, children, id } = props; + const descriptionRef = React.useRef(null); + const [isOverflow, setIsOverflow] = React.useState(false); + const [isExtended, setIsExtended] = React.useState(false); + + React.useEffect(() => { + const handler = () => { + if (descriptionRef.current === null) { + return; + } + setIsOverflow(descriptionRef.current.scrollWidth > descriptionRef.current.offsetWidth); + }; + + handler(); + + window.addEventListener('resize', handler); + return () => { + window.removeEventListener('resize', handler); + }; + }, []); + return (
    @@ -223,16 +258,27 @@ function ApiItem(props: ApiItemProps) { {title} + /g, ' '), + __html: isExtended ? description! : (description ?? '').replace(/
    /g, ' '), }} title={(description ?? '') .replace(/
    /g, ' ') .replace(/ /g, ' ') .replace(/|/g, '|')} /> + {isOverflow && ( +
    + setIsExtended((prev) => !prev)}> + + +
    + )} {note && {note}}
    {children} From 82afdf641e8a762223c7dbe5a3acb153bec0f434 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 16 Jun 2023 17:08:59 +0200 Subject: [PATCH 45/85] hide link when too big --- .../modules/components/ApiPage/ApiItem.tsx | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index be6e954c80e0b5..af8191731d8bcd 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -81,19 +81,21 @@ const Root = styled('div')( padding: '2px 6px', color: `var(--muidocs-palette-success-800, ${lightTheme.palette.success[800]})`, }, - '&:hover, &:target': { - '.MuiApi-item-link-visual': { - display: 'inline-block', - }, - '.MuiApi-item-title': { - marginLeft: 6, - }, - '.MuiApi-item-link-visual:hover': { - cursor: 'pointer', - backgroundColor: alpha(lightTheme.palette.primary[100], 0.4), - borderColor: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, - '& svg': { - fill: `var(--muidocs-palette-primary-main, ${lightTheme.palette.primary.main})`, + [theme.breakpoints.up('lg')]: { + '&:hover, &:target': { + '.MuiApi-item-link-visual': { + display: 'inline-block', + }, + '.MuiApi-item-title': { + marginLeft: 6, + }, + '.MuiApi-item-link-visual:hover': { + cursor: 'pointer', + backgroundColor: alpha(lightTheme.palette.primary[100], 0.4), + borderColor: `var(--muidocs-palette-primary-100, ${lightTheme.palette.primary[100]})`, + '& svg': { + fill: `var(--muidocs-palette-primary-main, ${lightTheme.palette.primary.main})`, + }, }, }, }, From 3d58342a0322e740ea157bbdade1fa5bf0007973 Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 22 Jun 2023 09:25:56 +0200 Subject: [PATCH 46/85] feedbacks --- docs/src/modules/components/ApiPage/ApiItem.tsx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index af8191731d8bcd..ac3229a5860ae1 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -6,6 +6,7 @@ import { brandingDarkTheme as darkTheme, brandingLightTheme as lightTheme, } from 'docs/src/modules/brandingTheme'; +import KeyboardArrowUpIcon from '@mui/icons-material/KeyboardArrowUp'; import KeyboardArrowDownIcon from '@mui/icons-material/KeyboardArrowDown'; import { IconButton } from '@mui/material'; @@ -16,7 +17,7 @@ const Root = styled('div')( fontSize: 13, fontFamily: theme.typography.fontFamilyCode, display: 'flex', - alignItems: 'flex-start', + alignItems: 'flex-end', position: 'relative', marginBottom: 12, marginLeft: -32, @@ -277,7 +278,7 @@ function ApiItem(props: ApiItemProps) { {isOverflow && (
    setIsExtended((prev) => !prev)}> - + {isExtended ? : }
    )} From c4b9cd06a92e7543bda7cb69fcf83a972a5c3a5a Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 29 Jun 2023 16:56:26 +0200 Subject: [PATCH 47/85] remove added files --- .../react-accordion/[docsTab]/index.js | 32 ------------------- .../react-all-components/[docsTab]/index.js | 32 ------------------- .../base-ui/react-all-components/index.js | 13 -------- .../base-ui/react-checkbox/[docsTab]/index.js | 32 ------------------- .../react-radio-button/[docsTab]/index.js | 32 ------------------- 5 files changed, 141 deletions(-) delete mode 100644 docs/pages/base-ui/react-accordion/[docsTab]/index.js delete mode 100644 docs/pages/base-ui/react-all-components/[docsTab]/index.js delete mode 100644 docs/pages/base-ui/react-all-components/index.js delete mode 100644 docs/pages/base-ui/react-checkbox/[docsTab]/index.js delete mode 100644 docs/pages/base-ui/react-radio-button/[docsTab]/index.js diff --git a/docs/pages/base-ui/react-accordion/[docsTab]/index.js b/docs/pages/base-ui/react-accordion/[docsTab]/index.js deleted file mode 100644 index f3a0251d3e856c..00000000000000 --- a/docs/pages/base-ui/react-accordion/[docsTab]/index.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; -import AppFrame from 'docs/src/modules/components/AppFrame'; -import * as pageProps from 'docs/data/base/components/accordion/accordion.md?@mui/markdown'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; - -export default function Page(props) { - const { userLanguage, ...other } = props; - return ; -} - -Page.getLayout = (page) => { - return {page}; -}; - -export const getStaticPaths = () => { - return { - paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], - fallback: false, // can also be true or 'blocking' - }; -}; - -export const getStaticProps = () => { - return { - props: { - componentsApiDescriptions: {}, - componentsApiPageContents: {}, - hooksApiDescriptions: {}, - hooksApiPageContents: {}, - }, - }; -}; diff --git a/docs/pages/base-ui/react-all-components/[docsTab]/index.js b/docs/pages/base-ui/react-all-components/[docsTab]/index.js deleted file mode 100644 index f8c44f11d77ff4..00000000000000 --- a/docs/pages/base-ui/react-all-components/[docsTab]/index.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; -import AppFrame from 'docs/src/modules/components/AppFrame'; -import * as pageProps from 'docs/data/base/components/all-components/all-components.md?@mui/markdown'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; - -export default function Page(props) { - const { userLanguage, ...other } = props; - return ; -} - -Page.getLayout = (page) => { - return {page}; -}; - -export const getStaticPaths = () => { - return { - paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], - fallback: false, // can also be true or 'blocking' - }; -}; - -export const getStaticProps = () => { - return { - props: { - componentsApiDescriptions: {}, - componentsApiPageContents: {}, - hooksApiDescriptions: {}, - hooksApiPageContents: {}, - }, - }; -}; diff --git a/docs/pages/base-ui/react-all-components/index.js b/docs/pages/base-ui/react-all-components/index.js deleted file mode 100644 index 2bb2c253929f6b..00000000000000 --- a/docs/pages/base-ui/react-all-components/index.js +++ /dev/null @@ -1,13 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; -import AppFrame from 'docs/src/modules/components/AppFrame'; -import * as pageProps from 'docs/data/base/components/all-components/all-components.md?@mui/markdown'; - -export default function Page(props) { - const { userLanguage, ...other } = props; - return ; -} - -Page.getLayout = (page) => { - return {page}; -}; diff --git a/docs/pages/base-ui/react-checkbox/[docsTab]/index.js b/docs/pages/base-ui/react-checkbox/[docsTab]/index.js deleted file mode 100644 index d126a7fbfce6c7..00000000000000 --- a/docs/pages/base-ui/react-checkbox/[docsTab]/index.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; -import AppFrame from 'docs/src/modules/components/AppFrame'; -import * as pageProps from 'docs/data/base/components/checkbox/checkbox.md?@mui/markdown'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; - -export default function Page(props) { - const { userLanguage, ...other } = props; - return ; -} - -Page.getLayout = (page) => { - return {page}; -}; - -export const getStaticPaths = () => { - return { - paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], - fallback: false, // can also be true or 'blocking' - }; -}; - -export const getStaticProps = () => { - return { - props: { - componentsApiDescriptions: {}, - componentsApiPageContents: {}, - hooksApiDescriptions: {}, - hooksApiPageContents: {}, - }, - }; -}; diff --git a/docs/pages/base-ui/react-radio-button/[docsTab]/index.js b/docs/pages/base-ui/react-radio-button/[docsTab]/index.js deleted file mode 100644 index 896c61aa04a6a5..00000000000000 --- a/docs/pages/base-ui/react-radio-button/[docsTab]/index.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; -import AppFrame from 'docs/src/modules/components/AppFrame'; -import * as pageProps from 'docs/data/base/components/radio-button/radio-button.md?@mui/markdown'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; - -export default function Page(props) { - const { userLanguage, ...other } = props; - return ; -} - -Page.getLayout = (page) => { - return {page}; -}; - -export const getStaticPaths = () => { - return { - paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], - fallback: false, // can also be true or 'blocking' - }; -}; - -export const getStaticProps = () => { - return { - props: { - componentsApiDescriptions: {}, - componentsApiPageContents: {}, - hooksApiDescriptions: {}, - hooksApiPageContents: {}, - }, - }; -}; From f6991377f63084a41931c77c274f79d9c411dc2b Mon Sep 17 00:00:00 2001 From: alexandre Date: Thu, 29 Jun 2023 17:03:27 +0200 Subject: [PATCH 48/85] fix position --- docs/src/modules/components/ApiPage/ApiItem.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index ac3229a5860ae1..47e585129b72ed 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -60,7 +60,7 @@ const Root = styled('div')( backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, }, '& .MuiApi-item-description': { - padding: '0 10px 6px 10px', + padding: '2px 10px 2px 10px', paddingBottom: 3, flexGrow: 1, textOverflow: 'ellipsis', From 50d7e1360aa3c7ffcf83187588035e9fc856ea59 Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Thu, 29 Jun 2023 14:04:41 -0300 Subject: [PATCH 49/85] style changes and simplifications + remove "
    " from caveat with refs sections --- .../modules/components/ApiPage/ApiItem.tsx | 40 +++++++++++++------ .../click-away-listener.json | 2 +- .../api-docs-base/focus-trap/focus-trap.json | 2 +- .../api-docs-base/modal/modal.json | 2 +- .../api-docs-joy/modal/modal.json | 2 +- .../api-docs/button-base/button-base-pt.json | 2 +- .../api-docs/button-base/button-base-zh.json | 2 +- .../api-docs/button-base/button-base.json | 2 +- .../click-away-listener-pt.json | 2 +- .../click-away-listener-zh.json | 2 +- .../click-away-listener.json | 2 +- .../api-docs/collapse/collapse-pt.json | 2 +- .../api-docs/collapse/collapse-zh.json | 2 +- .../api-docs/collapse/collapse.json | 2 +- docs/translations/api-docs/fade/fade-pt.json | 2 +- docs/translations/api-docs/fade/fade-zh.json | 2 +- docs/translations/api-docs/fade/fade.json | 2 +- .../api-docs/focus-trap/focus-trap-pt.json | 2 +- .../api-docs/focus-trap/focus-trap-zh.json | 2 +- .../api-docs/focus-trap/focus-trap.json | 2 +- docs/translations/api-docs/grow/grow-pt.json | 2 +- docs/translations/api-docs/grow/grow-zh.json | 2 +- docs/translations/api-docs/grow/grow.json | 2 +- .../api-docs/input-base/input-base-pt.json | 2 +- .../api-docs/input-base/input-base-zh.json | 2 +- .../api-docs/input-base/input-base.json | 2 +- docs/translations/api-docs/link/link-pt.json | 2 +- docs/translations/api-docs/link/link-zh.json | 2 +- docs/translations/api-docs/link/link.json | 2 +- .../api-docs/list-item/list-item-pt.json | 2 +- .../api-docs/list-item/list-item-zh.json | 2 +- .../api-docs/list-item/list-item.json | 2 +- .../translations/api-docs/modal/modal-pt.json | 2 +- .../translations/api-docs/modal/modal-zh.json | 2 +- docs/translations/api-docs/modal/modal.json | 2 +- .../translations/api-docs/slide/slide-pt.json | 2 +- .../translations/api-docs/slide/slide-zh.json | 2 +- docs/translations/api-docs/slide/slide.json | 2 +- .../api-docs/tooltip/tooltip-pt.json | 2 +- .../api-docs/tooltip/tooltip-zh.json | 2 +- .../api-docs/tooltip/tooltip.json | 2 +- .../api-docs/tree-item/tree-item-pt.json | 2 +- .../api-docs/tree-item/tree-item-zh.json | 2 +- .../api-docs/tree-item/tree-item.json | 2 +- docs/translations/api-docs/zoom/zoom-pt.json | 2 +- docs/translations/api-docs/zoom/zoom-zh.json | 2 +- docs/translations/api-docs/zoom/zoom.json | 2 +- 47 files changed, 73 insertions(+), 59 deletions(-) diff --git a/docs/src/modules/components/ApiPage/ApiItem.tsx b/docs/src/modules/components/ApiPage/ApiItem.tsx index 47e585129b72ed..2039aad025bd5e 100644 --- a/docs/src/modules/components/ApiPage/ApiItem.tsx +++ b/docs/src/modules/components/ApiPage/ApiItem.tsx @@ -106,6 +106,7 @@ const Root = styled('div')( fontWeight: theme.typography.fontWeightMedium, border: '1px solid', borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + borderRadius: 8, backgroundColor: `var(--muidocs-palette-warning-50, ${lightTheme.palette.warning[50]})`, color: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, marginBottom: 16, @@ -115,6 +116,17 @@ const Root = styled('div')( fill: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, }, }, + '& .prop-list-notes': { + ...theme.typography.body2, + fontWeight: theme.typography.fontWeightMedium, + padding: 12, + border: '1px solid', + borderColor: `var(--muidocs-palette-grey-200, ${lightTheme.palette.grey[200]})`, + borderRadius: 8, + backgroundColor: `var(--muidocs-palette-warning-50, ${lightTheme.palette.warning[50]})`, + color: `var(--muidocs-palette-warning-800, ${lightTheme.palette.warning[800]})`, + marginBottom: 16, + }, '& .prop-list-default-props': { ...theme.typography.body2, fontWeight: theme.typography.fontWeightMedium, @@ -143,13 +155,13 @@ const Root = styled('div')( }, '&>code': { borderRadius: 8, - padding: 8, + padding: 12, width: '100%', marginBottom: 8, - color: `var(--muidocs-palette-grey-900, ${lightTheme.palette.grey[900]})`, + color: `var(--muidocs-palette-grey-900, ${lightTheme.palette.grey[50]})`, border: '1px solid', - borderColor: `var(--muidocs-palette-grey-100, ${lightTheme.palette.grey[100]})`, - backgroundColor: `var(--muidocs-palette-primary-50, ${lightTheme.palette.primary[50]})`, + borderColor: `var(--muidocs-palette-primaryDark-700, ${lightTheme.palette.primaryDark[700]})`, + backgroundColor: `var(--muidocs-palette-primaryDark-800, ${lightTheme.palette.primaryDark[800]})`, }, }, marginBottom: 36, @@ -188,13 +200,18 @@ const Root = styled('div')( }, }, '& .MuiAlert-standardWarning': { - borderColor: alpha(darkTheme.palette.warning[600], 0.2), + borderColor: alpha(darkTheme.palette.grey[800], 0.5), backgroundColor: alpha(darkTheme.palette.warning[800], 0.2), color: `var(--muidocs-palette-warning-100, ${darkTheme.palette.warning[100]})`, '.MuiAlert-icon svg': { fill: `var(--muidocs-palette-warning-400, ${darkTheme.palette.warning[400]})`, }, }, + '& .prop-list-notes': { + borderColor: alpha(darkTheme.palette.grey[800], 0.5), + backgroundColor: alpha(darkTheme.palette.warning[800], 0.2), + color: `var(--muidocs-palette-warning-100, ${darkTheme.palette.warning[100]})`, + }, '& .prop-list-default-props': { color: `var(--muidocs-palette-grey-300, ${darkTheme.palette.grey[300]})`, code: { @@ -202,13 +219,6 @@ const Root = styled('div')( backgroundColor: alpha(darkTheme.palette.grey[900], 0.5), }, }, - '& .prop-list-signature': { - '&>code': { - color: `var(--muidocs-palette-grey-200, ${darkTheme.palette.grey[200]})`, - borderColor: `var(--muidocs-palette-divider, ${darkTheme.palette.divider})`, - backgroundColor: `var(--muidocs-palette-primaryDark-700, ${darkTheme.palette.primaryDark[700]})`, - }, - }, }, }), ); @@ -278,7 +288,11 @@ function ApiItem(props: ApiItemProps) { {isOverflow && (
    setIsExtended((prev) => !prev)}> - {isExtended ? : } + {isExtended ? ( + + ) : ( + + )}
    )} diff --git a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json index 9439b9aca8852e..96b948520f0369 100644 --- a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json +++ b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "The wrapped element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-base/focus-trap/focus-trap.json b/docs/translations/api-docs-base/focus-trap/focus-trap.json index ec3e41a7fedae6..fa4769294aae01 100644 --- a/docs/translations/api-docs-base/focus-trap/focus-trap.json +++ b/docs/translations/api-docs-base/focus-trap/focus-trap.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-base/modal/modal.json b/docs/translations/api-docs-base/modal/modal.json index 0358f1e7787c5c..8781566b074a1f 100644 --- a/docs/translations/api-docs-base/modal/modal.json +++ b/docs/translations/api-docs-base/modal/modal.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-joy/modal/modal.json b/docs/translations/api-docs-joy/modal/modal.json index 681838115ae4ac..f06daea216f23c 100644 --- a/docs/translations/api-docs-joy/modal/modal.json +++ b/docs/translations/api-docs-joy/modal/modal.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/button-base/button-base-pt.json b/docs/translations/api-docs/button-base/button-base-pt.json index 4f1a369669ca21..e4250e44e23d97 100644 --- a/docs/translations/api-docs/button-base/button-base-pt.json +++ b/docs/translations/api-docs/button-base/button-base-pt.json @@ -5,7 +5,7 @@ "centerRipple": "If true, the ripples are centered. They won't start at the cursor interaction position.", "children": "O conteúdo do componente.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "disabled": "Se true, o componente está desabilitado.", "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName.", "disableTouchRipple": "If true, the touch ripple effect is disabled.", diff --git a/docs/translations/api-docs/button-base/button-base-zh.json b/docs/translations/api-docs/button-base/button-base-zh.json index 453312b1f798dc..cbae6ace398b3b 100644 --- a/docs/translations/api-docs/button-base/button-base-zh.json +++ b/docs/translations/api-docs/button-base/button-base-zh.json @@ -5,7 +5,7 @@ "centerRipple": "If true, the ripples are centered. They won't start at the cursor interaction position.", "children": "The content of the component.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "disabled": "如果被设置为 true，那么该组件将会被禁用。", "disableRipple": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName.", "disableTouchRipple": "If true, the touch ripple effect is disabled.", diff --git a/docs/translations/api-docs/button-base/button-base.json b/docs/translations/api-docs/button-base/button-base.json index 2aaf0908055da4..3f97576b6494ac 100644 --- a/docs/translations/api-docs/button-base/button-base.json +++ b/docs/translations/api-docs/button-base/button-base.json @@ -27,7 +27,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/click-away-listener/click-away-listener-pt.json b/docs/translations/api-docs/click-away-listener/click-away-listener-pt.json index c8bc58934e332b..1814434e18907c 100644 --- a/docs/translations/api-docs/click-away-listener/click-away-listener-pt.json +++ b/docs/translations/api-docs/click-away-listener/click-away-listener-pt.json @@ -1,7 +1,7 @@ { "componentDescription": "Ouça eventos de clique que ocorram em algum lugar no documento, fora do próprio elemento.\nPor exemplo, se você precisar ocultar um menu quando as pessoas clicarem em qualquer outro lugar da sua página.", "propDescriptions": { - "children": "The wrapped element.
    ⚠️ Needs to be able to hold a ref.", + "children": "The wrapped element.⚠️ Needs to be able to hold a ref.", "disableReactTree": "Se true, a árvore React é ignorada e apenas a árvore DOM é considerada. Essa propriedade muda a forma como os elementos portáteis são tratados.", "mouseEvent": "O evento do mouse a escutar. Você pode desativar o ouvinte fornecendo false.", "onClickAway": "Callback fired when a "click away" event is detected.", diff --git a/docs/translations/api-docs/click-away-listener/click-away-listener-zh.json b/docs/translations/api-docs/click-away-listener/click-away-listener-zh.json index 2b75252afc3139..cc3b5c29062bb1 100644 --- a/docs/translations/api-docs/click-away-listener/click-away-listener-zh.json +++ b/docs/translations/api-docs/click-away-listener/click-away-listener-zh.json @@ -1,7 +1,7 @@ { "componentDescription": "Listen for click events that occur somewhere in the document, outside of the element itself.\nFor instance, if you need to hide a menu when people click anywhere else on your page.", "propDescriptions": { - "children": "The wrapped element.
    ⚠️ Needs to be able to hold a ref.", + "children": "The wrapped element.⚠️ Needs to be able to hold a ref.", "disableReactTree": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled.", "mouseEvent": "The mouse event to listen to. You can disable the listener by providing false.", "onClickAway": "Callback fired when a "click away" event is detected.", diff --git a/docs/translations/api-docs/click-away-listener/click-away-listener.json b/docs/translations/api-docs/click-away-listener/click-away-listener.json index 2b75252afc3139..cc3b5c29062bb1 100644 --- a/docs/translations/api-docs/click-away-listener/click-away-listener.json +++ b/docs/translations/api-docs/click-away-listener/click-away-listener.json @@ -1,7 +1,7 @@ { "componentDescription": "Listen for click events that occur somewhere in the document, outside of the element itself.\nFor instance, if you need to hide a menu when people click anywhere else on your page.", "propDescriptions": { - "children": "The wrapped element.
    ⚠️ Needs to be able to hold a ref.", + "children": "The wrapped element.⚠️ Needs to be able to hold a ref.", "disableReactTree": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled.", "mouseEvent": "The mouse event to listen to. You can disable the listener by providing false.", "onClickAway": "Callback fired when a "click away" event is detected.", diff --git a/docs/translations/api-docs/collapse/collapse-pt.json b/docs/translations/api-docs/collapse/collapse-pt.json index a9606ed621e1d9..7f7ec404995f24 100644 --- a/docs/translations/api-docs/collapse/collapse-pt.json +++ b/docs/translations/api-docs/collapse/collapse-pt.json @@ -5,7 +5,7 @@ "children": "The content node to be collapsed.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", "collapsedSize": "The width (horizontal) or height (vertical) of the container when collapsed.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "orientation": "The collapse transition orientation.", diff --git a/docs/translations/api-docs/collapse/collapse-zh.json b/docs/translations/api-docs/collapse/collapse-zh.json index ce4506ee5b5f2f..522643da8ab234 100644 --- a/docs/translations/api-docs/collapse/collapse-zh.json +++ b/docs/translations/api-docs/collapse/collapse-zh.json @@ -5,7 +5,7 @@ "children": "The content node to be collapsed.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "collapsedSize": "The width (horizontal) or height (vertical) of the container when collapsed.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "orientation": "The collapse transition orientation.", diff --git a/docs/translations/api-docs/collapse/collapse.json b/docs/translations/api-docs/collapse/collapse.json index b649ec61e99283..4765779d6488cb 100644 --- a/docs/translations/api-docs/collapse/collapse.json +++ b/docs/translations/api-docs/collapse/collapse.json @@ -27,7 +27,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/fade/fade-pt.json b/docs/translations/api-docs/fade/fade-pt.json index 0bba3e53438830..8f84c4c43f0669 100644 --- a/docs/translations/api-docs/fade/fade-pt.json +++ b/docs/translations/api-docs/fade/fade-pt.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." diff --git a/docs/translations/api-docs/fade/fade-zh.json b/docs/translations/api-docs/fade/fade-zh.json index ce8c51b8985a3e..50f3073ee85378 100644 --- a/docs/translations/api-docs/fade/fade-zh.json +++ b/docs/translations/api-docs/fade/fade-zh.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "如果被设置为 true，那么该组件将进行淡入淡出。", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." diff --git a/docs/translations/api-docs/fade/fade.json b/docs/translations/api-docs/fade/fade.json index 48a32c621a6f6a..24e12b5d5a96ef 100644 --- a/docs/translations/api-docs/fade/fade.json +++ b/docs/translations/api-docs/fade/fade.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/focus-trap/focus-trap-pt.json b/docs/translations/api-docs/focus-trap/focus-trap-pt.json index 999dd0d4670234..b65bd47eeca7f2 100644 --- a/docs/translations/api-docs/focus-trap/focus-trap-pt.json +++ b/docs/translations/api-docs/focus-trap/focus-trap-pt.json @@ -1,7 +1,7 @@ { "componentDescription": "Utility component that locks focus inside the component.", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "disableAutoFocus": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableEnforceFocus": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableRestoreFocus": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", diff --git a/docs/translations/api-docs/focus-trap/focus-trap-zh.json b/docs/translations/api-docs/focus-trap/focus-trap-zh.json index 999dd0d4670234..b65bd47eeca7f2 100644 --- a/docs/translations/api-docs/focus-trap/focus-trap-zh.json +++ b/docs/translations/api-docs/focus-trap/focus-trap-zh.json @@ -1,7 +1,7 @@ { "componentDescription": "Utility component that locks focus inside the component.", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "disableAutoFocus": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableEnforceFocus": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableRestoreFocus": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", diff --git a/docs/translations/api-docs/focus-trap/focus-trap.json b/docs/translations/api-docs/focus-trap/focus-trap.json index 999dd0d4670234..b65bd47eeca7f2 100644 --- a/docs/translations/api-docs/focus-trap/focus-trap.json +++ b/docs/translations/api-docs/focus-trap/focus-trap.json @@ -1,7 +1,7 @@ { "componentDescription": "Utility component that locks focus inside the component.", "propDescriptions": { - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "disableAutoFocus": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableEnforceFocus": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", "disableRestoreFocus": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", diff --git a/docs/translations/api-docs/grow/grow-pt.json b/docs/translations/api-docs/grow/grow-pt.json index beca0e5c5384f3..d7f688e8dc3baf 100644 --- a/docs/translations/api-docs/grow/grow-pt.json +++ b/docs/translations/api-docs/grow/grow-pt.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." diff --git a/docs/translations/api-docs/grow/grow-zh.json b/docs/translations/api-docs/grow/grow-zh.json index beca0e5c5384f3..d7f688e8dc3baf 100644 --- a/docs/translations/api-docs/grow/grow-zh.json +++ b/docs/translations/api-docs/grow/grow-zh.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." diff --git a/docs/translations/api-docs/grow/grow.json b/docs/translations/api-docs/grow/grow.json index d3219e2b83dca2..612ea4fb720a57 100644 --- a/docs/translations/api-docs/grow/grow.json +++ b/docs/translations/api-docs/grow/grow.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/input-base/input-base-pt.json b/docs/translations/api-docs/input-base/input-base-pt.json index 42d8ef08be2f26..0db7d7dd1b6179 100644 --- a/docs/translations/api-docs/input-base/input-base-pt.json +++ b/docs/translations/api-docs/input-base/input-base-pt.json @@ -14,7 +14,7 @@ "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", "fullWidth": "If true, the input will take up the full width of its container.", "id": "The id of the input element.", - "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "inputProps": "Attributes applied to the input element.", "inputRef": "Pass a ref to the input element.", "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", diff --git a/docs/translations/api-docs/input-base/input-base-zh.json b/docs/translations/api-docs/input-base/input-base-zh.json index 94bcf56ba31646..3a8b002cec683c 100644 --- a/docs/translations/api-docs/input-base/input-base-zh.json +++ b/docs/translations/api-docs/input-base/input-base-zh.json @@ -14,7 +14,7 @@ "error": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", "fullWidth": "If true, the input will take up the full width of its container.", "id": "The id of the input element.", - "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "inputComponent": "The component used for the input element. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "inputProps": "Attributes applied to the input element.", "inputRef": "Pass a ref to the input element.", "margin": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", diff --git a/docs/translations/api-docs/input-base/input-base.json b/docs/translations/api-docs/input-base/input-base.json index eb25764fed7a91..32befc4255d570 100644 --- a/docs/translations/api-docs/input-base/input-base.json +++ b/docs/translations/api-docs/input-base/input-base.json @@ -81,7 +81,7 @@ }, "inputComponent": { "description": "The component used for the input element. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/link/link-pt.json b/docs/translations/api-docs/link/link-pt.json index 3f6167826d8224..1097c1015e69b5 100644 --- a/docs/translations/api-docs/link/link-pt.json +++ b/docs/translations/api-docs/link/link-pt.json @@ -4,7 +4,7 @@ "children": "O conteúdo do componente.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", "color": "The color of the link.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "TypographyClasses": "classes prop applied to the Typography element.", "underline": "Controls when the link should have an underline.", diff --git a/docs/translations/api-docs/link/link-zh.json b/docs/translations/api-docs/link/link-zh.json index 94ae2e60f0dab1..6b859c09f9eec0 100644 --- a/docs/translations/api-docs/link/link-zh.json +++ b/docs/translations/api-docs/link/link-zh.json @@ -4,7 +4,7 @@ "children": "The content of the component.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "color": "The color of the link.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.
    ⚠️ Needs to be able to hold a ref.", + "component": "The component used for the root node. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref.", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.", "TypographyClasses": "classes prop applied to the Typography element.", "underline": "Controls when the link should have an underline.", diff --git a/docs/translations/api-docs/link/link.json b/docs/translations/api-docs/link/link.json index 2fa24c46d79eec..37935ad676cd86 100644 --- a/docs/translations/api-docs/link/link.json +++ b/docs/translations/api-docs/link/link.json @@ -21,7 +21,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/list-item/list-item-pt.json b/docs/translations/api-docs/list-item/list-item-pt.json index a4146ec8c9bdff..c839a312da0783 100644 --- a/docs/translations/api-docs/list-item/list-item-pt.json +++ b/docs/translations/api-docs/list-item/list-item-pt.json @@ -9,7 +9,7 @@ "component": "The component used for the root node. Either a string to use a HTML element or a component.", "components": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside the Input.", - "ContainerComponent": "The container component used when a ListItemSecondaryAction is the last child.
    ⚠️ Needs to be able to hold a ref.", + "ContainerComponent": "The container component used when a ListItemSecondaryAction is the last child.⚠️ Needs to be able to hold a ref.", "ContainerProps": "Props applied to the container component if used.", "dense": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", "disabled": "Se true, o componente está desabilitado.", diff --git a/docs/translations/api-docs/list-item/list-item-zh.json b/docs/translations/api-docs/list-item/list-item-zh.json index 30cc06499f33b1..0e9c4977a9f2d4 100644 --- a/docs/translations/api-docs/list-item/list-item-zh.json +++ b/docs/translations/api-docs/list-item/list-item-zh.json @@ -9,7 +9,7 @@ "component": "The component used for the root node. Either a string to use a HTML element or a component.", "components": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside the Input.", - "ContainerComponent": "The container component used when a ListItemSecondaryAction is the last child.
    ⚠️ Needs to be able to hold a ref.", + "ContainerComponent": "The container component used when a ListItemSecondaryAction is the last child.⚠️ Needs to be able to hold a ref.", "ContainerProps": "Props applied to the container component if used.", "dense": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", "disabled": "如果被设置为 true，那么该组件将会被禁用。", diff --git a/docs/translations/api-docs/list-item/list-item.json b/docs/translations/api-docs/list-item/list-item.json index 0811618d31322c..b3a6a4b84eb744 100644 --- a/docs/translations/api-docs/list-item/list-item.json +++ b/docs/translations/api-docs/list-item/list-item.json @@ -51,7 +51,7 @@ }, "ContainerComponent": { "description": "The container component used when a ListItemSecondaryAction is the last child.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/modal/modal-pt.json b/docs/translations/api-docs/modal/modal-pt.json index cc493614382887..2248772861acae 100644 --- a/docs/translations/api-docs/modal/modal-pt.json +++ b/docs/translations/api-docs/modal/modal-pt.json @@ -3,7 +3,7 @@ "propDescriptions": { "BackdropComponent": "A backdrop component. This prop enables custom backdrop rendering.", "BackdropProps": "Props applied to the Backdrop element.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", "closeAfterTransition": "When set to true the Modal waits until a nested Transition is completed before closing.", "component": "The component used for the root node. Either a string to use a HTML element or a component.", diff --git a/docs/translations/api-docs/modal/modal-zh.json b/docs/translations/api-docs/modal/modal-zh.json index 761e8d950fa9a1..c7e0f07b61c8aa 100644 --- a/docs/translations/api-docs/modal/modal-zh.json +++ b/docs/translations/api-docs/modal/modal-zh.json @@ -3,7 +3,7 @@ "propDescriptions": { "BackdropComponent": "A backdrop component. This prop enables custom backdrop rendering.", "BackdropProps": "Props applied to the Backdrop element.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "closeAfterTransition": "When set to true the Modal waits until a nested Transition is completed before closing.", "component": "The component used for the root node. Either a string to use a HTML element or a component.", diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index 5a7abd302ea498..d2e7bc32eef5e5 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/slide/slide-pt.json b/docs/translations/api-docs/slide/slide-pt.json index 0294acfbe2e031..0cd770899e5c7e 100644 --- a/docs/translations/api-docs/slide/slide-pt.json +++ b/docs/translations/api-docs/slide/slide-pt.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "container": "An HTML element, or a function that returns one. It's used to set the container the Slide is transitioning from.", "direction": "Direction the child node will enter from.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", diff --git a/docs/translations/api-docs/slide/slide-zh.json b/docs/translations/api-docs/slide/slide-zh.json index 0294acfbe2e031..0cd770899e5c7e 100644 --- a/docs/translations/api-docs/slide/slide-zh.json +++ b/docs/translations/api-docs/slide/slide-zh.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "container": "An HTML element, or a function that returns one. It's used to set the container the Slide is transitioning from.", "direction": "Direction the child node will enter from.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", diff --git a/docs/translations/api-docs/slide/slide.json b/docs/translations/api-docs/slide/slide.json index fa88901f9bfaa2..57f91339ed62d8 100644 --- a/docs/translations/api-docs/slide/slide.json +++ b/docs/translations/api-docs/slide/slide.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/tooltip/tooltip-pt.json b/docs/translations/api-docs/tooltip/tooltip-pt.json index d72373e0f4f17b..f834937f42a208 100644 --- a/docs/translations/api-docs/tooltip/tooltip-pt.json +++ b/docs/translations/api-docs/tooltip/tooltip-pt.json @@ -2,7 +2,7 @@ "componentDescription": "", "propDescriptions": { "arrow": "If true, adds an arrow to the tooltip.", - "children": "Tooltip reference element.
    ⚠️ Needs to be able to hold a ref.", + "children": "Tooltip reference element.⚠️ Needs to be able to hold a ref.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", "components": "The components used for each slot inside the Tooltip. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside the Tooltip. Note that componentsProps.popper prop values win over PopperProps and componentsProps.transition prop values win over TransitionProps if both are applied.", diff --git a/docs/translations/api-docs/tooltip/tooltip-zh.json b/docs/translations/api-docs/tooltip/tooltip-zh.json index e70bfd7f9f0eba..8be0ed8549feee 100644 --- a/docs/translations/api-docs/tooltip/tooltip-zh.json +++ b/docs/translations/api-docs/tooltip/tooltip-zh.json @@ -2,7 +2,7 @@ "componentDescription": "", "propDescriptions": { "arrow": "If true, adds an arrow to the tooltip.", - "children": "Tooltip reference element.
    ⚠️ Needs to be able to hold a ref.", + "children": "Tooltip reference element.⚠️ Needs to be able to hold a ref.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "components": "The components used for each slot inside the Tooltip. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside the Tooltip. Note that componentsProps.popper prop values win over PopperProps and componentsProps.transition prop values win over TransitionProps if both are applied.", diff --git a/docs/translations/api-docs/tooltip/tooltip.json b/docs/translations/api-docs/tooltip/tooltip.json index ef67ada5cc98f5..5e5f0e8a34f9e5 100644 --- a/docs/translations/api-docs/tooltip/tooltip.json +++ b/docs/translations/api-docs/tooltip/tooltip.json @@ -9,7 +9,7 @@ }, "children": { "description": "Tooltip reference element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/tree-item/tree-item-pt.json b/docs/translations/api-docs/tree-item/tree-item-pt.json index 0536f2301f9d46..79723327db8dfb 100644 --- a/docs/translations/api-docs/tree-item/tree-item-pt.json +++ b/docs/translations/api-docs/tree-item/tree-item-pt.json @@ -4,7 +4,7 @@ "children": "O conteúdo do componente.", "classes": "Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.", "collapseIcon": "The icon used to collapse the node.", - "ContentComponent": "The component used for the content node.
    ⚠️ Needs to be able to hold a ref.", + "ContentComponent": "The component used for the content node.⚠️ Needs to be able to hold a ref.", "ContentProps": "Props applied to ContentComponent", "disabled": "If true, the node is disabled.", "endIcon": "The icon displayed next to a end node.", diff --git a/docs/translations/api-docs/tree-item/tree-item-zh.json b/docs/translations/api-docs/tree-item/tree-item-zh.json index 609a2cdf3afde2..597760a3bfb742 100644 --- a/docs/translations/api-docs/tree-item/tree-item-zh.json +++ b/docs/translations/api-docs/tree-item/tree-item-zh.json @@ -4,7 +4,7 @@ "children": "The content of the component.", "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", "collapseIcon": "The icon used to collapse the node.", - "ContentComponent": "The component used for the content node.
    ⚠️ Needs to be able to hold a ref.", + "ContentComponent": "The component used for the content node.⚠️ Needs to be able to hold a ref.", "ContentProps": "Props applied to ContentComponent", "disabled": "If true, the node is disabled.", "endIcon": "The icon displayed next to a end node.", diff --git a/docs/translations/api-docs/tree-item/tree-item.json b/docs/translations/api-docs/tree-item/tree-item.json index 4daf5c54df3679..da395eb1b9f7b0 100644 --- a/docs/translations/api-docs/tree-item/tree-item.json +++ b/docs/translations/api-docs/tree-item/tree-item.json @@ -21,7 +21,7 @@ }, "ContentComponent": { "description": "The component used for the content node.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/zoom/zoom-pt.json b/docs/translations/api-docs/zoom/zoom-pt.json index 429bad110723a9..032f9c59c9a2ab 100644 --- a/docs/translations/api-docs/zoom/zoom-pt.json +++ b/docs/translations/api-docs/zoom/zoom-pt.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." diff --git a/docs/translations/api-docs/zoom/zoom-zh.json b/docs/translations/api-docs/zoom/zoom-zh.json index 429bad110723a9..032f9c59c9a2ab 100644 --- a/docs/translations/api-docs/zoom/zoom-zh.json +++ b/docs/translations/api-docs/zoom/zoom-zh.json @@ -3,7 +3,7 @@ "propDescriptions": { "addEndListener": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", "appear": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "children": "A single child content element.
    ⚠️ Needs to be able to hold a ref.", + "children": "A single child content element.⚠️ Needs to be able to hold a ref.", "easing": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", "in": "If true, the component will transition in.", "timeout": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." diff --git a/docs/translations/api-docs/zoom/zoom.json b/docs/translations/api-docs/zoom/zoom.json index a94d622cd966aa..08802cfacb3ff3 100644 --- a/docs/translations/api-docs/zoom/zoom.json +++ b/docs/translations/api-docs/zoom/zoom.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", + "notes": "⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, From ca5f88297653bb94266902ed198c51a6fb72ea47 Mon Sep 17 00:00:00 2001 From: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Date: Thu, 29 Jun 2023 14:46:28 -0300 Subject: [PATCH 50/85] yarn docs:api --- .../react-accordion/[docsTab]/index.js | 32 +++++++++++++++++++ .../react-all-components/[docsTab]/index.js | 32 +++++++++++++++++++ .../base-ui/react-all-components/index.js | 13 ++++++++ .../base-ui/react-checkbox/[docsTab]/index.js | 32 +++++++++++++++++++ .../react-radio-button/[docsTab]/index.js | 32 +++++++++++++++++++ .../click-away-listener.json | 2 +- .../api-docs-base/focus-trap/focus-trap.json | 2 +- .../api-docs-base/modal/modal.json | 2 +- .../api-docs-joy/modal/modal.json | 2 +- .../api-docs/button-base/button-base.json | 2 +- .../api-docs/collapse/collapse.json | 2 +- docs/translations/api-docs/fade/fade.json | 2 +- docs/translations/api-docs/grow/grow.json | 2 +- .../api-docs/input-base/input-base.json | 2 +- docs/translations/api-docs/link/link.json | 2 +- .../api-docs/list-item/list-item.json | 2 +- docs/translations/api-docs/modal/modal.json | 2 +- docs/translations/api-docs/slide/slide.json | 2 +- .../api-docs/tooltip/tooltip.json | 2 +- .../api-docs/tree-item/tree-item.json | 2 +- docs/translations/api-docs/zoom/zoom.json | 2 +- 21 files changed, 157 insertions(+), 16 deletions(-) create mode 100644 docs/pages/base-ui/react-accordion/[docsTab]/index.js create mode 100644 docs/pages/base-ui/react-all-components/[docsTab]/index.js create mode 100644 docs/pages/base-ui/react-all-components/index.js create mode 100644 docs/pages/base-ui/react-checkbox/[docsTab]/index.js create mode 100644 docs/pages/base-ui/react-radio-button/[docsTab]/index.js diff --git a/docs/pages/base-ui/react-accordion/[docsTab]/index.js b/docs/pages/base-ui/react-accordion/[docsTab]/index.js new file mode 100644 index 00000000000000..f3a0251d3e856c --- /dev/null +++ b/docs/pages/base-ui/react-accordion/[docsTab]/index.js @@ -0,0 +1,32 @@ +import * as React from 'react'; +import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; +import AppFrame from 'docs/src/modules/components/AppFrame'; +import * as pageProps from 'docs/data/base/components/accordion/accordion.md?@mui/markdown'; +import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; + +export default function Page(props) { + const { userLanguage, ...other } = props; + return ; +} + +Page.getLayout = (page) => { + return {page}; +}; + +export const getStaticPaths = () => { + return { + paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], + fallback: false, // can also be true or 'blocking' + }; +}; + +export const getStaticProps = () => { + return { + props: { + componentsApiDescriptions: {}, + componentsApiPageContents: {}, + hooksApiDescriptions: {}, + hooksApiPageContents: {}, + }, + }; +}; diff --git a/docs/pages/base-ui/react-all-components/[docsTab]/index.js b/docs/pages/base-ui/react-all-components/[docsTab]/index.js new file mode 100644 index 00000000000000..f8c44f11d77ff4 --- /dev/null +++ b/docs/pages/base-ui/react-all-components/[docsTab]/index.js @@ -0,0 +1,32 @@ +import * as React from 'react'; +import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; +import AppFrame from 'docs/src/modules/components/AppFrame'; +import * as pageProps from 'docs/data/base/components/all-components/all-components.md?@mui/markdown'; +import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; + +export default function Page(props) { + const { userLanguage, ...other } = props; + return ; +} + +Page.getLayout = (page) => { + return {page}; +}; + +export const getStaticPaths = () => { + return { + paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], + fallback: false, // can also be true or 'blocking' + }; +}; + +export const getStaticProps = () => { + return { + props: { + componentsApiDescriptions: {}, + componentsApiPageContents: {}, + hooksApiDescriptions: {}, + hooksApiPageContents: {}, + }, + }; +}; diff --git a/docs/pages/base-ui/react-all-components/index.js b/docs/pages/base-ui/react-all-components/index.js new file mode 100644 index 00000000000000..2bb2c253929f6b --- /dev/null +++ b/docs/pages/base-ui/react-all-components/index.js @@ -0,0 +1,13 @@ +import * as React from 'react'; +import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; +import AppFrame from 'docs/src/modules/components/AppFrame'; +import * as pageProps from 'docs/data/base/components/all-components/all-components.md?@mui/markdown'; + +export default function Page(props) { + const { userLanguage, ...other } = props; + return ; +} + +Page.getLayout = (page) => { + return {page}; +}; diff --git a/docs/pages/base-ui/react-checkbox/[docsTab]/index.js b/docs/pages/base-ui/react-checkbox/[docsTab]/index.js new file mode 100644 index 00000000000000..d126a7fbfce6c7 --- /dev/null +++ b/docs/pages/base-ui/react-checkbox/[docsTab]/index.js @@ -0,0 +1,32 @@ +import * as React from 'react'; +import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; +import AppFrame from 'docs/src/modules/components/AppFrame'; +import * as pageProps from 'docs/data/base/components/checkbox/checkbox.md?@mui/markdown'; +import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; + +export default function Page(props) { + const { userLanguage, ...other } = props; + return ; +} + +Page.getLayout = (page) => { + return {page}; +}; + +export const getStaticPaths = () => { + return { + paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], + fallback: false, // can also be true or 'blocking' + }; +}; + +export const getStaticProps = () => { + return { + props: { + componentsApiDescriptions: {}, + componentsApiPageContents: {}, + hooksApiDescriptions: {}, + hooksApiPageContents: {}, + }, + }; +}; diff --git a/docs/pages/base-ui/react-radio-button/[docsTab]/index.js b/docs/pages/base-ui/react-radio-button/[docsTab]/index.js new file mode 100644 index 00000000000000..896c61aa04a6a5 --- /dev/null +++ b/docs/pages/base-ui/react-radio-button/[docsTab]/index.js @@ -0,0 +1,32 @@ +import * as React from 'react'; +import MarkdownDocs from 'docs/src/modules/components/MarkdownDocsV2'; +import AppFrame from 'docs/src/modules/components/AppFrame'; +import * as pageProps from 'docs/data/base/components/radio-button/radio-button.md?@mui/markdown'; +import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; + +export default function Page(props) { + const { userLanguage, ...other } = props; + return ; +} + +Page.getLayout = (page) => { + return {page}; +}; + +export const getStaticPaths = () => { + return { + paths: [{ params: { docsTab: 'components-api' } }, { params: { docsTab: 'hooks-api' } }], + fallback: false, // can also be true or 'blocking' + }; +}; + +export const getStaticProps = () => { + return { + props: { + componentsApiDescriptions: {}, + componentsApiPageContents: {}, + hooksApiDescriptions: {}, + hooksApiPageContents: {}, + }, + }; +}; diff --git a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json index 96b948520f0369..9439b9aca8852e 100644 --- a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json +++ b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "The wrapped element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-base/focus-trap/focus-trap.json b/docs/translations/api-docs-base/focus-trap/focus-trap.json index fa4769294aae01..ec3e41a7fedae6 100644 --- a/docs/translations/api-docs-base/focus-trap/focus-trap.json +++ b/docs/translations/api-docs-base/focus-trap/focus-trap.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-base/modal/modal.json b/docs/translations/api-docs-base/modal/modal.json index 8781566b074a1f..0358f1e7787c5c 100644 --- a/docs/translations/api-docs-base/modal/modal.json +++ b/docs/translations/api-docs-base/modal/modal.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs-joy/modal/modal.json b/docs/translations/api-docs-joy/modal/modal.json index f06daea216f23c..681838115ae4ac 100644 --- a/docs/translations/api-docs-joy/modal/modal.json +++ b/docs/translations/api-docs-joy/modal/modal.json @@ -3,7 +3,7 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/button-base/button-base.json b/docs/translations/api-docs/button-base/button-base.json index 3f97576b6494ac..2aaf0908055da4 100644 --- a/docs/translations/api-docs/button-base/button-base.json +++ b/docs/translations/api-docs/button-base/button-base.json @@ -27,7 +27,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/collapse/collapse.json b/docs/translations/api-docs/collapse/collapse.json index 4765779d6488cb..b649ec61e99283 100644 --- a/docs/translations/api-docs/collapse/collapse.json +++ b/docs/translations/api-docs/collapse/collapse.json @@ -27,7 +27,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/fade/fade.json b/docs/translations/api-docs/fade/fade.json index 24e12b5d5a96ef..48a32c621a6f6a 100644 --- a/docs/translations/api-docs/fade/fade.json +++ b/docs/translations/api-docs/fade/fade.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/grow/grow.json b/docs/translations/api-docs/grow/grow.json index 612ea4fb720a57..d3219e2b83dca2 100644 --- a/docs/translations/api-docs/grow/grow.json +++ b/docs/translations/api-docs/grow/grow.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/input-base/input-base.json b/docs/translations/api-docs/input-base/input-base.json index 32befc4255d570..eb25764fed7a91 100644 --- a/docs/translations/api-docs/input-base/input-base.json +++ b/docs/translations/api-docs/input-base/input-base.json @@ -81,7 +81,7 @@ }, "inputComponent": { "description": "The component used for the input element. Either a string to use a HTML element or a component.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/link/link.json b/docs/translations/api-docs/link/link.json index 37935ad676cd86..2fa24c46d79eec 100644 --- a/docs/translations/api-docs/link/link.json +++ b/docs/translations/api-docs/link/link.json @@ -21,7 +21,7 @@ }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/list-item/list-item.json b/docs/translations/api-docs/list-item/list-item.json index b3a6a4b84eb744..0811618d31322c 100644 --- a/docs/translations/api-docs/list-item/list-item.json +++ b/docs/translations/api-docs/list-item/list-item.json @@ -51,7 +51,7 @@ }, "ContainerComponent": { "description": "The container component used when a ListItemSecondaryAction is the last child.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index d2e7bc32eef5e5..5a7abd302ea498 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/slide/slide.json b/docs/translations/api-docs/slide/slide.json index 57f91339ed62d8..fa88901f9bfaa2 100644 --- a/docs/translations/api-docs/slide/slide.json +++ b/docs/translations/api-docs/slide/slide.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/tooltip/tooltip.json b/docs/translations/api-docs/tooltip/tooltip.json index 5e5f0e8a34f9e5..ef67ada5cc98f5 100644 --- a/docs/translations/api-docs/tooltip/tooltip.json +++ b/docs/translations/api-docs/tooltip/tooltip.json @@ -9,7 +9,7 @@ }, "children": { "description": "Tooltip reference element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/tree-item/tree-item.json b/docs/translations/api-docs/tree-item/tree-item.json index da395eb1b9f7b0..4daf5c54df3679 100644 --- a/docs/translations/api-docs/tree-item/tree-item.json +++ b/docs/translations/api-docs/tree-item/tree-item.json @@ -21,7 +21,7 @@ }, "ContentComponent": { "description": "The component used for the content node.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, diff --git a/docs/translations/api-docs/zoom/zoom.json b/docs/translations/api-docs/zoom/zoom.json index 08802cfacb3ff3..a94d622cd966aa 100644 --- a/docs/translations/api-docs/zoom/zoom.json +++ b/docs/translations/api-docs/zoom/zoom.json @@ -15,7 +15,7 @@ }, "children": { "description": "A single child content element.", - "notes": "⚠️ Needs to be able to hold a ref.", + "notes": "
    ⚠️ Needs to be able to hold a ref.", "deprecated": "", "typeDescriptions": {} }, From 004d812a64e17847c2c7df55dcdd9b38f46a5847 Mon Sep 17 00:00:00 2001 From: alexandre Date: Fri, 30 Jun 2023 09:12:29 +0200 Subject: [PATCH 51/85] remove unused object properties --- .../api-docs-base/badge/badge.json | 45 +-- .../api-docs-base/button/button.json | 29 +- .../click-away-listener.json | 24 +- .../api-docs-base/focus-trap/focus-trap.json | 36 +- .../form-control/form-control.json | 50 +-- .../api-docs-base/input/input.json | 119 ++----- .../api-docs-base/menu-item/menu-item.json | 17 +- .../translations/api-docs-base/menu/menu.json | 39 +-- .../api-docs-base/modal/modal.json | 100 +----- .../api-docs-base/no-ssr/no-ssr.json | 19 +- .../option-group/option-group.json | 24 +- .../api-docs-base/option/option.json | 31 +- .../api-docs-base/popper/popper.json | 82 +---- .../api-docs-base/portal/portal.json | 17 +- .../api-docs-base/select/select.json | 95 +----- .../api-docs-base/slider/slider.json | 122 ++----- .../api-docs-base/snackbar/snackbar.json | 41 +-- .../api-docs-base/switch/switch.json | 45 +-- .../api-docs-base/tab-panel/tab-panel.json | 24 +- docs/translations/api-docs-base/tab/tab.json | 36 +- .../table-pagination/table-pagination.json | 64 +--- .../api-docs-base/tabs-list/tabs-list.json | 19 +- .../translations/api-docs-base/tabs/tabs.json | 55 +--- .../textarea-autosize/textarea-autosize.json | 14 +- .../api-docs-joy/alert/alert.json | 67 +--- .../aspect-ratio/aspect-ratio.json | 61 +--- .../autocomplete-listbox.json | 41 +-- .../autocomplete-option.json | 34 +- .../autocomplete/autocomplete.json | 253 +++------------ .../avatar-group/avatar-group.json | 44 +-- .../api-docs-joy/avatar/avatar.json | 61 +--- .../api-docs-joy/badge/badge.json | 86 +---- .../api-docs-joy/breadcrumbs/breadcrumbs.json | 43 +-- .../button-group/button-group.json | 70 +--- .../api-docs-joy/button/button.json | 89 +---- .../card-actions/card-actions.json | 43 +-- .../card-content/card-content.json | 36 +- .../api-docs-joy/card-cover/card-cover.json | 29 +- .../card-overflow/card-overflow.json | 39 +-- docs/translations/api-docs-joy/card/card.json | 56 +--- .../api-docs-joy/checkbox/checkbox.json | 134 ++------ .../api-docs-joy/chip-delete/chip-delete.json | 51 +-- docs/translations/api-docs-joy/chip/chip.json | 74 +---- .../circular-progress/circular-progress.json | 56 +--- .../css-baseline/css-baseline.json | 12 +- .../api-docs-joy/divider/divider.json | 43 +-- .../form-control/form-control.json | 69 +--- .../form-helper-text/form-helper-text.json | 31 +- .../api-docs-joy/form-label/form-label.json | 38 +-- .../api-docs-joy/icon-button/icon-button.json | 58 +--- .../api-docs-joy/input/input.json | 53 +-- .../linear-progress/linear-progress.json | 56 +--- docs/translations/api-docs-joy/link/link.json | 94 +----- .../list-divider/list-divider.json | 43 +-- .../list-item-button/list-item-button.json | 77 +---- .../list-item-content/list-item-content.json | 31 +- .../list-item-decorator.json | 31 +- .../api-docs-joy/list-item/list-item.json | 67 +--- .../list-subheader/list-subheader.json | 46 +-- docs/translations/api-docs-joy/list/list.json | 60 +--- .../api-docs-joy/menu-item/menu-item.json | 45 +-- .../api-docs-joy/menu-list/menu-list.json | 49 +-- docs/translations/api-docs-joy/menu/menu.json | 88 +---- .../api-docs-joy/modal-close/modal-close.json | 41 +-- .../modal-dialog/modal-dialog.json | 55 +--- .../modal-overflow/modal-overflow.json | 5 +- .../api-docs-joy/modal/modal.json | 86 +---- .../api-docs-joy/option/option.json | 60 +--- .../api-docs-joy/radio-group/radio-group.json | 82 +---- .../api-docs-joy/radio/radio.json | 126 ++----- .../scoped-css-baseline.json | 36 +- .../api-docs-joy/select/select.json | 138 ++------ .../api-docs-joy/sheet/sheet.json | 46 +-- .../api-docs-joy/slider/slider.json | 156 ++------- .../api-docs-joy/stack/stack.json | 41 +-- .../api-docs-joy/svg-icon/svg-icon.json | 68 +--- .../api-docs-joy/switch/switch.json | 88 +---- .../api-docs-joy/tab-list/tab-list.json | 46 +-- .../api-docs-joy/tab-panel/tab-panel.json | 43 +-- docs/translations/api-docs-joy/tab/tab.json | 65 +--- .../api-docs-joy/table/table.json | 80 +---- docs/translations/api-docs-joy/tabs/tabs.json | 84 +---- .../api-docs-joy/textarea/textarea.json | 55 +--- .../api-docs-joy/tooltip/tooltip.json | 166 ++-------- .../api-docs-joy/typography/typography.json | 86 +---- .../accordion-actions/accordion-actions.json | 24 +- .../accordion-details/accordion-details.json | 19 +- .../accordion-summary/accordion-summary.json | 31 +- .../api-docs/accordion/accordion.json | 62 +--- .../api-docs/alert-title/alert-title.json | 19 +- docs/translations/api-docs/alert/alert.json | 87 +---- .../api-docs/app-bar/app-bar.json | 34 +- .../api-docs/autocomplete/autocomplete.json | 307 +++--------------- .../api-docs/avatar-group/avatar-group.json | 60 +--- docs/translations/api-docs/avatar/avatar.json | 56 +--- .../api-docs/backdrop/backdrop.json | 66 +--- docs/translations/api-docs/badge/badge.json | 100 +----- .../bottom-navigation-action.json | 41 +-- .../bottom-navigation/bottom-navigation.json | 36 +- docs/translations/api-docs/box/box.json | 10 +- .../api-docs/breadcrumbs/breadcrumbs.json | 63 +--- .../api-docs/button-base/button-base.json | 82 +---- .../api-docs/button-group/button-group.json | 79 +---- docs/translations/api-docs/button/button.json | 91 +----- .../card-action-area/card-action-area.json | 19 +- .../api-docs/card-actions/card-actions.json | 24 +- .../api-docs/card-content/card-content.json | 24 +- .../api-docs/card-header/card-header.json | 60 +--- .../api-docs/card-media/card-media.json | 34 +- docs/translations/api-docs/card/card.json | 26 +- .../api-docs/checkbox/checkbox.json | 103 +----- docs/translations/api-docs/chip/chip.json | 91 +----- .../circular-progress/circular-progress.json | 44 +-- .../api-docs/collapse/collapse.json | 57 +--- .../api-docs/container/container.json | 32 +- .../api-docs/css-baseline/css-baseline.json | 12 +- .../dialog-actions/dialog-actions.json | 24 +- .../dialog-content-text.json | 19 +- .../dialog-content/dialog-content.json | 26 +- .../api-docs/dialog-title/dialog-title.json | 19 +- docs/translations/api-docs/dialog/dialog.json | 110 +------ .../api-docs/divider/divider.json | 64 +--- docs/translations/api-docs/drawer/drawer.json | 78 +---- docs/translations/api-docs/fab/fab.json | 65 +--- docs/translations/api-docs/fade/fade.json | 31 +- .../api-docs/filled-input/filled-input.json | 176 ++-------- .../form-control-label.json | 85 +---- .../api-docs/form-control/form-control.json | 80 +---- .../api-docs/form-group/form-group.json | 26 +- .../form-helper-text/form-helper-text.json | 59 +--- .../api-docs/form-label/form-label.json | 58 +--- .../api-docs/global-styles/global-styles.json | 9 +- docs/translations/api-docs/grid/grid.json | 99 ++---- docs/translations/api-docs/grow/grow.json | 31 +- docs/translations/api-docs/hidden/hidden.json | 74 +---- .../api-docs/icon-button/icon-button.json | 51 +-- docs/translations/api-docs/icon/icon.json | 39 +-- .../image-list-item-bar.json | 45 +-- .../image-list-item/image-list-item.json | 36 +- .../api-docs/image-list/image-list.json | 50 +-- .../input-adornment/input-adornment.json | 42 +-- .../api-docs/input-base/input-base.json | 187 ++--------- .../api-docs/input-label/input-label.json | 81 +---- docs/translations/api-docs/input/input.json | 171 ++-------- .../linear-progress/linear-progress.json | 34 +- docs/translations/api-docs/link/link.json | 49 +-- .../list-item-avatar/list-item-avatar.json | 19 +- .../list-item-button/list-item-button.json | 68 +--- .../list-item-icon/list-item-icon.json | 17 +- .../list-item-secondary-action.json | 17 +- .../list-item-text/list-item-text.json | 53 +-- .../api-docs/list-item/list-item.json | 113 ++----- .../list-subheader/list-subheader.json | 46 +-- docs/translations/api-docs/list/list.json | 39 +-- .../loading-button/loading-button.json | 52 +-- .../api-docs/masonry/masonry.json | 53 +-- .../api-docs/menu-item/menu-item.json | 56 +--- .../api-docs/menu-list/menu-list.json | 32 +- docs/translations/api-docs/menu/menu.json | 68 +--- .../mobile-stepper/mobile-stepper.json | 53 +-- docs/translations/api-docs/modal/modal.json | 137 ++------ .../api-docs/native-select/native-select.json | 52 +-- .../outlined-input/outlined-input.json | 166 ++-------- .../pagination-item/pagination-item.json | 83 +---- .../api-docs/pagination/pagination.json | 110 +------ docs/translations/api-docs/paper/paper.json | 43 +-- .../api-docs/popover/popover.json | 110 ++----- docs/translations/api-docs/popper/popper.json | 97 +----- .../api-docs/radio-group/radio-group.json | 24 +- docs/translations/api-docs/radio/radio.json | 97 +----- docs/translations/api-docs/rating/rating.json | 105 +----- .../scoped-css-baseline.json | 29 +- docs/translations/api-docs/select/select.json | 118 ++----- .../api-docs/skeleton/skeleton.json | 46 +-- docs/translations/api-docs/slide/slide.json | 43 +-- docs/translations/api-docs/slider/slider.json | 156 ++------- .../snackbar-content/snackbar-content.json | 31 +- .../api-docs/snackbar/snackbar.json | 90 +---- .../speed-dial-action/speed-dial-action.json | 67 +--- .../speed-dial-icon/speed-dial-icon.json | 24 +- .../api-docs/speed-dial/speed-dial.json | 75 +---- docs/translations/api-docs/stack/stack.json | 41 +-- .../api-docs/step-button/step-button.json | 31 +- .../step-connector/step-connector.json | 12 +- .../api-docs/step-content/step-content.json | 34 +- .../api-docs/step-icon/step-icon.json | 40 +-- .../api-docs/step-label/step-label.json | 64 +--- docs/translations/api-docs/step/step.json | 58 +--- .../api-docs/stepper/stepper.json | 53 +-- .../api-docs/svg-icon/svg-icon.json | 61 +--- .../swipeable-drawer/swipeable-drawer.json | 63 +--- docs/translations/api-docs/switch/switch.json | 98 +----- .../api-docs/tab-context/tab-context.json | 14 +- .../api-docs/tab-list/tab-list.json | 7 +- .../api-docs/tab-panel/tab-panel.json | 24 +- .../tab-scroll-button/tab-scroll-button.json | 52 +-- docs/translations/api-docs/tab/tab.json | 65 +--- .../api-docs/table-body/table-body.json | 24 +- .../api-docs/table-cell/table-cell.json | 58 +--- .../table-container/table-container.json | 24 +- .../api-docs/table-footer/table-footer.json | 24 +- .../api-docs/table-head/table-head.json | 24 +- .../table-pagination/table-pagination.json | 89 +---- .../api-docs/table-row/table-row.json | 34 +- .../table-sort-label/table-sort-label.json | 45 +-- docs/translations/api-docs/table/table.json | 41 +-- docs/translations/api-docs/tabs/tabs.json | 130 ++------ .../api-docs/text-field/text-field.json | 179 ++-------- .../timeline-connector.json | 19 +- .../timeline-content/timeline-content.json | 19 +- .../api-docs/timeline-dot/timeline-dot.json | 33 +- .../api-docs/timeline-item/timeline-item.json | 26 +- .../timeline-opposite-content.json | 19 +- .../timeline-separator.json | 19 +- .../api-docs/timeline/timeline.json | 31 +- .../toggle-button-group.json | 60 +--- .../api-docs/toggle-button/toggle-button.json | 65 +--- .../api-docs/toolbar/toolbar.json | 36 +- .../api-docs/tooltip/tooltip.json | 154 ++------- .../api-docs/tree-item/tree-item.json | 96 +----- .../api-docs/tree-view/tree-view.json | 95 +----- .../api-docs/typography/typography.json | 60 +--- docs/translations/api-docs/zoom/zoom.json | 31 +- .../ApiBuilders/ComponentApiBuilder.ts | 6 +- 224 files changed, 2281 insertions(+), 11135 deletions(-) diff --git a/docs/translations/api-docs-base/badge/badge.json b/docs/translations/api-docs-base/badge/badge.json index 329d4aa0279840..99a4f1a453c504 100644 --- a/docs/translations/api-docs-base/badge/badge.json +++ b/docs/translations/api-docs-base/badge/badge.json @@ -1,47 +1,16 @@ { "componentDescription": "", "propDescriptions": { - "badgeContent": { - "description": "The content rendered within the badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The badge will be added relative to this node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "invisible": { - "description": "If true, the badge is invisible.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "max": { - "description": "Max count to show.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "badgeContent": { "description": "The content rendered within the badge." }, + "children": { "description": "The badge will be added relative to this node." }, + "invisible": { "description": "If true, the badge is invisible." }, + "max": { "description": "Max count to show." }, "showZero": { - "description": "Controls whether the badge is hidden when badgeContent is zero.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Controls whether the badge is hidden when badgeContent is zero." }, + "slotProps": { "description": "The props used for each slot inside the Badge." }, "slots": { - "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/button/button.json b/docs/translations/api-docs-base/button/button.json index 984d5272861b1c..f93ffba484053d 100644 --- a/docs/translations/api-docs-base/button/button.json +++ b/docs/translations/api-docs-base/button/button.json @@ -2,34 +2,15 @@ "componentDescription": "The foundation for building custom-styled buttons.", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, + "disabled": { "description": "If true, the component is disabled." }, "focusableWhenDisabled": { - "description": "If true, allows a disabled button to receive focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Button.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, allows a disabled button to receive focus." }, + "slotProps": { "description": "The props used for each slot inside the Button." }, "slots": { - "description": "The components used for each slot inside the Button. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Button. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json index 9439b9aca8852e..2599ccd199b1cf 100644 --- a/docs/translations/api-docs-base/click-away-listener/click-away-listener.json +++ b/docs/translations/api-docs-base/click-away-listener/click-away-listener.json @@ -3,33 +3,19 @@ "propDescriptions": { "children": { "description": "The wrapped element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "disableReactTree": { - "description": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the React tree is ignored and only the DOM tree is considered. This prop changes how portaled elements are handled." }, "mouseEvent": { - "description": "The mouse event to listen to. You can disable the listener by providing false.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The mouse event to listen to. You can disable the listener by providing false." }, "onClickAway": { - "description": "Callback fired when a "click away" event is detected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when a "click away" event is detected." }, "touchEvent": { - "description": "The touch event to listen to. You can disable the listener by providing false.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The touch event to listen to. You can disable the listener by providing false." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs-base/focus-trap/focus-trap.json b/docs/translations/api-docs-base/focus-trap/focus-trap.json index ec3e41a7fedae6..d7cad5f53ab01c 100644 --- a/docs/translations/api-docs-base/focus-trap/focus-trap.json +++ b/docs/translations/api-docs-base/focus-trap/focus-trap.json @@ -3,46 +3,24 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "disableAutoFocus": { - "description": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers." }, "disableEnforceFocus": { - "description": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the focus trap will not prevent focus from leaving the focus trap while open.
    Generally this should never be set to true as it makes the focus trap less accessible to assistive technologies, like screen readers." }, "disableRestoreFocus": { - "description": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted." }, "getTabbable": { - "description": "Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency." }, "isEnabled": { - "description": "This prop extends the open prop. It allows to toggle the open state without having to wait for a rerender when changing the open prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop extends the open prop. It allows to toggle the open state without having to wait for a rerender when changing the open prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time." }, - "open": { - "description": "If true, focus is locked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "open": { "description": "If true, focus is locked." } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/form-control/form-control.json b/docs/translations/api-docs-base/form-control/form-control.json index 6efe0f0edbc06b..c3ede80c3a4983 100644 --- a/docs/translations/api-docs-base/form-control/form-control.json +++ b/docs/translations/api-docs-base/form-control/form-control.json @@ -1,54 +1,20 @@ { "componentDescription": "Provides context such as filled/focused/error/required for form inputs.\nRelying on the context provides high flexibility and ensures that the state always stays\nconsistent across the children of the `FormControl`.\nThis context is used by the following components:\n\n* FormLabel\n* FormHelperText\n* Input\n* InputLabel\n\nYou can find one composition example below and more going to [the demos](https://mui.com/material-ui/react-text-field/#components).\n\n```jsx\n\n Email address\n \n We'll never share your email.\n\n```\n\n⚠️ Only one `Input` can be used within a FormControl because it create visual inconsistencies.\nFor instance, only one input can be focused at the same time, the state shouldn't be shared.", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "disabled": { - "description": "If true, the label, input and helper text should be displayed in a disabled state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "error": { - "description": "If true, the label is displayed in an error state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback fired when the form element's value is modified.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label, input and helper text should be displayed in a disabled state." }, + "error": { "description": "If true, the label is displayed in an error state." }, + "onChange": { "description": "Callback fired when the form element's value is modified." }, "required": { - "description": "If true, the label will indicate that the input is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the FormControl.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label will indicate that the input is required." }, + "slotProps": { "description": "The props used for each slot inside the FormControl." }, "slots": { - "description": "The components used for each slot inside the FormControl. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the FormControl. Either a string to use a HTML element or a component." }, - "value": { - "description": "The value of the form element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "value": { "description": "The value of the form element." } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/input/input.json b/docs/translations/api-docs-base/input/input.json index aec2c96d684243..591c33f435cf4e 100644 --- a/docs/translations/api-docs-base/input/input.json +++ b/docs/translations/api-docs-base/input/input.json @@ -2,130 +2,53 @@ "componentDescription": "", "propDescriptions": { "autoComplete": { - "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification." }, "autoFocus": { - "description": "If true, the input element is focused during the first mount.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "className": { - "description": "Class name applied to the root element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is focused during the first mount." }, + "className": { "description": "Class name applied to the root element." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endAdornment": { - "description": "Trailing adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "endAdornment": { "description": "Trailing adornment for this input." }, "error": { - "description": "If true, the input will indicate an error by setting the aria-invalid attribute on the input and the Mui-error class on the root element. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "id": { - "description": "The id of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error by setting the aria-invalid attribute on the input and the Mui-error class on the root element. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "id": { "description": "The id of the input element." }, "maxRows": { - "description": "Maximum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Maximum number of rows to display when multiline option is set to true." }, "minRows": { - "description": "Minimum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Minimum number of rows to display when multiline option is set to true." }, "multiline": { - "description": "If true, a textarea element is rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a textarea element is rendered." }, + "name": { "description": "Name attribute of the input element." }, "placeholder": { - "description": "The short hint displayed in the input before the user enters a value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The short hint displayed in the input before the user enters a value." }, "readOnly": { - "description": "It prevents the user from changing the value of the field (not from interacting with the field).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "It prevents the user from changing the value of the field (not from interacting with the field)." }, "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rows": { - "description": "Number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "rows": { "description": "Number of rows to display when multiline option is set to true." }, + "slotProps": { "description": "The props used for each slot inside the Input." }, "slots": { - "description": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startAdornment": { - "description": "Leading adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component." }, + "startAdornment": { "description": "Leading adornment for this input." }, "type": { - "description": "Type of the input element. It should be a valid HTML5 input type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Type of the input element. It should be a valid HTML5 input type." }, "value": { - "description": "The value of the input element, required for a controlled component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the input element, required for a controlled component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/menu-item/menu-item.json b/docs/translations/api-docs-base/menu-item/menu-item.json index 0aa18e3f6bdc34..8190995be31899 100644 --- a/docs/translations/api-docs-base/menu-item/menu-item.json +++ b/docs/translations/api-docs-base/menu-item/menu-item.json @@ -2,22 +2,11 @@ "componentDescription": "", "propDescriptions": { "label": { - "description": "A text representation of the menu item's content. Used for keyboard text navigation matching.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the MenuItem.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A text representation of the menu item's content. Used for keyboard text navigation matching." }, + "slotProps": { "description": "The props used for each slot inside the MenuItem." }, "slots": { - "description": "The components used for each slot inside the MenuItem. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the MenuItem. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/menu/menu.json b/docs/translations/api-docs-base/menu/menu.json index d2698052c9a9eb..01a7231118eed8 100644 --- a/docs/translations/api-docs-base/menu/menu.json +++ b/docs/translations/api-docs-base/menu/menu.json @@ -2,46 +2,21 @@ "componentDescription": "", "propDescriptions": { "actions": { - "description": "A ref with imperative actions that can be performed on the menu.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref with imperative actions that can be performed on the menu." }, "anchorEl": { - "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper." }, "onItemsChange": { - "description": "Function called when the items displayed in the menu change.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Function called when the items displayed in the menu change." }, "onOpenChange": { - "description": "Triggered when focus leaves the menu and the menu should close.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "Controls whether the menu is displayed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Menu.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Triggered when focus leaves the menu and the menu should close." }, + "open": { "description": "Controls whether the menu is displayed." }, + "slotProps": { "description": "The props used for each slot inside the Menu." }, "slots": { - "description": "The components used for each slot inside the Menu. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Menu. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/modal/modal.json b/docs/translations/api-docs-base/modal/modal.json index 0358f1e7787c5c..1113b8f05ee1e0 100644 --- a/docs/translations/api-docs-base/modal/modal.json +++ b/docs/translations/api-docs-base/modal/modal.json @@ -3,114 +3,48 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "closeAfterTransition": { - "description": "When set to true the Modal waits until a nested Transition is completed before closing.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "When set to true the Modal waits until a nested Transition is completed before closing." }, "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time." }, "disableAutoFocus": { - "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEnforceFocus": { - "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEscapeKeyDown": { - "description": "If true, hitting escape will not fire the onClose callback.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, hitting escape will not fire the onClose callback." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, "disableRestoreFocus": { - "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableScrollLock": { - "description": "Disable the scroll lock behavior.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "hideBackdrop": { - "description": "If true, the backdrop is not rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted." }, + "disableScrollLock": { "description": "Disable the scroll lock behavior." }, + "hideBackdrop": { "description": "If true, the backdrop is not rendered." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onBackdropClick": { - "description": "Callback fired when the backdrop is clicked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal." }, + "onBackdropClick": { "description": "Callback fired when the backdrop is clicked." }, "onClose": { "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "escapeKeyDown", "backdropClick"." } }, - "onTransitionEnter": { - "description": "A function called when a transition enters.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onTransitionExited": { - "description": "A function called when a transition has exited.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Modal.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "onTransitionEnter": { "description": "A function called when a transition enters." }, + "onTransitionExited": { "description": "A function called when a transition has exited." }, + "open": { "description": "If true, the component is shown." }, + "slotProps": { "description": "The props used for each slot inside the Modal." }, "slots": { - "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/no-ssr/no-ssr.json b/docs/translations/api-docs-base/no-ssr/no-ssr.json index bd21a0a19c01ec..ff903d12a20b33 100644 --- a/docs/translations/api-docs-base/no-ssr/no-ssr.json +++ b/docs/translations/api-docs-base/no-ssr/no-ssr.json @@ -1,24 +1,11 @@ { "componentDescription": "NoSsr purposely removes components from the subject of Server Side Rendering (SSR).\n\nThis component can be useful in a variety of situations:\n\n* Escape hatch for broken dependencies not supporting SSR.\n* Improve the time-to-first paint on the client by only rendering above the fold.\n* Reduce the rendering time on the server.\n* Under too heavy server load, you can turn on service degradation.", "propDescriptions": { - "children": { - "description": "You can wrap a node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "You can wrap a node." }, "defer": { - "description": "If true, the component will not only prevent server-side rendering. It will also defer the rendering of the children into a different screen frame.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component will not only prevent server-side rendering. It will also defer the rendering of the children into a different screen frame." }, - "fallback": { - "description": "The fallback content to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "fallback": { "description": "The fallback content to display." } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-base/option-group/option-group.json b/docs/translations/api-docs-base/option-group/option-group.json index 7e8fc0bd2f6364..a4bcb3737d46f9 100644 --- a/docs/translations/api-docs-base/option-group/option-group.json +++ b/docs/translations/api-docs-base/option-group/option-group.json @@ -2,28 +2,12 @@ "componentDescription": "An unstyled option group to be used within a Select.", "propDescriptions": { "disabled": { - "description": "If true all the options in the group will be disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "The human-readable description of the group.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true all the options in the group will be disabled." }, + "label": { "description": "The human-readable description of the group." }, + "slotProps": { "description": "The props used for each slot inside the Input." }, "slots": { - "description": "The components used for each slot inside the OptionGroup. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the OptionGroup. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/option/option.json b/docs/translations/api-docs-base/option/option.json index f92d73a32275df..1912456562f74f 100644 --- a/docs/translations/api-docs-base/option/option.json +++ b/docs/translations/api-docs-base/option/option.json @@ -1,36 +1,15 @@ { "componentDescription": "An unstyled option to be used within a Select.", "propDescriptions": { - "disabled": { - "description": "If true, the option will be disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "disabled": { "description": "If true, the option will be disabled." }, "label": { - "description": "A text representation of the option's content. Used for keyboard text navigation matching.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Option.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A text representation of the option's content. Used for keyboard text navigation matching." }, + "slotProps": { "description": "The props used for each slot inside the Option." }, "slots": { - "description": "The components used for each slot inside the Option. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Option. Either a string to use a HTML element or a component." }, - "value": { - "description": "The value of the option.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "value": { "description": "The value of the option." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-base/popper/popper.json b/docs/translations/api-docs-base/popper/popper.json index bfe44d47faeebe..692fd39ca0bd09 100644 --- a/docs/translations/api-docs-base/popper/popper.json +++ b/docs/translations/api-docs-base/popper/popper.json @@ -2,88 +2,34 @@ "componentDescription": "Poppers rely on the 3rd party library [Popper.js](https://popper.js.org/docs/v2/) for positioning.", "propDescriptions": { "anchorEl": { - "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "Popper render function or node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance." }, + "children": { "description": "Popper render function or node." }, "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "direction": { - "description": "Direction of the text.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time." }, + "direction": { "description": "Direction of the text." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper." }, "modifiers": { - "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "placement": { - "description": "Popper placement.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation." }, + "open": { "description": "If true, the component is shown." }, + "placement": { "description": "Popper placement." }, "popperOptions": { - "description": "Options provided to the Popper.js instance.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "popperRef": { - "description": "A ref that points to the used popper instance.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Popper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Options provided to the Popper.js instance." }, + "popperRef": { "description": "A ref that points to the used popper instance." }, + "slotProps": { "description": "The props used for each slot inside the Popper." }, "slots": { - "description": "The components used for each slot inside the Popper. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Popper. Either a string to use a HTML element or a component." }, "transition": { - "description": "Help supporting a react-transition-group/Transition component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Help supporting a react-transition-group/Transition component." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs-base/portal/portal.json b/docs/translations/api-docs-base/portal/portal.json index 17d6ce798a3cf5..5cf030caee57c1 100644 --- a/docs/translations/api-docs-base/portal/portal.json +++ b/docs/translations/api-docs-base/portal/portal.json @@ -1,23 +1,12 @@ { "componentDescription": "Portals provide a first-class way to render children into a DOM node\nthat exists outside the DOM hierarchy of the parent component.", "propDescriptions": { - "children": { - "description": "The children to render into the container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The children to render into the container." }, "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs-base/select/select.json b/docs/translations/api-docs-base/select/select.json index c467e977ad1be6..b8b0aa0abbc8a8 100644 --- a/docs/translations/api-docs-base/select/select.json +++ b/docs/translations/api-docs-base/select/select.json @@ -2,106 +2,45 @@ "componentDescription": "The foundation for building custom-styled select components.", "propDescriptions": { "areOptionsEqual": { - "description": "A function used to determine if two options' values are equal. By default, reference equality is used.
    There is a performance impact when using the areOptionsEqual prop (proportional to the number of options). Therefore, it's recommented to use the default reference equality comparison whenever possible.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A function used to determine if two options' values are equal. By default, reference equality is used.
    There is a performance impact when using the areOptionsEqual prop (proportional to the number of options). Therefore, it's recommented to use the default reference equality comparison whenever possible." }, "autoFocus": { - "description": "If true, the select element is focused during the first mount", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the select element is focused during the first mount" }, "defaultListboxOpen": { - "description": "If true, the select will be initially open.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the select will be initially open." }, "defaultValue": { - "description": "The default selected value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the select is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default selected value. Use when the component is not controlled." }, + "disabled": { "description": "If true, the select is disabled." }, "getOptionAsString": { - "description": "A function used to convert the option label to a string. It's useful when labels are elements and need to be converted to plain text to enable navigation using character keys on a keyboard.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A function used to convert the option label to a string. It's useful when labels are elements and need to be converted to plain text to enable navigation using character keys on a keyboard." }, "getSerializedValue": { - "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "listboxId": { - "description": "id attribute of the listbox element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "listboxOpen": { - "description": "Controls the open state of the select's listbox.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form." }, + "listboxId": { "description": "id attribute of the listbox element." }, + "listboxOpen": { "description": "Controls the open state of the select's listbox." }, "multiple": { - "description": "If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, selecting multiple values is allowed. This affects the type of the value, defaultValue, and onChange props." }, "name": { - "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback fired when an option is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server." }, + "onChange": { "description": "Callback fired when an option is selected." }, "onListboxOpenChange": { - "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen)." }, "renderValue": { - "description": "Function that customizes the rendering of the selected value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Function that customizes the rendering of the selected value." }, + "slotProps": { "description": "The props used for each slot inside the Input." }, "slots": { - "description": "The components used for each slot inside the Select. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Select. Either a string to use a HTML element or a component." }, "value": { - "description": "The selected value. Set to null to deselect all options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The selected value. Set to null to deselect all options." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/slider/slider.json b/docs/translations/api-docs-base/slider/slider.json index 90842b1ab90920..43168293706ae4 100644 --- a/docs/translations/api-docs-base/slider/slider.json +++ b/docs/translations/api-docs-base/slider/slider.json @@ -1,91 +1,46 @@ { "componentDescription": "", "propDescriptions": { - "aria-label": { - "description": "The label of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "aria-label": { "description": "The label of the slider." }, "aria-labelledby": { - "description": "The id of the element containing a label for the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The id of the element containing a label for the slider." }, "aria-valuetext": { - "description": "A string value that provides a user-friendly name for the current value of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A string value that provides a user-friendly name for the current value of the slider." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, "disableSwap": { - "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb." }, "getAriaLabel": { "description": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.", - "notes": "", - "deprecated": "", "typeDescriptions": { "index": "The thumb label's index to format." } }, "getAriaValueText": { "description": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.", - "notes": "", - "deprecated": "", "typeDescriptions": { "value": "The thumb label's value to format.", "index": "The thumb label's index to format." } }, "isRtl": { - "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side)." }, "marks": { - "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys." }, "max": { - "description": "The maximum allowed value of the slider. Should not be equal to min.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The maximum allowed value of the slider. Should not be equal to min." }, "min": { - "description": "The minimum allowed value of the slider. Should not be equal to max.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the hidden input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The minimum allowed value of the slider. Should not be equal to max." }, + "name": { "description": "Name attribute of the hidden input element." }, "onChange": { "description": "Callback function that is fired when the slider's value changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.", "value": "The new value.", @@ -94,66 +49,29 @@ }, "onChangeCommitted": { "description": "Callback function that is fired when the mouseup is triggered.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. Warning: This is a generic event not a change event.", "value": "The new value." } }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "scale": { - "description": "A transformation function, to change the scale of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "orientation": { "description": "The component orientation." }, + "scale": { "description": "A transformation function, to change the scale of the slider." }, + "slotProps": { "description": "The props used for each slot inside the Slider." }, "slots": { - "description": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component." }, "step": { - "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "tabIndex": { - "description": "Tab index attribute of the hidden input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop." }, + "tabIndex": { "description": "Tab index attribute of the hidden input element." }, "track": { - "description": "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.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "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": { - "description": "The value of the slider. For ranged sliders, provide an array with two values.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the slider. For ranged sliders, provide an array with two values." }, "valueLabelFormat": { - "description": "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", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "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" } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/snackbar/snackbar.json b/docs/translations/api-docs-base/snackbar/snackbar.json index 1d93e4031e8396..b7231f13740ff1 100644 --- a/docs/translations/api-docs-base/snackbar/snackbar.json +++ b/docs/translations/api-docs-base/snackbar/snackbar.json @@ -2,55 +2,28 @@ "componentDescription": "", "propDescriptions": { "autoHideDuration": { - "description": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value." }, "disableWindowBlurListener": { - "description": "If true, the autoHideDuration timer will expire even if the window is not focused.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the autoHideDuration timer will expire even if the window is not focused." }, "exited": { - "description": "The prop used to handle exited transition and unmount the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The prop used to handle exited transition and unmount the component." }, "onClose": { "description": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "timeout" (autoHideDuration expired), "clickaway", or "escapeKeyDown"." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, "resumeHideDuration": { - "description": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Snackbar.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms." }, + "slotProps": { "description": "The props used for each slot inside the Snackbar." }, "slots": { - "description": "The components used for each slot inside the Snackbar. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Snackbar. Either a string to use a HTML element or a component." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-base/switch/switch.json b/docs/translations/api-docs-base/switch/switch.json index 879e3e1d109442..8d2ea7070a1816 100644 --- a/docs/translations/api-docs-base/switch/switch.json +++ b/docs/translations/api-docs-base/switch/switch.json @@ -1,55 +1,24 @@ { "componentDescription": "The foundation for building custom-styled switches.", "propDescriptions": { - "checked": { - "description": "If true, the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component is checked." }, "defaultChecked": { - "description": "The default checked state. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default checked state. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." } }, - "readOnly": { - "description": "If true, the component is read only.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "readOnly": { "description": "If true, the component is read only." }, "required": { - "description": "If true, the input element is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Switch.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required." }, + "slotProps": { "description": "The props used for each slot inside the Switch." }, "slots": { - "description": "The components used for each slot inside the Switch. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Switch. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/tab-panel/tab-panel.json b/docs/translations/api-docs-base/tab-panel/tab-panel.json index 492f1dcbda30df..66243b1173ca4b 100644 --- a/docs/translations/api-docs-base/tab-panel/tab-panel.json +++ b/docs/translations/api-docs-base/tab-panel/tab-panel.json @@ -1,29 +1,13 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the TabPanel.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "slotProps": { "description": "The props used for each slot inside the TabPanel." }, "slots": { - "description": "The components used for each slot inside the TabPanel. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the TabPanel. Either a string to use a HTML element or a component." }, "value": { - "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected. If not provided, it will fall back to the index of the panel. It is recommended to explicitly provide it, as it's required for the tab panel to be rendered on the server.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected. If not provided, it will fall back to the index of the panel. It is recommended to explicitly provide it, as it's required for the tab panel to be rendered on the server." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/tab/tab.json b/docs/translations/api-docs-base/tab/tab.json index a7bd0ff78213f3..5140798fc53efc 100644 --- a/docs/translations/api-docs-base/tab/tab.json +++ b/docs/translations/api-docs-base/tab/tab.json @@ -2,40 +2,16 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback invoked when new value is being set.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Tab.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, + "disabled": { "description": "If true, the component is disabled." }, + "onChange": { "description": "Callback invoked when new value is being set." }, + "slotProps": { "description": "The props used for each slot inside the Tab." }, "slots": { - "description": "The components used for each slot inside the Tab. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Tab. Either a string to use a HTML element or a component." }, "value": { - "description": "You can provide your own value. Otherwise, it falls back to the child position index.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "You can provide your own value. Otherwise, it falls back to the child position index." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/table-pagination/table-pagination.json b/docs/translations/api-docs-base/table-pagination/table-pagination.json index 8467e86287940a..74777947351e2c 100644 --- a/docs/translations/api-docs-base/table-pagination/table-pagination.json +++ b/docs/translations/api-docs-base/table-pagination/table-pagination.json @@ -2,41 +2,23 @@ "componentDescription": "A pagination for tables.", "propDescriptions": { "count": { - "description": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The total number of rows.
    To enable server side pagination for an unknown number of items, provide -1." }, "getItemAriaLabel": { "description": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", "typeDescriptions": { "type": "The link or button type to format ('first' | 'last' | 'next' | 'previous')." } }, "labelDisplayedRows": { - "description": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "labelId": { - "description": "Id of the label element within the pagination.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Customize the displayed rows label. Invoked with a { from, to, count, page } object.
    For localization purposes, you can use the provided translations." }, + "labelId": { "description": "Id of the label element within the pagination." }, "labelRowsPerPage": { - "description": "Customize the rows per page label.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Customize the rows per page label.
    For localization purposes, you can use the provided translations." }, "onPageChange": { "description": "Callback fired when the page is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "page": "The page selected." @@ -44,45 +26,19 @@ }, "onRowsPerPageChange": { "description": "Callback fired when the number of rows per page is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "page": { - "description": "The zero-based index of the current page.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "page": { "description": "The zero-based index of the current page." }, "rowsPerPage": { - "description": "The number of rows per page.
    Set -1 to display all the rows.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of rows per page.
    Set -1 to display all the rows." }, "rowsPerPageOptions": { - "description": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selectId": { - "description": "Id of the select element within the pagination.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the TablePagination.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows." }, + "selectId": { "description": "Id of the select element within the pagination." }, + "slotProps": { "description": "The props used for each slot inside the TablePagination." }, "slots": { - "description": "The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/tabs-list/tabs-list.json b/docs/translations/api-docs-base/tabs-list/tabs-list.json index 3e2fe2454cb0aa..6a546e1fd0f8d0 100644 --- a/docs/translations/api-docs-base/tabs-list/tabs-list.json +++ b/docs/translations/api-docs-base/tabs-list/tabs-list.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the TabsList.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "slotProps": { "description": "The props used for each slot inside the TabsList." }, "slots": { - "description": "The components used for each slot inside the TabsList. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the TabsList. Either a string to use a HTML element or a component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/tabs/tabs.json b/docs/translations/api-docs-base/tabs/tabs.json index 2762046f174d0b..27c0022d5849cc 100644 --- a/docs/translations/api-docs-base/tabs/tabs.json +++ b/docs/translations/api-docs-base/tabs/tabs.json @@ -1,59 +1,22 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "direction": { - "description": "The direction of the text.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback invoked when new value is being set.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation (layout flow direction).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "direction": { "description": "The direction of the text." }, + "onChange": { "description": "Callback invoked when new value is being set." }, + "orientation": { "description": "The component orientation (layout flow direction)." }, "selectionFollowsFocus": { - "description": "If true the selected tab changes on focus. Otherwise it only changes on activation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Tabs.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true the selected tab changes on focus. Otherwise it only changes on activation." }, + "slotProps": { "description": "The props used for each slot inside the Tabs." }, "slots": { - "description": "The components used for each slot inside the Tabs. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Tabs. Either a string to use a HTML element or a component." }, "value": { - "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json b/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json index b88136280d5021..ee91d0dd6d70c6 100644 --- a/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json +++ b/docs/translations/api-docs-base/textarea-autosize/textarea-autosize.json @@ -1,18 +1,8 @@ { "componentDescription": "", "propDescriptions": { - "maxRows": { - "description": "Maximum number of rows to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "minRows": { - "description": "Minimum number of rows to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "maxRows": { "description": "Maximum number of rows to display." }, + "minRows": { "description": "Minimum number of rows to display." } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs-joy/alert/alert.json b/docs/translations/api-docs-joy/alert/alert.json index 61a2f0a6d97016..4052802ce17066 100644 --- a/docs/translations/api-docs-joy/alert/alert.json +++ b/docs/translations/api-docs-joy/alert/alert.json @@ -2,70 +2,25 @@ "componentDescription": "", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "endDecorator": { "description": "Element placed after the children." }, "invertedColors": { - "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "role": { - "description": "The ARIA role attribute of the element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color." }, + "role": { "description": "The ARIA role attribute of the element." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json b/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json index 207b4ed9f03242..81da535aee38f9 100644 --- a/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json +++ b/docs/translations/api-docs-joy/aspect-ratio/aspect-ratio.json @@ -2,70 +2,31 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the AspectRatio if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the AspectRatio if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "maxHeight": { - "description": "The maximum calculated height of the element (not the CSS height).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The maximum calculated height of the element (not the CSS height)." }, "minHeight": { - "description": "The minimum calculated height of the element (not the CSS height).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "objectFit": { - "description": "The CSS object-fit value of the first-child.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The minimum calculated height of the element (not the CSS height)." }, + "objectFit": { "description": "The CSS object-fit value of the first-child." }, "ratio": { - "description": "The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. https://caniuse.com/?search=aspect-ratio", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The aspect-ratio of the element. The current implementation uses padding instead of the CSS aspect-ratio due to browser support. https://caniuse.com/?search=aspect-ratio" }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json b/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json index 9ba90fe9b1bce7..ed89e713dd6508 100644 --- a/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json +++ b/docs/translations/api-docs-joy/autocomplete-listbox/autocomplete-listbox.json @@ -2,46 +2,19 @@ "componentDescription": "", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component (affect other nested list* components).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "size": { "description": "The size of the component (affect other nested list* components)." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json b/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json index 126c0e10523071..fb97fd19b62976 100644 --- a/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json +++ b/docs/translations/api-docs-joy/autocomplete-option/autocomplete-option.json @@ -2,40 +2,18 @@ "componentDescription": "", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/autocomplete/autocomplete.json b/docs/translations/api-docs-joy/autocomplete/autocomplete.json index 896c1b2b083e5a..f9e8cdf270b6df 100644 --- a/docs/translations/api-docs-joy/autocomplete/autocomplete.json +++ b/docs/translations/api-docs-joy/autocomplete/autocomplete.json @@ -2,186 +2,86 @@ "componentDescription": "", "propDescriptions": { "aria-describedby": { - "description": "Identifies the element (or elements) that describes the object.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "aria-label": { - "description": "Defines a string value that labels the current element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Identifies the element (or elements) that describes the object." }, + "aria-label": { "description": "Defines a string value that labels the current element." }, "aria-labelledby": { - "description": "Identifies the element (or elements) that labels the current element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Identifies the element (or elements) that labels the current element." }, "autoFocus": { - "description": "If true, the input element is focused during the first mount.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "clearIcon": { - "description": "The icon to display in place of the default clear icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is focused during the first mount." }, + "clearIcon": { "description": "The icon to display in place of the default clear icon." }, "clearText": { - "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations." }, "closeText": { - "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableClearable": { - "description": "If true, the input can't be cleared.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Trailing adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "disableClearable": { "description": "If true, the input can't be cleared." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "Trailing adornment for this input." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, "filterOptions": { "description": "A function that determines the filtered options to be rendered on search.", - "notes": "", - "deprecated": "", "typeDescriptions": { "options": "The options to render.", "state": "The state of the component." } }, - "forcePopupIcon": { - "description": "Force the visibility display of the popup icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "forcePopupIcon": { "description": "Force the visibility display of the popup icon." }, "freeSolo": { - "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options." }, "getLimitTagsText": { "description": "The label to display when the tags are truncated (limitTags).", - "notes": "", - "deprecated": "", "typeDescriptions": { "more": "The number of truncated tags." } }, "getOptionDisabled": { "description": "Used to determine the disabled state for a given option.", - "notes": "", - "deprecated": "", "typeDescriptions": { "option": "The option to test." } }, "getOptionLabel": { - "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string." }, "groupBy": { "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.", - "notes": "", - "deprecated": "", "typeDescriptions": { "options": "The options to group." } }, "id": { - "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputValue": { - "description": "The input value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one." }, + "inputValue": { "description": "The input value." }, "isOptionEqualToValue": { "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.", - "notes": "", - "deprecated": "", "typeDescriptions": { "option": "The option to test.", "value": "The value to test against." } }, "limitTags": { - "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit." }, "loading": { - "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty)." }, "loadingText": { - "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations." }, "multiple": { - "description": "If true, value must be an array and the menu will support multiple selections.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, value must be an array and the menu will support multiple selections." }, + "name": { "description": "Name attribute of the input element." }, "noOptionsText": { - "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations." }, "onChange": { "description": "Callback fired when the value changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "value": "The new value of the component.", @@ -190,8 +90,6 @@ }, "onClose": { "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur"." @@ -199,8 +97,6 @@ }, "onHighlightChange": { "description": "Callback fired when the highlight option changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "option": "The highlighted option.", @@ -209,8 +105,6 @@ }, "onInputChange": { "description": "Callback fired when the input value changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "value": "The new value of the text input.", @@ -219,56 +113,24 @@ }, "onOpen": { "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, "openText": { - "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "options": { - "description": "Array of options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "placeholder": { - "description": "The input placeholder", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "popupIcon": { - "description": "The icon to display in place of the default popup icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations." }, + "options": { "description": "Array of options." }, + "placeholder": { "description": "The input placeholder" }, + "popupIcon": { "description": "The icon to display in place of the default popup icon." }, "readOnly": { - "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted." }, "renderGroup": { "description": "Render the group.", - "notes": "", - "deprecated": "", "typeDescriptions": { "params": "The group to render." } }, "renderOption": { "description": "Render the option, use getOptionLabel by default.", - "notes": "", - "deprecated": "", "typeDescriptions": { "props": "The props to apply on the li element.", "option": "The option to render.", @@ -277,8 +139,6 @@ }, "renderTags": { "description": "Render the selected value.", - "notes": "", - "deprecated": "", "typeDescriptions": { "value": "The value provided to the component.", "getTagProps": "A tag props getter.", @@ -286,58 +146,23 @@ } }, "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Leading adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Leading adornment for this input." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "type": { - "description": "Type of the input element. It should be a valid HTML5 input type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Type of the input element. It should be a valid HTML5 input type." }, "value": { - "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/avatar-group/avatar-group.json b/docs/translations/api-docs-joy/avatar-group/avatar-group.json index 3ede5503262026..0f5ae735e53d39 100644 --- a/docs/translations/api-docs-joy/avatar-group/avatar-group.json +++ b/docs/translations/api-docs-joy/avatar-group/avatar-group.json @@ -2,52 +2,24 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the AvatarGroup if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the AvatarGroup if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/avatar/avatar.json b/docs/translations/api-docs-joy/avatar/avatar.json index c725ecd03465fa..7719c2b8156389 100644 --- a/docs/translations/api-docs-joy/avatar/avatar.json +++ b/docs/translations/api-docs-joy/avatar/avatar.json @@ -2,70 +2,31 @@ "componentDescription": "", "propDescriptions": { "alt": { - "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element." }, "children": { - "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "src": { - "description": "The src attribute for the img element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "src": { "description": "The src attribute for the img element." }, "srcSet": { - "description": "The srcSet attribute for the img element. Use this attribute for responsive image display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The srcSet attribute for the img element. Use this attribute for responsive image display." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/badge/badge.json b/docs/translations/api-docs-joy/badge/badge.json index 125fae9d148803..315ba22bd2b240 100644 --- a/docs/translations/api-docs-joy/badge/badge.json +++ b/docs/translations/api-docs-joy/badge/badge.json @@ -1,89 +1,31 @@ { "componentDescription": "", "propDescriptions": { - "anchorOrigin": { - "description": "The anchor of the badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "badgeContent": { - "description": "The content rendered within the badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "anchorOrigin": { "description": "The anchor of the badge." }, + "badgeContent": { "description": "The content rendered within the badge." }, "badgeInset": { - "description": "The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The badge will be added relative to this node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset." }, + "children": { "description": "The badge will be added relative to this node." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "invisible": { - "description": "If true, the badge is invisible.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "max": { - "description": "Max count to show.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "invisible": { "description": "If true, the badge is invisible." }, + "max": { "description": "Max count to show." }, "showZero": { - "description": "Controls whether the badge is hidden when badgeContent is zero.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Controls whether the badge is hidden when badgeContent is zero." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json b/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json index eccdbf9b290031..09fda9d11cdb72 100644 --- a/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json +++ b/docs/translations/api-docs-joy/breadcrumbs/breadcrumbs.json @@ -1,47 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "separator": { - "description": "Custom separator node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "separator": { "description": "Custom separator node." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/button-group/button-group.json b/docs/translations/api-docs-joy/button-group/button-group.json index de8e6b888ca711..3d027bf574ac1f 100644 --- a/docs/translations/api-docs-joy/button-group/button-group.json +++ b/docs/translations/api-docs-joy/button-group/button-group.json @@ -1,77 +1,31 @@ { "componentDescription": "", "propDescriptions": { - "buttonFlex": { - "description": "The flex value of the button.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "buttonFlex": { "description": "The flex value of the button." }, "children": { - "description": "Used to render icon or text elements inside the ButtonGroup if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the ButtonGroup if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, all the buttons will be disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, all the buttons will be disabled." }, + "orientation": { "description": "The component orientation." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "spacing": { - "description": "Defines the space between the type item components. It can only be used on a type container component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the space between the type item components. It can only be used on a type container component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/button/button.json b/docs/translations/api-docs-joy/button/button.json index 077b02c33a1a21..a244143e57583c 100644 --- a/docs/translations/api-docs-joy/button/button.json +++ b/docs/translations/api-docs-joy/button/button.json @@ -2,94 +2,35 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "Element placed after the children." }, "fullWidth": { - "description": "If true, the button will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "loading": { - "description": "If true, the loading indicator is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the button will take up the full width of its container." }, + "loading": { "description": "If true, the loading indicator is shown." }, "loadingIndicator": { - "description": "The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself." }, "loadingPosition": { - "description": "The loading indicator can be positioned on the start, end, or the center of the button.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The loading indicator can be positioned on the start, end, or the center of the button." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/card-actions/card-actions.json b/docs/translations/api-docs-joy/card-actions/card-actions.json index 0481e852692465..b5a50b817ce87a 100644 --- a/docs/translations/api-docs-joy/card-actions/card-actions.json +++ b/docs/translations/api-docs-joy/card-actions/card-actions.json @@ -1,47 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "buttonFlex": { - "description": "The CSS flex for the Button and its wrapper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "buttonFlex": { "description": "The CSS flex for the Button and its wrapper." }, "children": { - "description": "Used to render icon or text elements inside the CardActions if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the CardActions if src is not set. This can be an element, or just a string." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "orientation": { "description": "The component orientation." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/card-content/card-content.json b/docs/translations/api-docs-joy/card-content/card-content.json index 30040828b982bd..139c1a9607c8c4 100644 --- a/docs/translations/api-docs-joy/card-content/card-content.json +++ b/docs/translations/api-docs-joy/card-content/card-content.json @@ -2,40 +2,16 @@ "componentDescription": "⚠️ CardContent must be used as a direct child of the [Card](https://mui.com/joy-ui/react-card/) component.", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the CardContent if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the CardContent if src is not set. This can be an element, or just a string." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "orientation": { "description": "The component orientation." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/card-cover/card-cover.json b/docs/translations/api-docs-joy/card-cover/card-cover.json index 6f0cb97d1feda9..a0f5f856eece6a 100644 --- a/docs/translations/api-docs-joy/card-cover/card-cover.json +++ b/docs/translations/api-docs-joy/card-cover/card-cover.json @@ -2,34 +2,15 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the CardCover if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the CardCover if src is not set. This can be an element, or just a string." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/card-overflow/card-overflow.json b/docs/translations/api-docs-joy/card-overflow/card-overflow.json index 7ddcced1076f20..3e276a0426c2b8 100644 --- a/docs/translations/api-docs-joy/card-overflow/card-overflow.json +++ b/docs/translations/api-docs-joy/card-overflow/card-overflow.json @@ -2,46 +2,21 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the CardOverflow if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the CardOverflow if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/card/card.json b/docs/translations/api-docs-joy/card/card.json index 0229ed5d03de48..373bcc835d34da 100644 --- a/docs/translations/api-docs-joy/card/card.json +++ b/docs/translations/api-docs-joy/card/card.json @@ -2,64 +2,28 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the Card if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the Card if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "invertedColors": { - "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color." }, + "orientation": { "description": "The component orientation." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/checkbox/checkbox.json b/docs/translations/api-docs-joy/checkbox/checkbox.json index a20a7f559f7a1f..2991efa5701a64 100644 --- a/docs/translations/api-docs-joy/checkbox/checkbox.json +++ b/docs/translations/api-docs-joy/checkbox/checkbox.json @@ -1,145 +1,55 @@ { "componentDescription": "", "propDescriptions": { - "checked": { - "description": "If true, the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "checkedIcon": { - "description": "The icon to display when the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "className": { - "description": "Class name applied to the root element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component is checked." }, + "checkedIcon": { "description": "The icon to display when the component is checked." }, + "className": { "description": "Class name applied to the root element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultChecked": { - "description": "The default checked state. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default checked state. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, "disableIcon": { - "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead." }, "indeterminate": { - "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input." }, "indeterminateIcon": { - "description": "The icon to display when the component is indeterminate.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "The label element next to the checkbox.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "The name attribute of the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The icon to display when the component is indeterminate." }, + "label": { "description": "The label element next to the checkbox." }, + "name": { "description": "The name attribute of the input." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." } }, "overlay": { - "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "readOnly": { - "description": "If true, the component is read only.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Checkbox with ListItem component." }, + "readOnly": { "description": "If true, the component is read only." }, "required": { - "description": "If true, the input element is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "uncheckedIcon": { - "description": "The icon when checked is false.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "uncheckedIcon": { "description": "The icon when checked is false." }, "value": { - "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/chip-delete/chip-delete.json b/docs/translations/api-docs-joy/chip-delete/chip-delete.json index 0f094a5ea3e26f..250dfd6652c612 100644 --- a/docs/translations/api-docs-joy/chip-delete/chip-delete.json +++ b/docs/translations/api-docs-joy/chip-delete/chip-delete.json @@ -1,59 +1,26 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "If provided, it will replace the default icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "If provided, it will replace the default icon." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disabled": { - "description": "If true, the component is disabled. If undefined, the value inherits from the parent chip via a React context.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is disabled. If undefined, the value inherits from the parent chip via a React context." }, "onDelete": { - "description": "Callback fired when the component is not disabled and either: - Backspace, Enter or Delete is pressed. - The component is clicked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the component is not disabled and either: - Backspace, Enter or Delete is pressed. - The component is clicked." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/chip/chip.json b/docs/translations/api-docs-joy/chip/chip.json index 7be81fbf544cf8..325c958f589ec9 100644 --- a/docs/translations/api-docs-joy/chip/chip.json +++ b/docs/translations/api-docs-joy/chip/chip.json @@ -1,77 +1,27 @@ { "componentDescription": "Chips represent complex entities in small blocks, such as a contact.", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onClick": { - "description": "Element action click handler.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "Element placed after the children." }, + "onClick": { "description": "Element action click handler." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/circular-progress/circular-progress.json b/docs/translations/api-docs-joy/circular-progress/circular-progress.json index b8a947826d1e4f..746eaca096bdc6 100644 --- a/docs/translations/api-docs-joy/circular-progress/circular-progress.json +++ b/docs/translations/api-docs-joy/circular-progress/circular-progress.json @@ -2,64 +2,28 @@ "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "determinate": { - "description": "The boolean to select a variant. Use indeterminate when there is no progress value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The boolean to select a variant. Use indeterminate when there is no progress value." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "thickness": { - "description": "The thickness of the circle.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "thickness": { "description": "The thickness of the circle." }, "value": { - "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/css-baseline/css-baseline.json b/docs/translations/api-docs-joy/css-baseline/css-baseline.json index 0b1309cf042bb6..3b5882de0e940a 100644 --- a/docs/translations/api-docs-joy/css-baseline/css-baseline.json +++ b/docs/translations/api-docs-joy/css-baseline/css-baseline.json @@ -1,17 +1,9 @@ { "componentDescription": "Kickstart an elegant, consistent, and simple baseline to build upon.", "propDescriptions": { - "children": { - "description": "You can wrap a node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "You can wrap a node." }, "disableColorScheme": { - "description": "Disable color-scheme CSS property.
    For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Disable color-scheme CSS property.
    For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme" } }, "classDescriptions": {} diff --git a/docs/translations/api-docs-joy/divider/divider.json b/docs/translations/api-docs-joy/divider/divider.json index 8b9a407aa9b448..5fb882709d4e54 100644 --- a/docs/translations/api-docs-joy/divider/divider.json +++ b/docs/translations/api-docs-joy/divider/divider.json @@ -1,47 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "inset": { - "description": "Class name applied to the divider to shrink or stretch the line based on the orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Class name applied to the divider to shrink or stretch the line based on the orientation." }, + "orientation": { "description": "The component orientation." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/form-control/form-control.json b/docs/translations/api-docs-joy/form-control/form-control.json index 5b00cf3be420bf..cb35ed34bbf8c4 100644 --- a/docs/translations/api-docs-joy/form-control/form-control.json +++ b/docs/translations/api-docs-joy/form-control/form-control.json @@ -1,71 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the children are in disabled state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "error": { - "description": "If true, the children will indicate an error.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The content direction flow.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the children are in disabled state." }, + "error": { "description": "If true, the children will indicate an error." }, + "orientation": { "description": "The content direction flow." }, "required": { - "description": "If true, the user must specify a value for the input before the owning form can be submitted. If true, the asterisk appears on the FormLabel.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the user must specify a value for the input before the owning form can be submitted. If true, the asterisk appears on the FormLabel." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json b/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json index d51cca9ec95c84..180d5e47af86cd 100644 --- a/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json +++ b/docs/translations/api-docs-joy/form-helper-text/form-helper-text.json @@ -1,35 +1,14 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/form-label/form-label.json b/docs/translations/api-docs-joy/form-label/form-label.json index c2ede40e662e20..5bf00ab80286ef 100644 --- a/docs/translations/api-docs-joy/form-label/form-label.json +++ b/docs/translations/api-docs-joy/form-label/form-label.json @@ -1,41 +1,15 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "required": { - "description": "The asterisk is added if required=true", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "required": { "description": "The asterisk is added if required=true" }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/icon-button/icon-button.json b/docs/translations/api-docs-joy/icon-button/icon-button.json index 7c0a211f675b81..1e912fb5d6e228 100644 --- a/docs/translations/api-docs-joy/icon-button/icon-button.json +++ b/docs/translations/api-docs-joy/icon-button/icon-button.json @@ -2,64 +2,26 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/input/input.json b/docs/translations/api-docs-joy/input/input.json index 7db407bbb63798..ca1f00e5cc85af 100644 --- a/docs/translations/api-docs-joy/input/input.json +++ b/docs/translations/api-docs-joy/input/input.json @@ -1,59 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "className": { - "description": "Class name applied to the root element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "className": { "description": "Class name applied to the root element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Trailing adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, + "endDecorator": { "description": "Trailing adornment for this input." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, "fullWidth": { - "description": "If true, the button will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Leading adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the button will take up the full width of its container." }, + "size": { "description": "The size of the component." }, + "startDecorator": { "description": "Leading adornment for this input." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/linear-progress/linear-progress.json b/docs/translations/api-docs-joy/linear-progress/linear-progress.json index 8c3be50d727d35..547d182053a59c 100644 --- a/docs/translations/api-docs-joy/linear-progress/linear-progress.json +++ b/docs/translations/api-docs-joy/linear-progress/linear-progress.json @@ -2,64 +2,28 @@ "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "determinate": { - "description": "The boolean to select a variant. Use indeterminate when there is no progress value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The boolean to select a variant. Use indeterminate when there is no progress value." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "thickness": { - "description": "The thickness of the bar.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "thickness": { "description": "The thickness of the bar." }, "value": { - "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/link/link.json b/docs/translations/api-docs-joy/link/link.json index ce30631eaf5c67..fea9048728229d 100644 --- a/docs/translations/api-docs-joy/link/link.json +++ b/docs/translations/api-docs-joy/link/link.json @@ -1,90 +1,26 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "color": { - "description": "The color of the link.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "color": { "description": "The color of the link." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "level": { - "description": "Applies the theme typography styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "Element placed after the children." }, + "level": { "description": "Applies the theme typography styles." }, "overlay": { - "description": "If true, the ::after pseudo element is added to cover the area of interaction. The parent of the overlay Link should have relative CSS position.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the ::after pseudo element is added to cover the area of interaction. The parent of the overlay Link should have relative CSS position." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "textColor": { - "description": "The system color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "underline": { - "description": "Controls when the link should have an underline.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "Applies the theme link styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "textColor": { "description": "The system color." }, + "underline": { "description": "Controls when the link should have an underline." }, + "variant": { "description": "Applies the theme link styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, diff --git a/docs/translations/api-docs-joy/list-divider/list-divider.json b/docs/translations/api-docs-joy/list-divider/list-divider.json index 606b38f2d89c64..7458038f8cdbf2 100644 --- a/docs/translations/api-docs-joy/list-divider/list-divider.json +++ b/docs/translations/api-docs-joy/list-divider/list-divider.json @@ -1,47 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "inset": { - "description": "The empty space on the side(s) of the divider in a vertical list.
    For horizontal list (the nearest parent List has row prop set to true), only inset="gutter" affects the list divider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The empty space on the side(s) of the divider in a vertical list.
    For horizontal list (the nearest parent List has row prop set to true), only inset="gutter" affects the list divider." }, + "orientation": { "description": "The component orientation." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/list-item-button/list-item-button.json b/docs/translations/api-docs-joy/list-item-button/list-item-button.json index bb589dbd42b192..97258a922a9b88 100644 --- a/docs/translations/api-docs-joy/list-item-button/list-item-button.json +++ b/docs/translations/api-docs-joy/list-item-button/list-item-button.json @@ -2,82 +2,31 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "autoFocus": { - "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true." }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The content direction flow.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selected": { - "description": "If true, the component is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, + "orientation": { "description": "The content direction flow." }, + "selected": { "description": "If true, the component is selected." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/list-item-content/list-item-content.json b/docs/translations/api-docs-joy/list-item-content/list-item-content.json index d51cca9ec95c84..180d5e47af86cd 100644 --- a/docs/translations/api-docs-joy/list-item-content/list-item-content.json +++ b/docs/translations/api-docs-joy/list-item-content/list-item-content.json @@ -1,35 +1,14 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json b/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json index d51cca9ec95c84..180d5e47af86cd 100644 --- a/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json +++ b/docs/translations/api-docs-joy/list-item-decorator/list-item-decorator.json @@ -1,35 +1,14 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/list-item/list-item.json b/docs/translations/api-docs-joy/list-item/list-item.json index 87cf2986696ec4..37cc7528f07804 100644 --- a/docs/translations/api-docs-joy/list-item/list-item.json +++ b/docs/translations/api-docs-joy/list-item/list-item.json @@ -1,71 +1,26 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endAction": { - "description": "The element to display at the end of ListItem.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "nested": { - "description": "If true, the component can contain NestedList.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startAction": { - "description": "The element to display at the start of ListItem.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "endAction": { "description": "The element to display at the end of ListItem." }, + "nested": { "description": "If true, the component can contain NestedList." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startAction": { "description": "The element to display at the start of ListItem." }, "sticky": { - "description": "If true, the component has sticky position (with top = 0).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component has sticky position (with top = 0)." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/list-subheader/list-subheader.json b/docs/translations/api-docs-joy/list-subheader/list-subheader.json index ab913c634cc91a..70fe1240cc6efd 100644 --- a/docs/translations/api-docs-joy/list-subheader/list-subheader.json +++ b/docs/translations/api-docs-joy/list-subheader/list-subheader.json @@ -1,53 +1,23 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sticky": { - "description": "If true, the component has sticky position (with top = 0).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component has sticky position (with top = 0)." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/list/list.json b/docs/translations/api-docs-joy/list/list.json index 64c83152a59a41..1797fcadc39452 100644 --- a/docs/translations/api-docs-joy/list/list.json +++ b/docs/translations/api-docs-joy/list/list.json @@ -1,65 +1,25 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component (affect other nested list* components).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "orientation": { "description": "The component orientation." }, + "size": { "description": "The size of the component (affect other nested list* components)." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." }, "wrap": { - "description": "Only for horizontal list. If true, the list sets the flex-wrap to "wrap" and adjust margin to have gap-like behavior (will move to gap in the future).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Only for horizontal list. If true, the list sets the flex-wrap to "wrap" and adjust margin to have gap-like behavior (will move to gap in the future)." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/menu-item/menu-item.json b/docs/translations/api-docs-joy/menu-item/menu-item.json index c4d6c30edb75df..34661f5fb110a1 100644 --- a/docs/translations/api-docs-joy/menu-item/menu-item.json +++ b/docs/translations/api-docs-joy/menu-item/menu-item.json @@ -1,47 +1,16 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The content direction flow.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selected": { - "description": "If true, the component is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, + "orientation": { "description": "The content direction flow." }, + "selected": { "description": "If true, the component is selected." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/menu-list/menu-list.json b/docs/translations/api-docs-joy/menu-list/menu-list.json index 6d15b1b978cea1..c675e69cbe9074 100644 --- a/docs/translations/api-docs-joy/menu-list/menu-list.json +++ b/docs/translations/api-docs-joy/menu-list/menu-list.json @@ -2,58 +2,27 @@ "componentDescription": "", "propDescriptions": { "actions": { - "description": "A ref with imperative actions. It allows to select the first or last menu item.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref with imperative actions. It allows to select the first or last menu item." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "onItemsChange": { - "description": "Function called when the items displayed in the menu change.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Function called when the items displayed in the menu change." }, "size": { - "description": "The size of the component (affect other nested list* components because the Menu inherits List).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component (affect other nested list* components because the Menu inherits List)." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/menu/menu.json b/docs/translations/api-docs-joy/menu/menu.json index 50073dd95c3cdd..b1ea395bae229c 100644 --- a/docs/translations/api-docs-joy/menu/menu.json +++ b/docs/translations/api-docs-joy/menu/menu.json @@ -2,100 +2,44 @@ "componentDescription": "", "propDescriptions": { "actions": { - "description": "A ref with imperative actions. It allows to select the first or last menu item.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref with imperative actions. It allows to select the first or last menu item." }, "anchorEl": { - "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, "invertedColors": { - "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper." }, "modifiers": { - "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onClose": { - "description": "Triggered when focus leaves the menu and the menu should close.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation." }, + "onClose": { "description": "Triggered when focus leaves the menu and the menu should close." }, "onItemsChange": { - "description": "Function called when the items displayed in the menu change.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "Controls whether the menu is displayed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Function called when the items displayed in the menu change." }, + "open": { "description": "Controls whether the menu is displayed." }, "size": { - "description": "The size of the component (affect other nested list* components because the Menu inherits List).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component (affect other nested list* components because the Menu inherits List)." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/modal-close/modal-close.json b/docs/translations/api-docs-joy/modal-close/modal-close.json index edcda443e8c2bb..83b7efa6fd7454 100644 --- a/docs/translations/api-docs-joy/modal-close/modal-close.json +++ b/docs/translations/api-docs-joy/modal-close/modal-close.json @@ -2,46 +2,19 @@ "componentDescription": "", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json b/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json index e23b19c13fa444..cae7596ad9bf5e 100644 --- a/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json +++ b/docs/translations/api-docs-joy/modal-dialog/modal-dialog.json @@ -1,59 +1,22 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "layout": { - "description": "The layout of the dialog", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "layout": { "description": "The layout of the dialog" }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json b/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json index 4bd0a4c5670f12..fbea6a65425844 100644 --- a/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json +++ b/docs/translations/api-docs-joy/modal-overflow/modal-overflow.json @@ -2,10 +2,7 @@ "componentDescription": "", "propDescriptions": { "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/modal/modal.json b/docs/translations/api-docs-joy/modal/modal.json index 681838115ae4ac..36cad5e594c33e 100644 --- a/docs/translations/api-docs-joy/modal/modal.json +++ b/docs/translations/api-docs-joy/modal/modal.json @@ -3,102 +3,46 @@ "propDescriptions": { "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time." }, "disableAutoFocus": { - "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEnforceFocus": { - "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEscapeKeyDown": { - "description": "If true, hitting escape will not fire the onClose callback.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, hitting escape will not fire the onClose callback." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, "disableRestoreFocus": { - "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableScrollLock": { - "description": "Disable the scroll lock behavior.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "hideBackdrop": { - "description": "If true, the backdrop is not rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted." }, + "disableScrollLock": { "description": "Disable the scroll lock behavior." }, + "hideBackdrop": { "description": "If true, the backdrop is not rendered." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal." }, "onClose": { "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "escapeKeyDown", "backdropClick", "closeClick"." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/option/option.json b/docs/translations/api-docs-joy/option/option.json index 6a52cb56849bf0..c673ecf02e29c5 100644 --- a/docs/translations/api-docs-joy/option/option.json +++ b/docs/translations/api-docs-joy/option/option.json @@ -1,65 +1,25 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, "label": { - "description": "A text representation of the option's content. Used for keyboard text navigation matching.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A text representation of the option's content. Used for keyboard text navigation matching." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "value": { - "description": "The option value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "value": { "description": "The option value." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/radio-group/radio-group.json b/docs/translations/api-docs-joy/radio-group/radio-group.json index 43cdbde07439d1..68c8c55ea390ae 100644 --- a/docs/translations/api-docs-joy/radio-group/radio-group.json +++ b/docs/translations/api-docs-joy/radio-group/radio-group.json @@ -1,97 +1,43 @@ { "componentDescription": "", "propDescriptions": { - "className": { - "description": "Class name applied to the root element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "className": { "description": "Class name applied to the root element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, "disableIcon": { - "description": "The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The radio's disabledIcon prop. If specified, the value is passed down to every radios under this element." }, "name": { - "description": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The name used to reference the value of the control. If you don't provide this prop, it falls back to a randomly generated name." }, "onChange": { "description": "Callback fired when a radio button is selected.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." } }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "orientation": { "description": "The component orientation." }, "overlay": { - "description": "The radio's overlay prop. If specified, the value is passed down to every radios under this element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The radio's overlay prop. If specified, the value is passed down to every radios under this element." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "Value of the selected radio button. The DOM API casts this to a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Value of the selected radio button. The DOM API casts this to a string." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/radio/radio.json b/docs/translations/api-docs-joy/radio/radio.json index 9dcad533e7cb8c..5e9a7a1a263f12 100644 --- a/docs/translations/api-docs-joy/radio/radio.json +++ b/docs/translations/api-docs-joy/radio/radio.json @@ -1,133 +1,47 @@ { "componentDescription": "", "propDescriptions": { - "checked": { - "description": "If true, the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "checkedIcon": { - "description": "The icon to display when the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "className": { - "description": "Class name applied to the root element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component is checked." }, + "checkedIcon": { "description": "The icon to display when the component is checked." }, + "className": { "description": "Class name applied to the root element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultChecked": { - "description": "The default checked state. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default checked state. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, "disableIcon": { - "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "The label element at the end the radio.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "The name attribute of the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the checked icon is removed and the selected variant is applied on the action element instead." }, + "label": { "description": "The label element at the end the radio." }, + "name": { "description": "The name attribute of the input." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." } }, "overlay": { - "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "readOnly": { - "description": "If true, the component is read only.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the root element's position is set to initial which allows the action area to fill the nearest positioned parent. This prop is useful for composing Radio with ListItem component." }, + "readOnly": { "description": "If true, the component is read only." }, "required": { - "description": "If true, the input element is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "uncheckedIcon": { - "description": "The icon to display when the component is not checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "value": { - "description": "The value of the component. The DOM API casts this to a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "uncheckedIcon": { "description": "The icon to display when the component is not checked." }, + "value": { "description": "The value of the component. The DOM API casts this to a string." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json b/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json index 6b5d8d81050e1b..0c1ebe20935687 100644 --- a/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json +++ b/docs/translations/api-docs-joy/scoped-css-baseline/scoped-css-baseline.json @@ -1,41 +1,17 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "You can wrap a node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "You can wrap a node." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disableColorScheme": { - "description": "Disable color-scheme CSS property. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Disable color-scheme CSS property. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme" }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/select/select.json b/docs/translations/api-docs-joy/select/select.json index ffe0d576c9ef0b..d6d3565005254c 100644 --- a/docs/translations/api-docs-joy/select/select.json +++ b/docs/translations/api-docs-joy/select/select.json @@ -2,148 +2,58 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "autoFocus": { - "description": "If true, the select element is focused during the first mount", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the select element is focused during the first mount" }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultListboxOpen": { - "description": "If true, the select will be initially open.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the select will be initially open." }, "defaultValue": { - "description": "The default selected value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Trailing adornment for the select.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default selected value. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "Trailing adornment for the select." }, "getSerializedValue": { - "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form." }, "indicator": { - "description": "The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The indicator(*) for the select. ________________ [ value * ] ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾" }, "listboxId": { - "description": "id attribute of the listbox element. Also used to derive the id attributes of options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "listboxOpen": { - "description": "Controls the open state of the select's listbox.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "id attribute of the listbox element. Also used to derive the id attributes of options." }, + "listboxOpen": { "description": "Controls the open state of the select's listbox." }, "name": { - "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback fired when an option is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onClose": { - "description": "Triggered when focus leaves the menu and the menu should close.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Name of the element. For example used by the server to identify the fields in form submits. If the name is provided, the component will render a hidden input element that can be submitted to a server." }, + "onChange": { "description": "Callback fired when an option is selected." }, + "onClose": { "description": "Triggered when focus leaves the menu and the menu should close." }, "onListboxOpenChange": { - "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "placeholder": { - "description": "Text to show when there is no selected value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the component requests to be opened. Use in controlled mode (see listboxOpen)." }, + "placeholder": { "description": "Text to show when there is no selected value." }, "renderValue": { - "description": "Function that customizes the rendering of the selected value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Leading adornment for the select.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Function that customizes the rendering of the selected value." }, + "size": { "description": "The size of the component." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Leading adornment for the select." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The selected value. Set to null to deselect all options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The selected value. Set to null to deselect all options." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/sheet/sheet.json b/docs/translations/api-docs-joy/sheet/sheet.json index e5d15a4f55fb82..73130ad01cdec1 100644 --- a/docs/translations/api-docs-joy/sheet/sheet.json +++ b/docs/translations/api-docs-joy/sheet/sheet.json @@ -1,53 +1,23 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "invertedColors": { - "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children with an implicit color prop invert their colors to match the component's variant and color." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/slider/slider.json b/docs/translations/api-docs-joy/slider/slider.json index a08817cdcb5163..217b9d1c8c8f19 100644 --- a/docs/translations/api-docs-joy/slider/slider.json +++ b/docs/translations/api-docs-joy/slider/slider.json @@ -1,103 +1,50 @@ { "componentDescription": "", "propDescriptions": { - "aria-label": { - "description": "The label of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "aria-label": { "description": "The label of the slider." }, "aria-valuetext": { - "description": "A string value that provides a user-friendly name for the current value of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A string value that provides a user-friendly name for the current value of the slider." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, "disableSwap": { - "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb." }, "getAriaLabel": { "description": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.", - "notes": "", - "deprecated": "", "typeDescriptions": { "index": "The thumb label's index to format." } }, "getAriaValueText": { "description": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.", - "notes": "", - "deprecated": "", "typeDescriptions": { "value": "The thumb label's value to format.", "index": "The thumb label's index to format." } }, "isRtl": { - "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side)." }, "marks": { - "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys." }, "max": { - "description": "The maximum allowed value of the slider. Should not be equal to min.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The maximum allowed value of the slider. Should not be equal to min." }, "min": { - "description": "The minimum allowed value of the slider. Should not be equal to max.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the hidden input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The minimum allowed value of the slider. Should not be equal to max." }, + "name": { "description": "Name attribute of the hidden input element." }, "onChange": { "description": "Callback function that is fired when the slider's value changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event not a change event.", "value": "The new value.", @@ -106,90 +53,39 @@ }, "onChangeCommitted": { "description": "Callback function that is fired when the mouseup is triggered.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. Warning: This is a generic event not a change event.", "value": "The new value." } }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "scale": { - "description": "A transformation function, to change the scale of the slider.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "orientation": { "description": "The component orientation." }, + "scale": { "description": "A transformation function, to change the scale of the slider." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "step": { - "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
    When step is null, the thumb can only be slid onto marks provided with the marks prop." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "tabIndex": { - "description": "Tab index attribute of the hidden input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "tabIndex": { "description": "Tab index attribute of the hidden input element." }, "track": { - "description": "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.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "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": { - "description": "The value of the slider. For ranged sliders, provide an array with two values.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the slider. For ranged sliders, provide an array with two values." }, "valueLabelDisplay": { - "description": "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.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "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": { - "description": "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", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "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" }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/stack/stack.json b/docs/translations/api-docs-joy/stack/stack.json index 752ee1db26273d..824be2b9abaa72 100644 --- a/docs/translations/api-docs-joy/stack/stack.json +++ b/docs/translations/api-docs-joy/stack/stack.json @@ -1,47 +1,20 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "direction": { - "description": "Defines the flex-direction style property. It is applied for all screen sizes.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "divider": { - "description": "Add an element between each child.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "spacing": { - "description": "Defines the space between immediate children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the flex-direction style property. It is applied for all screen sizes." }, + "divider": { "description": "Add an element between each child." }, + "spacing": { "description": "Defines the space between immediate children." }, "sx": { - "description": "The system prop, which allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop, which allows defining system overrides as well as additional CSS styles." }, "useFlexGap": { - "description": "If true, the CSS flexbox gap is used instead of applying margin to children.
    While CSS gap removes the known limitations, it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
    To enable this flag globally, follow the theme's default props configuration.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the CSS flexbox gap is used instead of applying margin to children.
    While CSS gap removes the known limitations, it is not fully supported in some browsers. We recommend checking https://caniuse.com/?search=flex%20gap before using this flag.
    To enable this flag globally, follow the theme's default props configuration." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } }, diff --git a/docs/translations/api-docs-joy/svg-icon/svg-icon.json b/docs/translations/api-docs-joy/svg-icon/svg-icon.json index 6e169bdb057dd9..9879a566d63e1e 100644 --- a/docs/translations/api-docs-joy/svg-icon/svg-icon.json +++ b/docs/translations/api-docs-joy/svg-icon/svg-icon.json @@ -1,77 +1,33 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "Node passed into the SVG element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "Node passed into the SVG element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component. You can use the htmlColor prop to apply a color attribute to the SVG element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component. You can use the htmlColor prop to apply a color attribute to the SVG element." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "fontSize": { - "description": "The fontSize applied to the icon. Defaults to 1rem, but can be configure to inherit font size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "htmlColor": { - "description": "Applies a color attribute to the SVG element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The fontSize applied to the icon. Defaults to 1rem, but can be configure to inherit font size." }, + "htmlColor": { "description": "Applies a color attribute to the SVG element." }, "inheritViewBox": { - "description": "If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored. Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored. Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node." }, "shapeRendering": { - "description": "The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "titleAccess": { - "description": "Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent" }, "viewBox": { - "description": "Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/switch/switch.json b/docs/translations/api-docs-joy/switch/switch.json index ab8600c3bc828b..b8419420132fb7 100644 --- a/docs/translations/api-docs-joy/switch/switch.json +++ b/docs/translations/api-docs-joy/switch/switch.json @@ -1,97 +1,37 @@ { "componentDescription": "", "propDescriptions": { - "checked": { - "description": "If true, the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component is checked." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultChecked": { - "description": "The default checked state. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "The element that appears at the end of the switch.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default checked state. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, + "endDecorator": { "description": "The element that appears at the end of the switch." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean)." } }, - "readOnly": { - "description": "If true, the component is read only.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "readOnly": { "description": "If true, the component is read only." }, "required": { - "description": "If true, the input element is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "The element that appears at the end of the switch.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "The element that appears at the end of the switch." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/tab-list/tab-list.json b/docs/translations/api-docs-joy/tab-list/tab-list.json index b87b9430065900..eeb233426021bd 100644 --- a/docs/translations/api-docs-joy/tab-list/tab-list.json +++ b/docs/translations/api-docs-joy/tab-list/tab-list.json @@ -2,52 +2,22 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "Used to render icon or text elements inside the TabList if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the TabList if src is not set. This can be an element, or just a string." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/tab-panel/tab-panel.json b/docs/translations/api-docs-joy/tab-panel/tab-panel.json index b8581e49903744..0f4cef86598fc4 100644 --- a/docs/translations/api-docs-joy/tab-panel/tab-panel.json +++ b/docs/translations/api-docs-joy/tab-panel/tab-panel.json @@ -1,47 +1,18 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/tab/tab.json b/docs/translations/api-docs-joy/tab/tab.json index a7ae078050375f..1de61c308d5bb5 100644 --- a/docs/translations/api-docs-joy/tab/tab.json +++ b/docs/translations/api-docs-joy/tab/tab.json @@ -2,70 +2,27 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback invoked when new value is being set.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The content direction flow.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "onChange": { "description": "Callback invoked when new value is being set." }, + "orientation": { "description": "The content direction flow." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "You can provide your own value. Otherwise, it falls back to the child position index.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "You can provide your own value. Otherwise, it falls back to the child position index." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/table/table.json b/docs/translations/api-docs-joy/table/table.json index edd2cba91179fb..1b074de73d5d19 100644 --- a/docs/translations/api-docs-joy/table/table.json +++ b/docs/translations/api-docs-joy/table/table.json @@ -1,89 +1,37 @@ { "componentDescription": "", "propDescriptions": { - "borderAxis": { - "description": "The axis to display a border on the table cell.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "Children of the table", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "borderAxis": { "description": "The axis to display a border on the table cell." }, + "children": { "description": "Children of the table" }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "hoverRow": { - "description": "If true, the table row will shade on hover.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "hoverRow": { "description": "If true, the table row will shade on hover." }, "noWrap": { - "description": "If true, the body cells will not wrap, but instead will truncate with a text overflow ellipsis.
    Note: Header cells are always truncated with overflow ellipsis.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the body cells will not wrap, but instead will truncate with a text overflow ellipsis.
    Note: Header cells are always truncated with overflow ellipsis." }, "size": { - "description": "The size of the component. It accepts theme values between 'sm' and 'lg'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. It accepts theme values between 'sm' and 'lg'." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "stickyFooter": { - "description": "If true, the footer always appear at the bottom of the overflow table.
    ⚠️ It doesn't work with IE11.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the footer always appear at the bottom of the overflow table.
    ⚠️ It doesn't work with IE11." }, "stickyHeader": { - "description": "If true, the header always appear at the top of the overflow table.
    ⚠️ It doesn't work with IE11.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the header always appear at the top of the overflow table.
    ⚠️ It doesn't work with IE11." }, "stripe": { - "description": "The odd or even row of the table body will have subtle background color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The odd or even row of the table body will have subtle background color." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/tabs/tabs.json b/docs/translations/api-docs-joy/tabs/tabs.json index 6cd6ae24f9e0c9..fc37e2929a851d 100644 --- a/docs/translations/api-docs-joy/tabs/tabs.json +++ b/docs/translations/api-docs-joy/tabs/tabs.json @@ -1,89 +1,33 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "direction": { - "description": "The direction of the text.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onChange": { - "description": "Callback invoked when new value is being set.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation (layout flow direction).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "direction": { "description": "The direction of the text." }, + "onChange": { "description": "Callback invoked when new value is being set." }, + "orientation": { "description": "The component orientation (layout flow direction)." }, "selectionFollowsFocus": { - "description": "If true the selected tab changes on focus. Otherwise it only changes on activation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true the selected tab changes on focus. Otherwise it only changes on activation." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to null." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/textarea/textarea.json b/docs/translations/api-docs-joy/textarea/textarea.json index a6794637e681bf..969e028c74335d 100644 --- a/docs/translations/api-docs-joy/textarea/textarea.json +++ b/docs/translations/api-docs-joy/textarea/textarea.json @@ -2,58 +2,21 @@ "componentDescription": "", "propDescriptions": { "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Trailing adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, + "endDecorator": { "description": "Trailing adornment for this input." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "maxRows": { - "description": "Maximum number of rows to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "minRows": { - "description": "Minimum number of rows to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Leading adornment for this input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "maxRows": { "description": "Maximum number of rows to display." }, + "minRows": { "description": "Minimum number of rows to display." }, + "size": { "description": "The size of the component." }, + "startDecorator": { "description": "Leading adornment for this input." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/tooltip/tooltip.json b/docs/translations/api-docs-joy/tooltip/tooltip.json index 34f1d0cac4be3b..ba9881dd695328 100644 --- a/docs/translations/api-docs-joy/tooltip/tooltip.json +++ b/docs/translations/api-docs-joy/tooltip/tooltip.json @@ -1,185 +1,75 @@ { "componentDescription": "", "propDescriptions": { - "arrow": { - "description": "If true, adds an arrow to the tooltip.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "Tooltip reference element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "arrow": { "description": "If true, adds an arrow to the tooltip." }, + "children": { "description": "Tooltip reference element." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "describeChild": { - "description": "Set to true if the title acts as an accessible description. By default the title acts as an accessible label for the child.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "direction": { - "description": "Direction of the text.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableFocusListener": { - "description": "Do not respond to focus-visible events.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableHoverListener": { - "description": "Do not respond to hover events.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Set to true if the title acts as an accessible description. By default the title acts as an accessible label for the child." }, + "direction": { "description": "Direction of the text." }, + "disableFocusListener": { "description": "Do not respond to focus-visible events." }, + "disableHoverListener": { "description": "Do not respond to hover events." }, "disableInteractive": { - "description": "Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the leaveDelay is expired.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Makes a tooltip not interactive, i.e. it will close when the user hovers over the tooltip before the leaveDelay is expired." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableTouchListener": { - "description": "Do not respond to long press touch events.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, + "disableTouchListener": { "description": "Do not respond to long press touch events." }, "enterDelay": { - "description": "The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds to wait before showing the tooltip. This prop won't impact the enter touch delay (enterTouchDelay)." }, "enterNextDelay": { - "description": "The number of milliseconds to wait before showing the tooltip when one was already recently opened.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds to wait before showing the tooltip when one was already recently opened." }, "enterTouchDelay": { - "description": "The number of milliseconds a user must touch the element before showing the tooltip.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds a user must touch the element before showing the tooltip." }, "followCursor": { - "description": "If true, the tooltip follow the cursor over the wrapped element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the tooltip follow the cursor over the wrapped element." }, "id": { - "description": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper." }, "leaveDelay": { - "description": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds to wait before hiding the tooltip. This prop won't impact the leave touch delay (leaveTouchDelay)." }, "leaveTouchDelay": { - "description": "The number of milliseconds after the user stops touching an element before hiding the tooltip.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The number of milliseconds after the user stops touching an element before hiding the tooltip." }, "modifiers": { - "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers".
    A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation." }, "onClose": { "description": "Callback fired when the component requests to be closed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, "onOpen": { "description": "Callback fired when the component requests to be open.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "placement": { - "description": "Tooltip placement.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, + "placement": { "description": "Tooltip placement." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "title": { - "description": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Tooltip title. Zero-length titles string, undefined, null and false are never displayed." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs-joy/typography/typography.json b/docs/translations/api-docs-joy/typography/typography.json index d9ca8e568da74a..7089fe3747aab0 100644 --- a/docs/translations/api-docs-joy/typography/typography.json +++ b/docs/translations/api-docs-joy/typography/typography.json @@ -1,89 +1,31 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endDecorator": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "gutterBottom": { - "description": "If true, the text will have a bottom margin.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "level": { - "description": "Applies the theme typography styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "endDecorator": { "description": "Element placed after the children." }, + "gutterBottom": { "description": "If true, the text will have a bottom margin." }, + "level": { "description": "Applies the theme typography styles." }, "levelMapping": { - "description": "The component maps the variant prop to a range of different HTML element types. For instance, body1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component maps the variant prop to a range of different HTML element types. For instance, body1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop." }, "noWrap": { - "description": "If true, the text will not wrap, but instead will truncate with a text overflow ellipsis.
    Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slots": { - "description": "The components used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startDecorator": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the text will not wrap, but instead will truncate with a text overflow ellipsis.
    Note that text overflow can only happen with block or inline-block level elements (the element needs to have a width in order to overflow)." }, + "slotProps": { "description": "The props used for each slot inside." }, + "slots": { "description": "The components used for each slot inside." }, + "startDecorator": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "textColor": { - "description": "The system color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "textColor": { "description": "The system color." }, "variant": { - "description": "The global variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The global variant to use." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/accordion-actions/accordion-actions.json b/docs/translations/api-docs/accordion-actions/accordion-actions.json index ce01b36ba37df7..ba5d02f2cdc875 100644 --- a/docs/translations/api-docs/accordion-actions/accordion-actions.json +++ b/docs/translations/api-docs/accordion-actions/accordion-actions.json @@ -1,29 +1,13 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableSpacing": { - "description": "If true, the actions do not have additional margin.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the actions do not have additional margin." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/accordion-details/accordion-details.json b/docs/translations/api-docs/accordion-details/accordion-details.json index 3fc8ceebe8157c..47c76653e72eda 100644 --- a/docs/translations/api-docs/accordion-details/accordion-details.json +++ b/docs/translations/api-docs/accordion-details/accordion-details.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/accordion-summary/accordion-summary.json b/docs/translations/api-docs/accordion-summary/accordion-summary.json index 0e39351bea76de..0ba64f281fe68c 100644 --- a/docs/translations/api-docs/accordion-summary/accordion-summary.json +++ b/docs/translations/api-docs/accordion-summary/accordion-summary.json @@ -1,35 +1,14 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "expandIcon": { - "description": "The icon to display as the expand indicator.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "expandIcon": { "description": "The icon to display as the expand indicator." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/accordion/accordion.json b/docs/translations/api-docs/accordion/accordion.json index b4b389eb4678cd..c371d0db1ac274 100644 --- a/docs/translations/api-docs/accordion/accordion.json +++ b/docs/translations/api-docs/accordion/accordion.json @@ -1,74 +1,32 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "defaultExpanded": { - "description": "If true, expands the accordion by default.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "defaultExpanded": { "description": "If true, expands the accordion by default." }, + "disabled": { "description": "If true, the component is disabled." }, "disableGutters": { - "description": "If true, it removes the margin between two expanded accordion items and the increase of height.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, it removes the margin between two expanded accordion items and the increase of height." }, "expanded": { - "description": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, expands the accordion, otherwise collapse it. Setting this prop enables control over the accordion." }, "onChange": { "description": "Callback fired when the expand/collapse state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. Warning: This is a generic event not a change event.", "expanded": "The expanded state of the accordion." } }, - "square": { - "description": "If true, rounded corners are disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "square": { "description": "If true, rounded corners are disabled." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "TransitionComponent": { - "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component." }, "TransitionProps": { - "description": "Props applied to the transition element. By default, the element is based on this Transition component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the transition element. By default, the element is based on this Transition component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/alert-title/alert-title.json b/docs/translations/api-docs/alert-title/alert-title.json index 3fc8ceebe8157c..47c76653e72eda 100644 --- a/docs/translations/api-docs/alert-title/alert-title.json +++ b/docs/translations/api-docs/alert-title/alert-title.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/alert/alert.json b/docs/translations/api-docs/alert/alert.json index 1d357ab0b6fc53..b0ba4c28f54a16 100644 --- a/docs/translations/api-docs/alert/alert.json +++ b/docs/translations/api-docs/alert/alert.json @@ -2,101 +2,46 @@ "componentDescription": "", "propDescriptions": { "action": { - "description": "The action to display. It renders after the message, at the end of the alert.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The action to display. It renders after the message, at the end of the alert." }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "closeText": { - "description": "Override the default label for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default label for the close popup icon button.
    For localization purposes, you can use the provided translations." }, "color": { - "description": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "icon": { - "description": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon." }, "iconMapping": { - "description": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed." }, "onClose": { "description": "Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "role": { - "description": "The ARIA role attribute of the element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "role": { "description": "The ARIA role attribute of the element." }, "severity": { - "description": "The severity of the alert. This defines the color and icon used.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The severity of the alert. This defines the color and icon used." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/app-bar/app-bar.json b/docs/translations/api-docs/app-bar/app-bar.json index e7b5e251937a5a..a97d9f1f193003 100644 --- a/docs/translations/api-docs/app-bar/app-bar.json +++ b/docs/translations/api-docs/app-bar/app-bar.json @@ -1,41 +1,19 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "enableColorOnDark": { - "description": "If true, the color prop is applied in dark mode.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the color prop is applied in dark mode." }, "position": { - "description": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The positioning type. The behavior of the different options is described in the MDN web docs. Note: sticky is not universally supported and will fall back to static when unavailable." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/autocomplete/autocomplete.json b/docs/translations/api-docs/autocomplete/autocomplete.json index f4e30f92fb1907..0f79d4089e14b4 100644 --- a/docs/translations/api-docs/autocomplete/autocomplete.json +++ b/docs/translations/api-docs/autocomplete/autocomplete.json @@ -2,252 +2,117 @@ "componentDescription": "", "propDescriptions": { "autoComplete": { - "description": "If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the portion of the selected suggestion that has not been typed by the user, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state." }, "autoHighlight": { - "description": "If true, the first option is automatically highlighted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the first option is automatically highlighted." }, "autoSelect": { - "description": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
    When using freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
    When using freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option." }, "blurOnSelect": { - "description": "Control if the input should be blurred when an option is selected:
    - false the input is not blurred. - true the input is always blurred. - touch the input is blurred after a touch event. - mouse the input is blurred after a mouse event.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Control if the input should be blurred when an option is selected:
    - false the input is not blurred. - true the input is always blurred. - touch the input is blurred after a touch event. - mouse the input is blurred after a mouse event." }, "ChipProps": { - "description": "Props applied to the Chip element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "clearIcon": { - "description": "The icon to display in place of the default clear icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Chip element." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "clearIcon": { "description": "The icon to display in place of the default clear icon." }, "clearOnBlur": { - "description": "If true, the input's text is cleared on blur if no value is selected.
    Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume their search.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input's text is cleared on blur if no value is selected.
    Set to true if you want to help the user enter a new value. Set to false if you want to help the user resume their search." }, "clearOnEscape": { - "description": "If true, clear all values when the user presses escape and the popup is closed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, clear all values when the user presses escape and the popup is closed." }, "clearText": { - "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the clear icon button.
    For localization purposes, you can use the provided translations." }, "closeText": { - "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "componentsProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the close popup icon button.
    For localization purposes, you can use the provided translations." }, + "componentsProps": { "description": "The props used for each slot inside." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableClearable": { - "description": "If true, the input can't be cleared.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, + "disableClearable": { "description": "If true, the input can't be cleared." }, "disableCloseOnSelect": { - "description": "If true, the popup won't close when a value is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the popup won't close when a value is selected." }, + "disabled": { "description": "If true, the component is disabled." }, "disabledItemsFocusable": { - "description": "If true, will allow focus on disabled items.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, will allow focus on disabled items." }, "disableListWrap": { - "description": "If true, the list box in the popup will not wrap focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list box in the popup will not wrap focus." }, "disablePortal": { - "description": "If true, the Popper content will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the Popper content will be under the DOM hierarchy of the parent component." }, "filterOptions": { "description": "A function that determines the filtered options to be rendered on search.", - "notes": "", - "deprecated": "", "typeDescriptions": { "options": "The options to render.", "state": "The state of the component." } }, "filterSelectedOptions": { - "description": "If true, hide the selected options from the list box.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "forcePopupIcon": { - "description": "Force the visibility display of the popup icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, hide the selected options from the list box." }, + "forcePopupIcon": { "description": "Force the visibility display of the popup icon." }, "freeSolo": { - "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options." }, "fullWidth": { - "description": "If true, the input will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will take up the full width of its container." }, "getLimitTagsText": { "description": "The label to display when the tags are truncated (limitTags).", - "notes": "", - "deprecated": "", "typeDescriptions": { "more": "The number of truncated tags." } }, "getOptionDisabled": { "description": "Used to determine the disabled state for a given option.", - "notes": "", - "deprecated": "", "typeDescriptions": { "option": "The option to test." } }, "getOptionLabel": { - "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
    If used in free solo mode, it must accept both the type of the options and a string." }, "groupBy": { "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided.", - "notes": "", - "deprecated": "", "typeDescriptions": { "options": "The options to group." } }, "handleHomeEndKeys": { - "description": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively." }, "id": { - "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one." }, "includeInputInList": { - "description": "If true, the highlight can move to the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputValue": { - "description": "The input value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the highlight can move to the input." }, + "inputValue": { "description": "The input value." }, "isOptionEqualToValue": { "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.", - "notes": "", - "deprecated": "", "typeDescriptions": { "option": "The option to test.", "value": "The value to test against." } }, "limitTags": { - "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "ListboxComponent": { - "description": "The component used to render the listbox.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "ListboxProps": { - "description": "Props applied to the Listbox element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The maximum number of tags that will be visible when not focused. Set -1 to disable the limit." }, + "ListboxComponent": { "description": "The component used to render the listbox." }, + "ListboxProps": { "description": "Props applied to the Listbox element." }, "loading": { - "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is in a loading state. This shows the loadingText in place of suggestions (only if there are no suggestions to show, e.g. options are empty)." }, "loadingText": { - "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Text to display when in a loading state.
    For localization purposes, you can use the provided translations." }, "multiple": { - "description": "If true, value must be an array and the menu will support multiple selections.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, value must be an array and the menu will support multiple selections." }, "noOptionsText": { - "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Text to display when there are no options.
    For localization purposes, you can use the provided translations." }, "onChange": { "description": "Callback fired when the value changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "value": "The new value of the component.", @@ -256,8 +121,6 @@ }, "onClose": { "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "toggleInput", "escape", "selectOption", "removeOption", "blur"." @@ -265,8 +128,6 @@ }, "onHighlightChange": { "description": "Callback fired when the highlight option changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "option": "The highlighted option.", @@ -275,8 +136,6 @@ }, "onInputChange": { "description": "Callback fired when the input value changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "value": "The new value of the text input.", @@ -285,74 +144,27 @@ }, "onOpen": { "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "openOnFocus": { - "description": "If true, the popup will open on input focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, + "openOnFocus": { "description": "If true, the popup will open on input focus." }, "openText": { - "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "options": { - "description": "Array of options.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "PaperComponent": { - "description": "The component used to render the body of the popup.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "PopperComponent": { - "description": "The component used to position the popup.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "popupIcon": { - "description": "The icon to display in place of the default popup icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default text for the open popup icon button.
    For localization purposes, you can use the provided translations." }, + "options": { "description": "Array of options." }, + "PaperComponent": { "description": "The component used to render the body of the popup." }, + "PopperComponent": { "description": "The component used to position the popup." }, + "popupIcon": { "description": "The icon to display in place of the default popup icon." }, "readOnly": { - "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted." }, "renderGroup": { "description": "Render the group.", - "notes": "", - "deprecated": "", "typeDescriptions": { "params": "The group to render." } }, - "renderInput": { - "description": "Render the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "renderInput": { "description": "Render the input." }, "renderOption": { "description": "Render the option, use getOptionLabel by default.", - "notes": "", - "deprecated": "", "typeDescriptions": { "props": "The props to apply on the li element.", "option": "The option to render.", @@ -361,8 +173,6 @@ }, "renderTags": { "description": "Render the selected value.", - "notes": "", - "deprecated": "", "typeDescriptions": { "value": "The value provided to the component.", "getTagProps": "A tag props getter.", @@ -370,34 +180,15 @@ } }, "selectOnFocus": { - "description": "If true, the input's text is selected on focus. It helps the user clear the selected value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input's text is selected on focus. It helps the user clear the selected value." }, + "size": { "description": "The size of the component." }, + "slotProps": { "description": "The props used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the autocomplete.
    The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/avatar-group/avatar-group.json b/docs/translations/api-docs/avatar-group/avatar-group.json index 8b4cb651c03af9..6df3c90b4c0b01 100644 --- a/docs/translations/api-docs/avatar-group/avatar-group.json +++ b/docs/translations/api-docs/avatar-group/avatar-group.json @@ -1,66 +1,26 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The avatars to stack.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The avatars to stack." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "max": { - "description": "Max avatars to show before +x.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, + "max": { "description": "Max avatars to show before +x." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "spacing": { - "description": "Spacing between avatars.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, + "spacing": { "description": "Spacing between avatars." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "total": { - "description": "The total number of avatars. Used for calculating the number of extra avatars.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The total number of avatars. Used for calculating the number of extra avatars." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/avatar/avatar.json b/docs/translations/api-docs/avatar/avatar.json index a42fe440b87d72..93edc4ebf20a07 100644 --- a/docs/translations/api-docs/avatar/avatar.json +++ b/docs/translations/api-docs/avatar/avatar.json @@ -2,65 +2,29 @@ "componentDescription": "", "propDescriptions": { "alt": { - "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used in combination with src or srcSet to provide an alt attribute for the rendered img element." }, "children": { - "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "imgProps": { - "description": "Attributes applied to the img element if the component is used to display an image. It can be used to listen for the loading error event.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Attributes applied to the img element if the component is used to display an image. It can be used to listen for the loading error event." }, "sizes": { - "description": "The sizes attribute for the img element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "src": { - "description": "The src attribute for the img element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The sizes attribute for the img element." }, + "src": { "description": "The src attribute for the img element." }, "srcSet": { - "description": "The srcSet attribute for the img element. Use this attribute for responsive image display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The srcSet attribute for the img element. Use this attribute for responsive image display." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The shape of the avatar.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The shape of the avatar." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/backdrop/backdrop.json b/docs/translations/api-docs/backdrop/backdrop.json index 50c7e6cffa8e47..723fb5081fad9c 100644 --- a/docs/translations/api-docs/backdrop/backdrop.json +++ b/docs/translations/api-docs/backdrop/backdrop.json @@ -1,77 +1,35 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "invisible": { - "description": "If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the backdrop is invisible. It can be used when rendering a popover or a custom select component." }, + "open": { "description": "If true, the component is shown." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "TransitionComponent": { - "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component." }, "transitionDuration": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/badge/badge.json b/docs/translations/api-docs/badge/badge.json index c929116d12f027..77ef956e50fbc8 100644 --- a/docs/translations/api-docs/badge/badge.json +++ b/docs/translations/api-docs/badge/badge.json @@ -1,102 +1,36 @@ { "componentDescription": "", "propDescriptions": { - "anchorOrigin": { - "description": "The anchor of the badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "badgeContent": { - "description": "The content rendered within the badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The badge will be added relative to this node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "anchorOrigin": { "description": "The anchor of the badge." }, + "badgeContent": { "description": "The content rendered within the badge." }, + "children": { "description": "The badge will be added relative to this node." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "invisible": { - "description": "If true, the badge is invisible.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "max": { - "description": "Max count to show.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "overlap": { - "description": "Wrapped shape the badge should overlap.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, + "invisible": { "description": "If true, the badge is invisible." }, + "max": { "description": "Max count to show." }, + "overlap": { "description": "Wrapped shape the badge should overlap." }, "showZero": { - "description": "Controls whether the badge is hidden when badgeContent is zero.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Badge.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Controls whether the badge is hidden when badgeContent is zero." }, + "slotProps": { "description": "The props used for each slot inside the Badge." }, "slots": { - "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Badge. Either a string to use a HTML element or a component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json b/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json index 986ecbb50abbec..aa31a98f04a05f 100644 --- a/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json +++ b/docs/translations/api-docs/bottom-navigation-action/bottom-navigation-action.json @@ -2,46 +2,19 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "This prop isn't supported. Use the component prop if you need to change the children structure.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "icon": { - "description": "The icon to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "The label element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop isn't supported. Use the component prop if you need to change the children structure." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "icon": { "description": "The icon to display." }, + "label": { "description": "The label element." }, "showLabel": { - "description": "If true, the BottomNavigationAction will show its label. By default, only the selected BottomNavigationAction inside BottomNavigation will show its label.
    The prop defaults to the value (false) inherited from the parent BottomNavigation component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the BottomNavigationAction will show its label. By default, only the selected BottomNavigationAction inside BottomNavigation will show its label.
    The prop defaults to the value (false) inherited from the parent BottomNavigation component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "You can provide your own value. Otherwise, we fallback to the child position index.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "You can provide your own value. Otherwise, we fallback to the child position index." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json index bf840f57eb85e6..f2242e8318823f 100644 --- a/docs/translations/api-docs/bottom-navigation/bottom-navigation.json +++ b/docs/translations/api-docs/bottom-navigation/bottom-navigation.json @@ -1,50 +1,26 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "onChange": { "description": "Callback fired when the value changes.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. Warning: This is a generic event not a change event.", "value": "We default to the index of the child." } }, "showLabels": { - "description": "If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the currently selected BottomNavigationAction.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the currently selected BottomNavigationAction." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/box/box.json b/docs/translations/api-docs/box/box.json index c4ec7a90747529..ba74d84ab56606 100644 --- a/docs/translations/api-docs/box/box.json +++ b/docs/translations/api-docs/box/box.json @@ -2,16 +2,10 @@ "componentDescription": "", "propDescriptions": { "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json index eea322480d97c1..91a4d106aea93b 100644 --- a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json +++ b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json @@ -1,71 +1,30 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "expandText": { - "description": "Override the default label for the expand button.
    For localization purposes, you can use the provided translations.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default label for the expand button.
    For localization purposes, you can use the provided translations." }, "itemsAfterCollapse": { - "description": "If max items is exceeded, the number of items to show after the ellipsis.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If max items is exceeded, the number of items to show after the ellipsis." }, "itemsBeforeCollapse": { - "description": "If max items is exceeded, the number of items to show before the ellipsis.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If max items is exceeded, the number of items to show before the ellipsis." }, "maxItems": { - "description": "Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first itemsBeforeCollapse and last itemsAfterCollapse will be shown, with an ellipsis in between.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "separator": { - "description": "Custom separator node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Breadcumb.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first itemsBeforeCollapse and last itemsAfterCollapse will be shown, with an ellipsis in between." }, + "separator": { "description": "Custom separator node." }, + "slotProps": { "description": "The props used for each slot inside the Breadcumb." }, "slots": { - "description": "The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/button-base/button-base.json b/docs/translations/api-docs/button-base/button-base.json index 2aaf0908055da4..d71f29df82eaec 100644 --- a/docs/translations/api-docs/button-base/button-base.json +++ b/docs/translations/api-docs/button-base/button-base.json @@ -2,94 +2,42 @@ "componentDescription": "`ButtonBase` contains as few styles as possible.\nIt aims to be a simple building block for creating a button.\nIt contains a load of style reset and some focus/ripple logic.", "propDescriptions": { "action": { - "description": "A ref for imperative actions. It currently only supports focusVisible() action.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref for imperative actions. It currently only supports focusVisible() action." }, "centerRipple": { - "description": "If true, the ripples are centered. They won't start at the cursor interaction position.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the ripples are centered. They won't start at the cursor interaction position." }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, + "disabled": { "description": "If true, the component is disabled." }, "disableRipple": { - "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class." }, "disableTouchRipple": { - "description": "If true, the touch ripple effect is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the touch ripple effect is disabled." }, "focusRipple": { - "description": "If true, the base button will have a keyboard focus ripple.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the base button will have a keyboard focus ripple." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, "LinkComponent": { - "description": "The component used to render a link when the href prop is provided.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used to render a link when the href prop is provided." }, "onFocusVisible": { - "description": "Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "TouchRippleProps": { - "description": "Props applied to the TouchRipple element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "TouchRippleProps": { "description": "Props applied to the TouchRipple element." }, "touchRippleRef": { - "description": "A ref that points to the TouchRipple element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A ref that points to the TouchRipple element." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/button-group/button-group.json b/docs/translations/api-docs/button-group/button-group.json index 4b70c1307a237f..4f813acc0ba716 100644 --- a/docs/translations/api-docs/button-group/button-group.json +++ b/docs/translations/api-docs/button-group/button-group.json @@ -1,84 +1,33 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableElevation": { - "description": "If true, no elevation is used.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "disableElevation": { "description": "If true, no elevation is used." }, "disableFocusRipple": { - "description": "If true, the button keyboard focus ripple is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the button keyboard focus ripple is disabled." }, "disableRipple": { - "description": "If true, the button ripple effect is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the button ripple effect is disabled." }, "fullWidth": { - "description": "If true, the buttons will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation (layout flow direction).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the buttons will take up the full width of its container." }, + "orientation": { "description": "The component orientation (layout flow direction)." }, "size": { - "description": "The size of the component. small is equivalent to the dense button styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. small is equivalent to the dense button styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/button/button.json b/docs/translations/api-docs/button/button.json index f4336e26f95988..1b3ad4afdd098e 100644 --- a/docs/translations/api-docs/button/button.json +++ b/docs/translations/api-docs/button/button.json @@ -1,96 +1,37 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableElevation": { - "description": "If true, no elevation is used.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, + "disableElevation": { "description": "If true, no elevation is used." }, "disableFocusRipple": { - "description": "If true, the keyboard focus ripple is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the keyboard focus ripple is disabled." }, "disableRipple": { - "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endIcon": { - "description": "Element placed after the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class." }, + "endIcon": { "description": "Element placed after the children." }, "fullWidth": { - "description": "If true, the button will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the button will take up the full width of its container." }, "href": { - "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node." }, "size": { - "description": "The size of the component. small is equivalent to the dense button styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startIcon": { - "description": "Element placed before the children.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. small is equivalent to the dense button styling." }, + "startIcon": { "description": "Element placed before the children." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/card-action-area/card-action-area.json b/docs/translations/api-docs/card-action-area/card-action-area.json index adfbf3c3a9a6e9..052838068f6cd2 100644 --- a/docs/translations/api-docs/card-action-area/card-action-area.json +++ b/docs/translations/api-docs/card-action-area/card-action-area.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/card-actions/card-actions.json b/docs/translations/api-docs/card-actions/card-actions.json index ce01b36ba37df7..ba5d02f2cdc875 100644 --- a/docs/translations/api-docs/card-actions/card-actions.json +++ b/docs/translations/api-docs/card-actions/card-actions.json @@ -1,29 +1,13 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableSpacing": { - "description": "If true, the actions do not have additional margin.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the actions do not have additional margin." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/card-content/card-content.json b/docs/translations/api-docs/card-content/card-content.json index 6e17d494dc27f6..1589aa62236796 100644 --- a/docs/translations/api-docs/card-content/card-content.json +++ b/docs/translations/api-docs/card-content/card-content.json @@ -1,29 +1,13 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/card-header/card-header.json b/docs/translations/api-docs/card-header/card-header.json index c8fcfdb6e0fef0..bd1f52797d58f4 100644 --- a/docs/translations/api-docs/card-header/card-header.json +++ b/docs/translations/api-docs/card-header/card-header.json @@ -1,65 +1,25 @@ { "componentDescription": "", "propDescriptions": { - "action": { - "description": "The action to display in the card header.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "avatar": { - "description": "The Avatar element to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "action": { "description": "The action to display in the card header." }, + "avatar": { "description": "The Avatar element to display." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disableTypography": { - "description": "If true, subheader and title won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the title text, and optional subheader text with the Typography component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "subheader": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, subheader and title won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the title text, and optional subheader text with the Typography component." }, + "subheader": { "description": "The content of the component." }, "subheaderTypographyProps": { - "description": "These props will be forwarded to the subheader (as long as disableTypography is not true).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "These props will be forwarded to the subheader (as long as disableTypography is not true)." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "title": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "title": { "description": "The content of the component." }, "titleTypographyProps": { - "description": "These props will be forwarded to the title (as long as disableTypography is not true).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "These props will be forwarded to the title (as long as disableTypography is not true)." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/card-media/card-media.json b/docs/translations/api-docs/card-media/card-media.json index 5123bbe6e95ed8..e8fde2c88f788c 100644 --- a/docs/translations/api-docs/card-media/card-media.json +++ b/docs/translations/api-docs/card-media/card-media.json @@ -1,41 +1,19 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "image": { - "description": "Image to be displayed as a background image. Either image or src prop must be specified. Note that caller must specify height otherwise the image will not be visible.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Image to be displayed as a background image. Either image or src prop must be specified. Note that caller must specify height otherwise the image will not be visible." }, "src": { - "description": "An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An alias for image property. Available only with media components. Media components: video, audio, picture, iframe, img." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/card/card.json b/docs/translations/api-docs/card/card.json index 8fc1c52209a508..8e9af5bace86a7 100644 --- a/docs/translations/api-docs/card/card.json +++ b/docs/translations/api-docs/card/card.json @@ -1,29 +1,11 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "raised": { - "description": "If true, the card will use raised styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "raised": { "description": "If true, the card will use raised styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/checkbox/checkbox.json b/docs/translations/api-docs/checkbox/checkbox.json index 0305f31c4501e6..db74e32a08de18 100644 --- a/docs/translations/api-docs/checkbox/checkbox.json +++ b/docs/translations/api-docs/checkbox/checkbox.json @@ -1,115 +1,46 @@ { "componentDescription": "", "propDescriptions": { - "checked": { - "description": "If true, the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "checkedIcon": { - "description": "The icon to display when the component is checked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component is checked." }, + "checkedIcon": { "description": "The icon to display when the component is checked." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "defaultChecked": { - "description": "The default checked state. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableRipple": { - "description": "If true, the ripple effect is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "icon": { - "description": "The icon to display when the component is unchecked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "id": { - "description": "The id of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default checked state. Use when the component is not controlled." }, + "disabled": { "description": "If true, the component is disabled." }, + "disableRipple": { "description": "If true, the ripple effect is disabled." }, + "icon": { "description": "The icon to display when the component is unchecked." }, + "id": { "description": "The id of the input element." }, "indeterminate": { - "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input." }, "indeterminateIcon": { - "description": "The icon to display when the component is indeterminate.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The icon to display when the component is indeterminate." }, "inputProps": { - "description": "Attributes applied to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputRef": { - "description": "Pass a ref to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Attributes applied to the input element." }, + "inputRef": { "description": "Pass a ref to the input element." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean)." } }, "required": { - "description": "If true, the input element is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required." }, "size": { - "description": "The size of the component. small is equivalent to the dense checkbox styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. small is equivalent to the dense checkbox styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/chip/chip.json b/docs/translations/api-docs/chip/chip.json index 4a9e940f2558e6..a642b37399b416 100644 --- a/docs/translations/api-docs/chip/chip.json +++ b/docs/translations/api-docs/chip/chip.json @@ -1,96 +1,37 @@ { "componentDescription": "Chips represent complex entities in small blocks, such as a contact.", "propDescriptions": { - "avatar": { - "description": "The Avatar element to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "avatar": { "description": "The Avatar element to display." }, "children": { - "description": "This prop isn't supported. Use the component prop if you need to change the children structure.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop isn't supported. Use the component prop if you need to change the children structure." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "clickable": { - "description": "If true, the chip will appear clickable, and will raise when pressed, even if the onClick prop is not defined. If false, the chip will not appear clickable, even if onClick prop is defined. This can be used, for example, along with the component prop to indicate an anchor Chip is clickable. Note: this controls the UI and does not affect the onClick event.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the chip will appear clickable, and will raise when pressed, even if the onClick prop is not defined. If false, the chip will not appear clickable, even if onClick prop is defined. This can be used, for example, along with the component prop to indicate an anchor Chip is clickable. Note: this controls the UI and does not affect the onClick event." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "deleteIcon": { - "description": "Override the default delete icon element. Shown only if onDelete is set.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "icon": { - "description": "Icon element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Override the default delete icon element. Shown only if onDelete is set." }, + "disabled": { "description": "If true, the component is disabled." }, + "icon": { "description": "Icon element." }, + "label": { "description": "The content of the component." }, "onDelete": { - "description": "Callback fired when the delete icon is clicked. If set, the delete icon will be shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the delete icon is clicked. If set, the delete icon will be shown." }, + "size": { "description": "The size of the component." }, "skipFocusWhenDisabled": { - "description": "If true, allows the disabled chip to escape focus. If false, allows the disabled chip to receive focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, allows the disabled chip to escape focus. If false, allows the disabled chip to receive focus." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/circular-progress/circular-progress.json b/docs/translations/api-docs/circular-progress/circular-progress.json index a2ac2629f99223..534bd39fa8a3ca 100644 --- a/docs/translations/api-docs/circular-progress/circular-progress.json +++ b/docs/translations/api-docs/circular-progress/circular-progress.json @@ -1,53 +1,25 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "disableShrink": { - "description": "If true, the shrink animation is disabled. This only works if variant is indeterminate.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the shrink animation is disabled. This only works if variant is indeterminate." }, "size": { - "description": "The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "thickness": { - "description": "The thickness of the circle.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, + "thickness": { "description": "The thickness of the circle." }, "value": { - "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the progress indicator for the determinate variant. Value between 0 and 100." }, "variant": { - "description": "The variant to use. Use indeterminate when there is no progress value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The variant to use. Use indeterminate when there is no progress value." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/collapse/collapse.json b/docs/translations/api-docs/collapse/collapse.json index b649ec61e99283..1b933a8ce9cdc2 100644 --- a/docs/translations/api-docs/collapse/collapse.json +++ b/docs/translations/api-docs/collapse/collapse.json @@ -2,64 +2,27 @@ "componentDescription": "The Collapse transition is used by the\n[Vertical Stepper](/material-ui/react-stepper/#vertical-stepper) StepContent component.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { "addEndListener": { - "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content node to be collapsed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided." }, + "children": { "description": "The content node to be collapsed." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "collapsedSize": { - "description": "The width (horizontal) or height (vertical) of the container when collapsed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The width (horizontal) or height (vertical) of the container when collapsed." }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "easing": { - "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "in": { - "description": "If true, the component will transition in.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The transition orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values." }, + "in": { "description": "If true, the component will transition in." }, + "orientation": { "description": "The transition orientation." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "timeout": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/container/container.json b/docs/translations/api-docs/container/container.json index 91f0a0d57c07d5..11d8b7dac40cca 100644 --- a/docs/translations/api-docs/container/container.json +++ b/docs/translations/api-docs/container/container.json @@ -1,41 +1,21 @@ { "componentDescription": "", "propDescriptions": { - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disableGutters": { - "description": "If true, the left and right padding is removed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the left and right padding is removed." }, "fixed": { - "description": "Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default." }, "maxWidth": { - "description": "Determine the max-width of the container. The container width grows with the size of the screen. Set to false to disable maxWidth.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Determine the max-width of the container. The container width grows with the size of the screen. Set to false to disable maxWidth." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/css-baseline/css-baseline.json b/docs/translations/api-docs/css-baseline/css-baseline.json index 33d27baaf15486..68bc9d89bdd324 100644 --- a/docs/translations/api-docs/css-baseline/css-baseline.json +++ b/docs/translations/api-docs/css-baseline/css-baseline.json @@ -1,17 +1,9 @@ { "componentDescription": "Kickstart an elegant, consistent, and simple baseline to build upon.", "propDescriptions": { - "children": { - "description": "You can wrap a node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "You can wrap a node." }, "enableColorScheme": { - "description": "Enable color-scheme CSS property to use theme.palette.mode. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Enable color-scheme CSS property to use theme.palette.mode. For more details, check out https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme For browser support, check out https://caniuse.com/?search=color-scheme" } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/dialog-actions/dialog-actions.json b/docs/translations/api-docs/dialog-actions/dialog-actions.json index ce01b36ba37df7..ba5d02f2cdc875 100644 --- a/docs/translations/api-docs/dialog-actions/dialog-actions.json +++ b/docs/translations/api-docs/dialog-actions/dialog-actions.json @@ -1,29 +1,13 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableSpacing": { - "description": "If true, the actions do not have additional margin.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the actions do not have additional margin." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/dialog-content-text/dialog-content-text.json b/docs/translations/api-docs/dialog-content-text/dialog-content-text.json index 3fc8ceebe8157c..47c76653e72eda 100644 --- a/docs/translations/api-docs/dialog-content-text/dialog-content-text.json +++ b/docs/translations/api-docs/dialog-content-text/dialog-content-text.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/dialog-content/dialog-content.json b/docs/translations/api-docs/dialog-content/dialog-content.json index 46ab02c15c0f63..717ef53cb71fd6 100644 --- a/docs/translations/api-docs/dialog-content/dialog-content.json +++ b/docs/translations/api-docs/dialog-content/dialog-content.json @@ -1,29 +1,11 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "dividers": { - "description": "Display the top and bottom dividers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "dividers": { "description": "Display the top and bottom dividers." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/dialog-title/dialog-title.json b/docs/translations/api-docs/dialog-title/dialog-title.json index 3fc8ceebe8157c..47c76653e72eda 100644 --- a/docs/translations/api-docs/dialog-title/dialog-title.json +++ b/docs/translations/api-docs/dialog-title/dialog-title.json @@ -1,23 +1,10 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } diff --git a/docs/translations/api-docs/dialog/dialog.json b/docs/translations/api-docs/dialog/dialog.json index 36ae5c87caf13f..96b9544e2971b6 100644 --- a/docs/translations/api-docs/dialog/dialog.json +++ b/docs/translations/api-docs/dialog/dialog.json @@ -1,122 +1,48 @@ { "componentDescription": "Dialogs are overlaid modal paper based components with a backdrop.", "propDescriptions": { - "aria-describedby": { - "description": "The id(s) of the element(s) that describe the dialog.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "aria-labelledby": { - "description": "The id(s) of the element(s) that label the dialog.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "aria-describedby": { "description": "The id(s) of the element(s) that describe the dialog." }, + "aria-labelledby": { "description": "The id(s) of the element(s) that label the dialog." }, "BackdropComponent": { - "description": "A backdrop component. This prop enables custom backdrop rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "Dialog children, usually the included sub-components.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A backdrop component. This prop enables custom backdrop rendering." }, + "children": { "description": "Dialog children, usually the included sub-components." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableEscapeKeyDown": { - "description": "If true, hitting escape will not fire the onClose callback.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "fullScreen": { - "description": "If true, the dialog is full-screen.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, hitting escape will not fire the onClose callback." }, + "fullScreen": { "description": "If true, the dialog is full-screen." }, "fullWidth": { - "description": "If true, the dialog stretches to maxWidth.
    Notice that the dialog width grow is limited by the default margin.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the dialog stretches to maxWidth.
    Notice that the dialog width grow is limited by the default margin." }, "maxWidth": { - "description": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onBackdropClick": { - "description": "Callback fired when the backdrop is clicked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth." }, + "onBackdropClick": { "description": "Callback fired when the backdrop is clicked." }, "onClose": { "description": "Callback fired when the component requests to be closed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "escapeKeyDown", "backdropClick"." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "PaperComponent": { - "description": "The component used to render the body of the dialog.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, + "PaperComponent": { "description": "The component used to render the body of the dialog." }, "PaperProps": { - "description": "Props applied to the Paper element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "scroll": { - "description": "Determine the container for scrolling the dialog.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Paper element." }, + "scroll": { "description": "Determine the container for scrolling the dialog." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "TransitionComponent": { - "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the transition. Follow this guide to learn more about the requirements for this component." }, "transitionDuration": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." }, "TransitionProps": { - "description": "Props applied to the transition element. By default, the element is based on this Transition component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the transition element. By default, the element is based on this Transition component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/divider/divider.json b/docs/translations/api-docs/divider/divider.json index 016b87e6b77ddf..c1869e8009b8a5 100644 --- a/docs/translations/api-docs/divider/divider.json +++ b/docs/translations/api-docs/divider/divider.json @@ -1,66 +1,22 @@ { "componentDescription": "", "propDescriptions": { - "absolute": { - "description": "Absolutely position the element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "absolute": { "description": "Absolutely position the element." }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "flexItem": { - "description": "If true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "light": { - "description": "If true, the divider will have a lighter color.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "orientation": { - "description": "The component orientation.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)" }, + "light": { "description": "If true, the divider will have a lighter color." }, + "orientation": { "description": "The component orientation." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "textAlign": { - "description": "The text alignment.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "textAlign": { "description": "The text alignment." }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/drawer/drawer.json b/docs/translations/api-docs/drawer/drawer.json index 2ca87b653c318a..5235859de7d79a 100644 --- a/docs/translations/api-docs/drawer/drawer.json +++ b/docs/translations/api-docs/drawer/drawer.json @@ -1,84 +1,32 @@ { "componentDescription": "The props of the [Modal](/material-ui/api/modal/) component are available\nwhen `variant=\"temporary\"` is set.", "propDescriptions": { - "anchor": { - "description": "Side from which the drawer will appear.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "elevation": { - "description": "The elevation of the drawer.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "hideBackdrop": { - "description": "If true, the backdrop is not rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "anchor": { "description": "Side from which the drawer will appear." }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "elevation": { "description": "The elevation of the drawer." }, + "hideBackdrop": { "description": "If true, the backdrop is not rendered." }, "ModalProps": { - "description": "Props applied to the Modal element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Modal element." }, "onClose": { "description": "Callback fired when the component requests to be closed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, "PaperProps": { - "description": "Props applied to the Paper element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Paper element." }, "SlideProps": { - "description": "Props applied to the Slide element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Slide element." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "transitionDuration": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/fab/fab.json b/docs/translations/api-docs/fab/fab.json index 35c9a2b7920ad6..e5409a8e6ded39 100644 --- a/docs/translations/api-docs/fab/fab.json +++ b/docs/translations/api-docs/fab/fab.json @@ -1,72 +1,29 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "disabled": { "description": "If true, the component is disabled." }, "disableFocusRipple": { - "description": "If true, the keyboard focus ripple is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableRipple": { - "description": "If true, the ripple effect is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the keyboard focus ripple is disabled." }, + "disableRipple": { "description": "If true, the ripple effect is disabled." }, "href": { - "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The URL to link to when the button is clicked. If defined, an a element will be used as the root node." }, "size": { - "description": "The size of the component. small is equivalent to the dense button styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. small is equivalent to the dense button styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/fade/fade.json b/docs/translations/api-docs/fade/fade.json index 48a32c621a6f6a..79d846ff0f0ddd 100644 --- a/docs/translations/api-docs/fade/fade.json +++ b/docs/translations/api-docs/fade/fade.json @@ -2,40 +2,21 @@ "componentDescription": "The Fade transition is used by the [Modal](/material-ui/react-modal/) component.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { "addEndListener": { - "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided." }, "appear": { - "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior." }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "easing": { - "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "in": { - "description": "If true, the component will transition in.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values." }, + "in": { "description": "If true, the component will transition in." }, "timeout": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/filled-input/filled-input.json b/docs/translations/api-docs/filled-input/filled-input.json index ec14b6f4460049..af5fbee4311d55 100644 --- a/docs/translations/api-docs/filled-input/filled-input.json +++ b/docs/translations/api-docs/filled-input/filled-input.json @@ -2,204 +2,92 @@ "componentDescription": "", "propDescriptions": { "autoComplete": { - "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification." }, "autoFocus": { - "description": "If true, the input element is focused during the first mount.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is focused during the first mount." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." }, "disableUnderline": { - "description": "If true, the input will not have an underline.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endAdornment": { - "description": "End InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will not have an underline." }, + "endAdornment": { "description": "End InputAdornment for this component." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, "fullWidth": { - "description": "If true, the input will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will take up the full width of its container." }, "hiddenLabel": { - "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "id": { - "description": "The id of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element." }, + "id": { "description": "The id of the input element." }, "inputComponent": { - "description": "The component used for the input element. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the input element. Either a string to use a HTML element or a component." }, "inputProps": { - "description": "Attributes applied to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputRef": { - "description": "Pass a ref to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Attributes applied to the input element." }, + "inputRef": { "description": "Pass a ref to the input element." }, "margin": { - "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component." }, "maxRows": { - "description": "Maximum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Maximum number of rows to display when multiline option is set to true." }, "minRows": { - "description": "Minimum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Minimum number of rows to display when multiline option is set to true." }, "multiline": { - "description": "If true, a TextareaAutosize element is rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a TextareaAutosize element is rendered." }, + "name": { "description": "Name attribute of the input element." }, "onChange": { "description": "Callback fired when the value is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." } }, "placeholder": { - "description": "The short hint displayed in the input before the user enters a value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The short hint displayed in the input before the user enters a value." }, "readOnly": { - "description": "It prevents the user from changing the value of the field (not from interacting with the field).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "It prevents the user from changing the value of the field (not from interacting with the field)." }, "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rows": { - "description": "Number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "rows": { "description": "Number of rows to display when multiline option is set to true." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startAdornment": { - "description": "Start InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, + "startAdornment": { "description": "Start InputAdornment for this component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "type": { - "description": "Type of the input element. It should be a valid HTML5 input type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Type of the input element. It should be a valid HTML5 input type." }, "value": { - "description": "The value of the input element, required for a controlled component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the input element, required for a controlled component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/form-control-label/form-control-label.json b/docs/translations/api-docs/form-control-label/form-control-label.json index b23a4a6fd7884e..9072273d8d6643 100644 --- a/docs/translations/api-docs/form-control-label/form-control-label.json +++ b/docs/translations/api-docs/form-control-label/form-control-label.json @@ -1,92 +1,33 @@ { "componentDescription": "Drop-in replacement of the `Radio`, `Switch` and `Checkbox` component.\nUse this component if you want to display an extra label.", "propDescriptions": { - "checked": { - "description": "If true, the component appears selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "componentsProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "checked": { "description": "If true, the component appears selected." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "componentsProps": { "description": "The props used for each slot inside." }, "control": { - "description": "A control element. For instance, it can be a Radio, a Switch or a Checkbox.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the control is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A control element. For instance, it can be a Radio, a Switch or a Checkbox." }, + "disabled": { "description": "If true, the control is disabled." }, "disableTypography": { - "description": "If true, the label is rendered as it is passed without an additional typography node.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputRef": { - "description": "Pass a ref to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "label": { - "description": "A text or an element to be used in an enclosing label element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "labelPlacement": { - "description": "The position of the label.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label is rendered as it is passed without an additional typography node." }, + "inputRef": { "description": "Pass a ref to the input element." }, + "label": { "description": "A text or an element to be used in an enclosing label element." }, + "labelPlacement": { "description": "The position of the label." }, "onChange": { "description": "Callback fired when the state is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean)." } }, "required": { - "description": "If true, the label will indicate that the input is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label will indicate that the input is required." }, + "slotProps": { "description": "The props used for each slot inside." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "value": { - "description": "The value of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "value": { "description": "The value of the component." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-control/form-control.json b/docs/translations/api-docs/form-control/form-control.json index f98bb7c670eaf4..de9729510f9be8 100644 --- a/docs/translations/api-docs/form-control/form-control.json +++ b/docs/translations/api-docs/form-control/form-control.json @@ -1,90 +1,38 @@ { "componentDescription": "Provides context such as filled/focused/error/required for form inputs.\nRelying on the context provides high flexibility and ensures that the state always stays\nconsistent across the children of the `FormControl`.\nThis context is used by the following components:\n\n - FormLabel\n - FormHelperText\n - Input\n - InputLabel\n\nYou can find one composition example below and more going to [the demos](/material-ui/react-text-field/#components).\n\n```jsx\n\n Email address\n \n We'll never share your email.\n\n```\n\n⚠️ Only one `InputBase` can be used within a FormControl because it creates visual inconsistencies.\nFor instance, only one input can be focused at the same time, the state shouldn't be shared.", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disabled": { - "description": "If true, the label, input and helper text should be displayed in a disabled state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "error": { - "description": "If true, the label is displayed in an error state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label, input and helper text should be displayed in a disabled state." }, + "error": { "description": "If true, the label is displayed in an error state." }, "focused": { - "description": "If true, the component is displayed in focused state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is displayed in focused state." }, "fullWidth": { - "description": "If true, the component will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component will take up the full width of its container." }, "hiddenLabel": { - "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element." }, "margin": { - "description": "If dense or normal, will adjust vertical spacing of this and contained components.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense or normal, will adjust vertical spacing of this and contained components." }, "required": { - "description": "If true, the label will indicate that the input is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label will indicate that the input is required." }, + "size": { "description": "The size of the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-group/form-group.json b/docs/translations/api-docs/form-group/form-group.json index e3edf11acde990..181d3f89250837 100644 --- a/docs/translations/api-docs/form-group/form-group.json +++ b/docs/translations/api-docs/form-group/form-group.json @@ -1,29 +1,11 @@ { "componentDescription": "`FormGroup` wraps controls such as `Checkbox` and `Switch`.\nIt provides compact row layout.\nFor the `Radio`, you should be using the `RadioGroup` component instead of this one.", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "row": { - "description": "Display group of elements in a compact row.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "row": { "description": "Display group of elements in a compact row." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/form-helper-text/form-helper-text.json b/docs/translations/api-docs/form-helper-text/form-helper-text.json index f63d13d4fb39f5..c5ffe12929bebb 100644 --- a/docs/translations/api-docs/form-helper-text/form-helper-text.json +++ b/docs/translations/api-docs/form-helper-text/form-helper-text.json @@ -2,71 +2,34 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "The content of the component.
    If ' ' is provided, the component reserves one line height for displaying a future message.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component.
    If ' ' is provided, the component reserves one line height for displaying a future message." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disabled": { - "description": "If true, the helper text should be displayed in a disabled state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the helper text should be displayed in a disabled state." }, "error": { - "description": "If true, helper text should be displayed in an error state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, helper text should be displayed in an error state." }, "filled": { - "description": "If true, the helper text should use filled classes key.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the helper text should use filled classes key." }, "focused": { - "description": "If true, the helper text should use focused classes key.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the helper text should use focused classes key." }, "margin": { - "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl." }, "required": { - "description": "If true, the helper text should use required classes key.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the helper text should use required classes key." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/form-label/form-label.json b/docs/translations/api-docs/form-label/form-label.json index 7ccb08e7b86df6..798b38d686377c 100644 --- a/docs/translations/api-docs/form-label/form-label.json +++ b/docs/translations/api-docs/form-label/form-label.json @@ -1,65 +1,27 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disabled": { - "description": "If true, the label should be displayed in a disabled state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "error": { - "description": "If true, the label is displayed in an error state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "filled": { - "description": "If true, the label should use filled classes key.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label should be displayed in a disabled state." }, + "error": { "description": "If true, the label is displayed in an error state." }, + "filled": { "description": "If true, the label should use filled classes key." }, "focused": { - "description": "If true, the input of this label is focused (used by FormGroup components).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input of this label is focused (used by FormGroup components)." }, "required": { - "description": "If true, the label will indicate that the input is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the label will indicate that the input is required." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/global-styles/global-styles.json b/docs/translations/api-docs/global-styles/global-styles.json index 4170f1b8a1383f..5e696d59555b77 100644 --- a/docs/translations/api-docs/global-styles/global-styles.json +++ b/docs/translations/api-docs/global-styles/global-styles.json @@ -1,12 +1,5 @@ { "componentDescription": "", - "propDescriptions": { - "styles": { - "description": "The styles you want to apply globally.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } - }, + "propDescriptions": { "styles": { "description": "The styles you want to apply globally." } }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/grid/grid.json b/docs/translations/api-docs/grid/grid.json index 784fe6c7b17d2d..f21afcb04d5d7d 100644 --- a/docs/translations/api-docs/grid/grid.json +++ b/docs/translations/api-docs/grid/grid.json @@ -1,119 +1,58 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "columns": { - "description": "The number of columns.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "columns": { "description": "The number of columns." }, "columnSpacing": { - "description": "Defines the horizontal space between the type item components. It overrides the value of the spacing prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the horizontal space between the type item components. It overrides the value of the spacing prop." }, "container": { - "description": "If true, the component will have the flex container behavior. You should be wrapping items with a container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component will have the flex container behavior. You should be wrapping items with a container." }, "direction": { - "description": "Defines the flex-direction style property. It is applied for all screen sizes.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the flex-direction style property. It is applied for all screen sizes." }, "disableEqualOverflow": { - "description": "If true, the negative margin and padding are apply only to the top and left sides of the grid.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the negative margin and padding are apply only to the top and left sides of the grid." }, "lg": { - "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the lg breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the lg breakpoint and wider screens if not overridden." }, "lgOffset": { - "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the lg breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the lg breakpoint and wider screens if not overridden." }, "md": { - "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the md breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the md breakpoint and wider screens if not overridden." }, "mdOffset": { - "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the md breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the md breakpoint and wider screens if not overridden." }, "rowSpacing": { - "description": "Defines the vertical space between the type item components. It overrides the value of the spacing prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the vertical space between the type item components. It overrides the value of the spacing prop." }, "sm": { - "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the sm breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the sm breakpoint and wider screens if not overridden." }, "smOffset": { - "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the sm breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the sm breakpoint and wider screens if not overridden." }, "spacing": { - "description": "Defines the space between the type item components. It can only be used on a type container component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the space between the type item components. It can only be used on a type container component." }, "wrap": { - "description": "Defines the flex-wrap style property. It's applied for all screen sizes.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the flex-wrap style property. It's applied for all screen sizes." }, "xl": { - "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the xl breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for the xl breakpoint and wider screens if not overridden." }, "xlOffset": { - "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xl breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xl breakpoint and wider screens if not overridden." }, "xs": { - "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for all the screen sizes with the lowest priority.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the number of columns the grid item uses. It can't be greater than the total number of columns of the container (12 by default). If 'auto', the grid item's width matches its content. If false, the prop is ignored. If true, the grid item's width grows to use the space available in the grid container. The value is applied for all the screen sizes with the lowest priority." }, "xsOffset": { - "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xs breakpoint and wider screens if not overridden.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If a number, it sets the margin-left equals to the number of columns the grid item uses. If 'auto', the grid item push itself to the right-end of the container. The value is applied for the xs breakpoint and wider screens if not overridden." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/grow/grow.json b/docs/translations/api-docs/grow/grow.json index d3219e2b83dca2..7a9c71bae0becf 100644 --- a/docs/translations/api-docs/grow/grow.json +++ b/docs/translations/api-docs/grow/grow.json @@ -2,40 +2,21 @@ "componentDescription": "The Grow transition is used by the [Tooltip](/material-ui/react-tooltip/) and\n[Popover](/material-ui/react-popover/) components.\nIt uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.", "propDescriptions": { "addEndListener": { - "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Add a custom transition end trigger. Called with the transitioning DOM node and a done callback. Allows for more fine grained transition end logic. Note: Timeouts are still used as a fallback if provided." }, "appear": { - "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Perform the enter transition when it first mounts if in is also true. Set this to false to disable this behavior." }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "easing": { - "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "in": { - "description": "If true, the component will transition in.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The transition timing function. You may specify a single easing or a object containing enter and exit values." }, + "in": { "description": "If true, the component will transition in." }, "timeout": { - "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
    Set to 'auto' to automatically calculate transition time based on height." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/hidden/hidden.json b/docs/translations/api-docs/hidden/hidden.json index 6ba61351b67a5f..b4ac8adc37b812 100644 --- a/docs/translations/api-docs/hidden/hidden.json +++ b/docs/translations/api-docs/hidden/hidden.json @@ -1,89 +1,43 @@ { "componentDescription": "Responsively hides children based on the selected implementation.", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, "implementation": { - "description": "Specify which implementation to use. 'js' is the default, 'css' works better for server-side rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Specify which implementation to use. 'js' is the default, 'css' works better for server-side rendering." }, "initialWidth": { - "description": "You can use this prop when choosing the js implementation with server-side rendering.
    As window.innerWidth is unavailable on the server, we default to rendering an empty component during the first mount. You might want to use a heuristic to approximate the screen width of the client browser screen width.
    For instance, you could be using the user-agent or the client-hints. https://caniuse.com/#search=client%20hint", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "You can use this prop when choosing the js implementation with server-side rendering.
    As window.innerWidth is unavailable on the server, we default to rendering an empty component during the first mount. You might want to use a heuristic to approximate the screen width of the client browser screen width.
    For instance, you could be using the user-agent or the client-hints. https://caniuse.com/#search=client%20hint" }, "lgDown": { - "description": "If true, component is hidden on screens below (but not including) this size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens below (but not including) this size." }, "lgUp": { - "description": "If true, component is hidden on screens this size and above.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens this size and above." }, "mdDown": { - "description": "If true, component is hidden on screens below (but not including) this size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens below (but not including) this size." }, "mdUp": { - "description": "If true, component is hidden on screens this size and above.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "only": { - "description": "Hide the given breakpoint(s).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens this size and above." }, + "only": { "description": "Hide the given breakpoint(s)." }, "smDown": { - "description": "If true, component is hidden on screens below (but not including) this size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens below (but not including) this size." }, "smUp": { - "description": "If true, component is hidden on screens this size and above.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens this size and above." }, "xlDown": { - "description": "If true, component is hidden on screens below (but not including) this size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens below (but not including) this size." }, "xlUp": { - "description": "If true, component is hidden on screens this size and above.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens this size and above." }, "xsDown": { - "description": "If true, component is hidden on screens below (but not including) this size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens below (but not including) this size." }, "xsUp": { - "description": "If true, component is hidden on screens this size and above.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, component is hidden on screens this size and above." } }, "classDescriptions": {} diff --git a/docs/translations/api-docs/icon-button/icon-button.json b/docs/translations/api-docs/icon-button/icon-button.json index e07ee6bd65a829..f842fd410f8704 100644 --- a/docs/translations/api-docs/icon-button/icon-button.json +++ b/docs/translations/api-docs/icon-button/icon-button.json @@ -1,59 +1,26 @@ { "componentDescription": "Refer to the [Icons](/material-ui/icons/) section of the documentation\nregarding the available icon options.", "propDescriptions": { - "children": { - "description": "The icon to display.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The icon to display." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, + "disabled": { "description": "If true, the component is disabled." }, "disableFocusRipple": { - "description": "If true, the keyboard focus ripple is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the keyboard focus ripple is disabled." }, "disableRipple": { - "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the ripple effect is disabled.
    ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible class." }, "edge": { - "description": "If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape)." }, "size": { - "description": "The size of the component. small is equivalent to the dense button styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The size of the component. small is equivalent to the dense button styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/icon/icon.json b/docs/translations/api-docs/icon/icon.json index cb120de58fd42c..3608aa93ffd91a 100644 --- a/docs/translations/api-docs/icon/icon.json +++ b/docs/translations/api-docs/icon/icon.json @@ -2,46 +2,21 @@ "componentDescription": "", "propDescriptions": { "baseClassName": { - "description": "The base class applied to the icon. Defaults to 'material-icons', but can be changed to any other base class that suits the icon font you're using (e.g. material-icons-rounded, fas, etc).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The name of the icon font ligature.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The base class applied to the icon. Defaults to 'material-icons', but can be changed to any other base class that suits the icon font you're using (e.g. material-icons-rounded, fas, etc)." }, + "children": { "description": "The name of the icon font ligature." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "fontSize": { - "description": "The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json b/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json index afae7add43b61b..631120ed4b5dd0 100644 --- a/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json +++ b/docs/translations/api-docs/image-list-item-bar/image-list-item-bar.json @@ -2,47 +2,16 @@ "componentDescription": "", "propDescriptions": { "actionIcon": { - "description": "An IconButton element to be used as secondary action target (primary action target is the item itself).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "actionPosition": { - "description": "Position of secondary action IconButton.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "position": { - "description": "Position of the title bar.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "subtitle": { - "description": "String or element serving as subtitle (support text).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An IconButton element to be used as secondary action target (primary action target is the item itself)." }, + "actionPosition": { "description": "Position of secondary action IconButton." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "position": { "description": "Position of the title bar." }, + "subtitle": { "description": "String or element serving as subtitle (support text)." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "title": { - "description": "Title to be displayed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "title": { "description": "Title to be displayed." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/image-list-item/image-list-item.json b/docs/translations/api-docs/image-list-item/image-list-item.json index 12239c5f164873..4660fdd554a682 100644 --- a/docs/translations/api-docs/image-list-item/image-list-item.json +++ b/docs/translations/api-docs/image-list-item/image-list-item.json @@ -2,40 +2,16 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "The content of the component, normally an <img>.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "cols": { - "description": "Width of the item in number of grid columns.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component, normally an <img>." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "cols": { "description": "Width of the item in number of grid columns." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rows": { - "description": "Height of the item in number of grid rows.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "rows": { "description": "Height of the item in number of grid rows." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/image-list/image-list.json b/docs/translations/api-docs/image-list/image-list.json index 7aeec55d7d6d47..50278b616b1d74 100644 --- a/docs/translations/api-docs/image-list/image-list.json +++ b/docs/translations/api-docs/image-list/image-list.json @@ -2,53 +2,19 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "The content of the component, normally ImageListItems.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "cols": { - "description": "Number of columns.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component, normally ImageListItems." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "cols": { "description": "Number of columns." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "gap": { - "description": "The gap between items in px.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rowHeight": { - "description": "The height of one row in px.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, + "gap": { "description": "The gap between items in px." }, + "rowHeight": { "description": "The height of one row in px." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input-adornment/input-adornment.json b/docs/translations/api-docs/input-adornment/input-adornment.json index 862c6287c41add..17c9c8078b7473 100644 --- a/docs/translations/api-docs/input-adornment/input-adornment.json +++ b/docs/translations/api-docs/input-adornment/input-adornment.json @@ -2,52 +2,26 @@ "componentDescription": "", "propDescriptions": { "children": { - "description": "The content of the component, normally an IconButton or string.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component, normally an IconButton or string." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disablePointerEvents": { - "description": "Disable pointer events on the root. This allows for the content of the adornment to focus the input on click.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Disable pointer events on the root. This allows for the content of the adornment to focus the input on click." }, "disableTypography": { - "description": "If children is a string then disable wrapping in a Typography component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If children is a string then disable wrapping in a Typography component." }, "position": { - "description": "The position this adornment should appear relative to the Input.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The position this adornment should appear relative to the Input." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "variant": { - "description": "The variant to use. Note: If you are using the TextField component or the FormControl component you do not have to set this manually.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The variant to use. Note: If you are using the TextField component or the FormControl component you do not have to set this manually." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/input-base/input-base.json b/docs/translations/api-docs/input-base/input-base.json index eb25764fed7a91..38e1bd4d134fc8 100644 --- a/docs/translations/api-docs/input-base/input-base.json +++ b/docs/translations/api-docs/input-base/input-base.json @@ -2,216 +2,97 @@ "componentDescription": "`InputBase` contains as few styles as possible.\nIt aims to be a simple building block for creating an input.\nIt contains a load of style reset and some state logic.", "propDescriptions": { "autoComplete": { - "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification." }, "autoFocus": { - "description": "If true, the input element is focused during the first mount.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is focused during the first mount." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." }, "disableInjectingGlobalStyles": { - "description": "If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endAdornment": { - "description": "End InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once." }, + "endAdornment": { "description": "End InputAdornment for this component." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, "fullWidth": { - "description": "If true, the input will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "id": { - "description": "The id of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will take up the full width of its container." }, + "id": { "description": "The id of the input element." }, "inputComponent": { "description": "The component used for the input element. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "inputProps": { - "description": "Attributes applied to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputRef": { - "description": "Pass a ref to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Attributes applied to the input element." }, + "inputRef": { "description": "Pass a ref to the input element." }, "margin": { - "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component." }, "maxRows": { - "description": "Maximum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Maximum number of rows to display when multiline option is set to true." }, "minRows": { - "description": "Minimum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Minimum number of rows to display when multiline option is set to true." }, "multiline": { - "description": "If true, a TextareaAutosize element is rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a TextareaAutosize element is rendered." }, + "name": { "description": "Name attribute of the input element." }, "onBlur": { - "description": "Callback fired when the input is blurred.
    Notice that the first argument (event) might be undefined.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the input is blurred.
    Notice that the first argument (event) might be undefined." }, "onChange": { "description": "Callback fired when the value is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." } }, "onInvalid": { - "description": "Callback fired when the input doesn't satisfy its constraints.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Callback fired when the input doesn't satisfy its constraints." }, "placeholder": { - "description": "The short hint displayed in the input before the user enters a value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The short hint displayed in the input before the user enters a value." }, "readOnly": { - "description": "It prevents the user from changing the value of the field (not from interacting with the field).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "It prevents the user from changing the value of the field (not from interacting with the field)." }, "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rows": { - "description": "Number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "rows": { "description": "Number of rows to display when multiline option is set to true." }, + "size": { "description": "The size of the component." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startAdornment": { - "description": "Start InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, + "startAdornment": { "description": "Start InputAdornment for this component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "type": { - "description": "Type of the input element. It should be a valid HTML5 input type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Type of the input element. It should be a valid HTML5 input type." }, "value": { - "description": "The value of the input element, required for a controlled component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the input element, required for a controlled component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/input-label/input-label.json b/docs/translations/api-docs/input-label/input-label.json index 1fb7475c8dccc0..484544bb23ae92 100644 --- a/docs/translations/api-docs/input-label/input-label.json +++ b/docs/translations/api-docs/input-label/input-label.json @@ -1,84 +1,31 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "disableAnimation": { - "description": "If true, the transition animation is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "error": { - "description": "If true, the label is displayed in an error state.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the transition animation is disabled." }, + "disabled": { "description": "If true, the component is disabled." }, + "error": { "description": "If true, the label is displayed in an error state." }, "focused": { - "description": "If true, the input of this label is focused.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input of this label is focused." }, "margin": { - "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl." }, "required": { - "description": "if true, the label will indicate that the input is required.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "shrink": { - "description": "If true, the label is shrunk.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "size": { - "description": "The size of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "if true, the label will indicate that the input is required." }, + "shrink": { "description": "If true, the label is shrunk." }, + "size": { "description": "The size of the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/input/input.json b/docs/translations/api-docs/input/input.json index 6a5b181229e4a3..45522a70ff89dc 100644 --- a/docs/translations/api-docs/input/input.json +++ b/docs/translations/api-docs/input/input.json @@ -2,198 +2,89 @@ "componentDescription": "", "propDescriptions": { "autoComplete": { - "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification." }, "autoFocus": { - "description": "If true, the input element is focused during the first mount.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is focused during the first mount." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "defaultValue": { - "description": "The default value. Use when the component is not controlled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default value. Use when the component is not controlled." }, "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." }, "disableUnderline": { - "description": "If true, the input will not have an underline.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "endAdornment": { - "description": "End InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will not have an underline." }, + "endAdornment": { "description": "End InputAdornment for this component." }, "error": { - "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component." }, "fullWidth": { - "description": "If true, the input will take up the full width of its container.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "id": { - "description": "The id of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input will take up the full width of its container." }, + "id": { "description": "The id of the input element." }, "inputComponent": { - "description": "The component used for the input element. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the input element. Either a string to use a HTML element or a component." }, "inputProps": { - "description": "Attributes applied to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inputRef": { - "description": "Pass a ref to the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Attributes applied to the input element." }, + "inputRef": { "description": "Pass a ref to the input element." }, "margin": { - "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component." }, "maxRows": { - "description": "Maximum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Maximum number of rows to display when multiline option is set to true." }, "minRows": { - "description": "Minimum number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Minimum number of rows to display when multiline option is set to true." }, "multiline": { - "description": "If true, a TextareaAutosize element is rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "name": { - "description": "Name attribute of the input element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a TextareaAutosize element is rendered." }, + "name": { "description": "Name attribute of the input element." }, "onChange": { "description": "Callback fired when the value is changed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback. You can pull out the new value by accessing event.target.value (string)." } }, "placeholder": { - "description": "The short hint displayed in the input before the user enters a value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The short hint displayed in the input before the user enters a value." }, "readOnly": { - "description": "It prevents the user from changing the value of the field (not from interacting with the field).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "It prevents the user from changing the value of the field (not from interacting with the field)." }, "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "rows": { - "description": "Number of rows to display when multiline option is set to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." }, + "rows": { "description": "Number of rows to display when multiline option is set to true." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "startAdornment": { - "description": "Start InputAdornment for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, + "startAdornment": { "description": "Start InputAdornment for this component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "type": { - "description": "Type of the input element. It should be a valid HTML5 input type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Type of the input element. It should be a valid HTML5 input type." }, "value": { - "description": "The value of the input element, required for a controlled component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the input element, required for a controlled component." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/linear-progress/linear-progress.json b/docs/translations/api-docs/linear-progress/linear-progress.json index af1087621d680e..c1e8e1fd034a91 100644 --- a/docs/translations/api-docs/linear-progress/linear-progress.json +++ b/docs/translations/api-docs/linear-progress/linear-progress.json @@ -1,41 +1,19 @@ { "componentDescription": "## ARIA\n\nIf the progress bar is describing the loading progress of a particular region of a page,\nyou should use `aria-describedby` to point to the progress bar, and set the `aria-busy`\nattribute to `true` on that region until it has finished loading.", "propDescriptions": { - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "value": { - "description": "The value of the progress indicator for the determinate and buffer variants. Value between 0 and 100.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "valueBuffer": { - "description": "The value for the buffer variant. Value between 0 and 100.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The value of the progress indicator for the determinate and buffer variants. Value between 0 and 100." }, + "valueBuffer": { "description": "The value for the buffer variant. Value between 0 and 100." }, "variant": { - "description": "The variant to use. Use indeterminate or query when there is no progress value.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The variant to use. Use indeterminate or query when there is no progress value." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/link/link.json b/docs/translations/api-docs/link/link.json index 2fa24c46d79eec..2dc55c9f530632 100644 --- a/docs/translations/api-docs/link/link.json +++ b/docs/translations/api-docs/link/link.json @@ -1,54 +1,21 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "color": { - "description": "The color of the link.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "color": { "description": "The color of the link." }, "component": { "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "TypographyClasses": { - "description": "classes prop applied to the Typography element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "classes prop applied to the Typography element." }, - "underline": { - "description": "Controls when the link should have an underline.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "Applies the theme typography styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "underline": { "description": "Controls when the link should have an underline." }, + "variant": { "description": "Applies the theme typography styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/list-item-avatar/list-item-avatar.json b/docs/translations/api-docs/list-item-avatar/list-item-avatar.json index ab02c515bb3212..282ec3df70aafd 100644 --- a/docs/translations/api-docs/list-item-avatar/list-item-avatar.json +++ b/docs/translations/api-docs/list-item-avatar/list-item-avatar.json @@ -1,23 +1,10 @@ { "componentDescription": "A simple wrapper to apply `List` styles to an `Avatar`.", "propDescriptions": { - "children": { - "description": "The content of the component, normally an Avatar.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component, normally an Avatar." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-item-button/list-item-button.json b/docs/translations/api-docs/list-item-button/list-item-button.json index 0e986a7d179f0b..902ee5fb23e5a9 100644 --- a/docs/translations/api-docs/list-item-button/list-item-button.json +++ b/docs/translations/api-docs/list-item-button/list-item-button.json @@ -1,77 +1,33 @@ { "componentDescription": "", "propDescriptions": { - "alignItems": { - "description": "Defines the align-items style property.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "alignItems": { "description": "Defines the align-items style property." }, "autoFocus": { - "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true." }, "children": { - "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "dense": { - "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component." }, + "disabled": { "description": "If true, the component is disabled." }, "disableGutters": { - "description": "If true, the left and right padding is removed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the left and right padding is removed." }, "divider": { - "description": "If true, a 1px light border is added to the bottom of the list item.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a 1px light border is added to the bottom of the list item." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selected": { - "description": "Use to apply selected styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, + "selected": { "description": "Use to apply selected styling." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-item-icon/list-item-icon.json b/docs/translations/api-docs/list-item-icon/list-item-icon.json index 1eba9f1c3734b4..f6140f6253da38 100644 --- a/docs/translations/api-docs/list-item-icon/list-item-icon.json +++ b/docs/translations/api-docs/list-item-icon/list-item-icon.json @@ -2,22 +2,11 @@ "componentDescription": "A simple wrapper to apply `List` styles to an `Icon` or `SvgIcon`.", "propDescriptions": { "children": { - "description": "The content of the component, normally Icon, SvgIcon, or a @mui/icons-material SVG icon element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component, normally Icon, SvgIcon, or a @mui/icons-material SVG icon element." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json b/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json index 38ebae13e915f1..1775fa505284ef 100644 --- a/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json +++ b/docs/translations/api-docs/list-item-secondary-action/list-item-secondary-action.json @@ -2,22 +2,11 @@ "componentDescription": "Must be used as the last child of ListItem to function properly.", "propDescriptions": { "children": { - "description": "The content of the component, normally an IconButton or selection control.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component, normally an IconButton or selection control." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-item-text/list-item-text.json b/docs/translations/api-docs/list-item-text/list-item-text.json index 8fb51c152c4ec6..3fbdc32f65b58d 100644 --- a/docs/translations/api-docs/list-item-text/list-item-text.json +++ b/docs/translations/api-docs/list-item-text/list-item-text.json @@ -1,59 +1,24 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "Alias for the primary prop.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "Alias for the primary prop." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableTypography": { - "description": "If true, the children won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the children (or primary) text, and optional secondary text with the Typography component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the children (or primary) text, and optional secondary text with the Typography component." }, "inset": { - "description": "If true, the children are indented. This should be used if there is no left avatar or left icon.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "primary": { - "description": "The main content element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the children are indented. This should be used if there is no left avatar or left icon." }, + "primary": { "description": "The main content element." }, "primaryTypographyProps": { - "description": "These props will be forwarded to the primary typography component (as long as disableTypography is not true).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "secondary": { - "description": "The secondary content element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "These props will be forwarded to the primary typography component (as long as disableTypography is not true)." }, + "secondary": { "description": "The secondary content element." }, "secondaryTypographyProps": { - "description": "These props will be forwarded to the secondary typography component (as long as disableTypography is not true).", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "These props will be forwarded to the secondary typography component (as long as disableTypography is not true)." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-item/list-item.json b/docs/translations/api-docs/list-item/list-item.json index 0811618d31322c..e5b4ba439ebfb1 100644 --- a/docs/translations/api-docs/list-item/list-item.json +++ b/docs/translations/api-docs/list-item/list-item.json @@ -1,125 +1,52 @@ { "componentDescription": "Uses an additional container component if `ListItemSecondaryAction` is the last child.", "propDescriptions": { - "alignItems": { - "description": "Defines the align-items style property.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "alignItems": { "description": "Defines the align-items style property." }, "autoFocus": { - "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true." }, "button": { - "description": "If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem." }, "children": { - "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the component if a ListItemSecondaryAction is used it must be the last child." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "ContainerComponent": { "description": "The container component used when a ListItemSecondaryAction is the last child.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} - }, - "ContainerProps": { - "description": "Props applied to the container component if used.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, + "ContainerProps": { "description": "Props applied to the container component if used." }, "dense": { - "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component." }, + "disabled": { "description": "If true, the component is disabled." }, "disableGutters": { - "description": "If true, the left and right padding is removed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disablePadding": { - "description": "If true, all padding is removed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the left and right padding is removed." }, + "disablePadding": { "description": "If true, all padding is removed." }, "divider": { - "description": "If true, a 1px light border is added to the bottom of the list item.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "secondaryAction": { - "description": "The element to display at the end of ListItem.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selected": { - "description": "Use to apply selected styling.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a 1px light border is added to the bottom of the list item." }, + "secondaryAction": { "description": "The element to display at the end of ListItem." }, + "selected": { "description": "Use to apply selected styling." }, "slotProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the componentsProps prop, which will be deprecated in the future." }, "slots": { - "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the components prop, which will be deprecated in the future." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list-subheader/list-subheader.json b/docs/translations/api-docs/list-subheader/list-subheader.json index 5e33ecb9cfcb52..6938a6bbad4320 100644 --- a/docs/translations/api-docs/list-subheader/list-subheader.json +++ b/docs/translations/api-docs/list-subheader/list-subheader.json @@ -1,53 +1,23 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "color": { - "description": "The color of the component. It supports those theme colors that make sense for this component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The color of the component. It supports those theme colors that make sense for this component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "disableGutters": { - "description": "If true, the List Subheader will not have gutters.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the List Subheader will not have gutters." }, "disableSticky": { - "description": "If true, the List Subheader will not stick to the top during scroll.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "inset": { - "description": "If true, the List Subheader is indented.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the List Subheader will not stick to the top during scroll." }, + "inset": { "description": "If true, the List Subheader is indented." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/list/list.json b/docs/translations/api-docs/list/list.json index ff8324838da987..b30c4036471edd 100644 --- a/docs/translations/api-docs/list/list.json +++ b/docs/translations/api-docs/list/list.json @@ -1,47 +1,22 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "dense": { - "description": "If true, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context." }, "disablePadding": { - "description": "If true, vertical padding is removed from the list.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, vertical padding is removed from the list." }, "subheader": { - "description": "The content of the subheader, normally ListSubheader.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The content of the subheader, normally ListSubheader." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/loading-button/loading-button.json b/docs/translations/api-docs/loading-button/loading-button.json index 3a2bb9698d059b..3f4e7bdfe39261 100644 --- a/docs/translations/api-docs/loading-button/loading-button.json +++ b/docs/translations/api-docs/loading-button/loading-button.json @@ -1,54 +1,20 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disabled": { - "description": "If true, the component is disabled.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "loading": { - "description": "If true, the loading indicator is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "disabled": { "description": "If true, the component is disabled." }, + "loading": { "description": "If true, the loading indicator is shown." }, "loadingIndicator": { - "description": "Element placed before the children if the button is in loading state. The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Element placed before the children if the button is in loading state. The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself." }, "loadingPosition": { - "description": "The loading indicator can be positioned on the start, end, or the center of the button.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The loading indicator can be positioned on the start, end, or the center of the button." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "description": "The system prop that allows defining system overrides as well as additional CSS styles." + }, + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/masonry/masonry.json b/docs/translations/api-docs/masonry/masonry.json index 80bfcfbfc09eff..1792b21244c28b 100644 --- a/docs/translations/api-docs/masonry/masonry.json +++ b/docs/translations/api-docs/masonry/masonry.json @@ -1,60 +1,25 @@ { "componentDescription": "", "propDescriptions": { - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "columns": { - "description": "Number of columns.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, + "columns": { "description": "Number of columns." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "defaultColumns": { - "description": "The default number of columns of the component. This is provided for server-side rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default number of columns of the component. This is provided for server-side rendering." }, "defaultHeight": { - "description": "The default height of the component in px. This is provided for server-side rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default height of the component in px. This is provided for server-side rendering." }, "defaultSpacing": { - "description": "The default spacing of the component. Like spacing, it is a factor of the theme's spacing. This is provided for server-side rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The default spacing of the component. Like spacing, it is a factor of the theme's spacing. This is provided for server-side rendering." }, "spacing": { - "description": "Defines the space between children. It is a factor of the theme's spacing.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Defines the space between children. It is a factor of the theme's spacing." }, - "sx": { - "description": "Allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "sx": { "description": "Allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/menu-item/menu-item.json b/docs/translations/api-docs/menu-item/menu-item.json index 0f2c8c1be588a3..72957459796a7f 100644 --- a/docs/translations/api-docs/menu-item/menu-item.json +++ b/docs/translations/api-docs/menu-item/menu-item.json @@ -2,64 +2,28 @@ "componentDescription": "", "propDescriptions": { "autoFocus": { - "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "The content of the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true." }, + "children": { "description": "The content of the component." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "dense": { - "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent Menu component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent Menu component." }, "disableGutters": { - "description": "If true, the left and right padding is removed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the left and right padding is removed." }, "divider": { - "description": "If true, a 1px light border is added to the bottom of the menu item.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, a 1px light border is added to the bottom of the menu item." }, "focusVisibleClassName": { - "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "selected": { - "description": "If true, the component is selected.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed." }, + "selected": { "description": "If true, the component is selected." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/menu-list/menu-list.json b/docs/translations/api-docs/menu-list/menu-list.json index f79f543aa85228..940f5b0ca81a17 100644 --- a/docs/translations/api-docs/menu-list/menu-list.json +++ b/docs/translations/api-docs/menu-list/menu-list.json @@ -2,40 +2,20 @@ "componentDescription": "A permanently displayed menu following https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/.\nIt's exposed to help customization of the [`Menu`](/material-ui/api/menu/) component if you\nuse it separately you need to move focus into the component manually. Once\nthe focus is placed inside the component it is fully keyboard accessible.", "propDescriptions": { "autoFocus": { - "description": "If true, will focus the [role="menu"] container and move into tab order.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, will focus the [role="menu"] container and move into tab order." }, "autoFocusItem": { - "description": "If true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu".", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "MenuList contents, normally MenuItems.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu"." }, + "children": { "description": "MenuList contents, normally MenuItems." }, "disabledItemsFocusable": { - "description": "If true, will allow focus on disabled items.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, will allow focus on disabled items." }, "disableListWrap": { - "description": "If true, the menu items will not wrap focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the menu items will not wrap focus." }, "variant": { - "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/menu/menu.json b/docs/translations/api-docs/menu/menu.json index 17d4ecc8bc39d1..b61996dcb3fd42 100644 --- a/docs/translations/api-docs/menu/menu.json +++ b/docs/translations/api-docs/menu/menu.json @@ -2,85 +2,41 @@ "componentDescription": "", "propDescriptions": { "anchorEl": { - "description": "An HTML element, or a function that returns one. It's used to set the position of the menu.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element, or a function that returns one. It's used to set the position of the menu." }, "autoFocus": { - "description": "If true (Default) will focus the [role="menu"] if no focusable child is found. Disabled children are not focusable. If you set this prop to false focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "children": { - "description": "Menu contents, normally MenuItems.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true (Default) will focus the [role="menu"] if no focusable child is found. Disabled children are not focusable. If you set this prop to false focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise." }, + "children": { "description": "Menu contents, normally MenuItems." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "disableAutoFocusItem": { - "description": "When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications." }, "MenuListProps": { - "description": "Props applied to the MenuList element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the MenuList element." }, "onClose": { "description": "Callback fired when the component requests to be closed.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "escapeKeyDown", "backdropClick", "tabKeyDown"." } }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "open": { "description": "If true, the component is shown." }, "PopoverClasses": { - "description": "classes prop applied to the Popover element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "classes prop applied to the Popover element." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, "transitionDuration": { - "description": "The length of the transition in ms, or 'auto'", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The length of the transition in ms, or 'auto'" }, "TransitionProps": { - "description": "Props applied to the transition element. By default, the element is based on this Transition component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the transition element. By default, the element is based on this Transition component." }, "variant": { - "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The variant to use. Use menu to prevent selected items from impacting the initial focus." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/mobile-stepper/mobile-stepper.json b/docs/translations/api-docs/mobile-stepper/mobile-stepper.json index e043d6cb0200ad..856613d200bc05 100644 --- a/docs/translations/api-docs/mobile-stepper/mobile-stepper.json +++ b/docs/translations/api-docs/mobile-stepper/mobile-stepper.json @@ -2,59 +2,24 @@ "componentDescription": "", "propDescriptions": { "activeStep": { - "description": "Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Set the active step (zero based index). Defines which dot is highlighted when the variant is 'dots'." }, "backButton": { - "description": "A back button element. For instance, it can be a Button or an IconButton.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A back button element. For instance, it can be a Button or an IconButton." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "LinearProgressProps": { - "description": "Props applied to the LinearProgress element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the LinearProgress element." }, "nextButton": { - "description": "A next button element. For instance, it can be a Button or an IconButton.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "position": { - "description": "Set the positioning type.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "steps": { - "description": "The total steps.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A next button element. For instance, it can be a Button or an IconButton." }, + "position": { "description": "Set the positioning type." }, + "steps": { "description": "The total steps." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." }, - "variant": { - "description": "The variant to use.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - } + "variant": { "description": "The variant to use." } }, "classDescriptions": { "root": { "description": "Styles applied to the root element." }, diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index 5a7abd302ea498..b898e079a12249 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -2,157 +2,68 @@ "componentDescription": "Modal is a lower-level construct that is leveraged by the following components:\n\n- [Dialog](/material-ui/api/dialog/)\n- [Drawer](/material-ui/api/drawer/)\n- [Menu](/material-ui/api/menu/)\n- [Popover](/material-ui/api/popover/)\n\nIf you are creating a modal dialog, you probably want to use the [Dialog](/material-ui/api/dialog/) component\nrather than directly using Modal.\n\nThis component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).", "propDescriptions": { "BackdropComponent": { - "description": "A backdrop component. This prop enables custom backdrop rendering.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "A backdrop component. This prop enables custom backdrop rendering." }, "BackdropProps": { - "description": "Props applied to the Backdrop element.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Props applied to the Backdrop element." }, "children": { "description": "A single child content element.", - "notes": "
    ⚠️ Needs to be able to hold a ref.", - "deprecated": "", - "typeDescriptions": {} - }, - "classes": { - "description": "Override or extend the styles applied to the component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "notes": "
    ⚠️ Needs to be able to hold a ref." }, + "classes": { "description": "Override or extend the styles applied to the component." }, "closeAfterTransition": { - "description": "When set to true the Modal waits until a nested Transition is completed before closing.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "When set to true the Modal waits until a nested Transition is completed before closing." }, "component": { - "description": "The component used for the root node. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The component used for the root node. Either a string to use a HTML element or a component." }, "components": { - "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside.
    This prop is an alias for the slots prop. It's recommended to use the slots prop instead." }, "componentsProps": { - "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The extra props for the slot components. You can override the existing props or add new ones.
    This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future." }, "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
    By default, it uses the body of the top-level document object, so it's simply document.body most of the time." }, "disableAutoFocus": { - "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEnforceFocus": { - "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not prevent focus from leaving the modal while open.
    Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers." }, "disableEscapeKeyDown": { - "description": "If true, hitting escape will not fire the onClose callback.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, hitting escape will not fire the onClose callback." }, "disablePortal": { - "description": "The children will be under the DOM hierarchy of the parent component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The children will be under the DOM hierarchy of the parent component." }, "disableRestoreFocus": { - "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "disableScrollLock": { - "description": "Disable the scroll lock behavior.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "hideBackdrop": { - "description": "If true, the backdrop is not rendered.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted." }, + "disableScrollLock": { "description": "Disable the scroll lock behavior." }, + "hideBackdrop": { "description": "If true, the backdrop is not rendered." }, "keepMounted": { - "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onBackdropClick": { - "description": "Callback fired when the backdrop is clicked.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal." }, + "onBackdropClick": { "description": "Callback fired when the backdrop is clicked." }, "onClose": { "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.", - "notes": "", - "deprecated": "", "typeDescriptions": { "event": "The event source of the callback.", "reason": "Can be: "escapeKeyDown", "backdropClick"." } }, - "onTransitionEnter": { - "description": "A function called when a transition enters.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "onTransitionExited": { - "description": "A function called when a transition has exited.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "open": { - "description": "If true, the component is shown.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, - "slotProps": { - "description": "The props used for each slot inside the Modal.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} - }, + "onTransitionEnter": { "description": "A function called when a transition enters." }, + "onTransitionExited": { "description": "A function called when a transition has exited." }, + "open": { "description": "If true, the component is shown." }, + "slotProps": { "description": "The props used for each slot inside the Modal." }, "slots": { - "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The components used for each slot inside the Modal. Either a string to use a HTML element or a component." }, "sx": { - "description": "The system prop that allows defining system overrides as well as additional CSS styles.", - "notes": "", - "deprecated": "", - "typeDescriptions": {} + "description": "The system prop that allows defining system overrides as well as additional CSS styles." } }, "classDescriptions": { diff --git a/docs/translations/api-docs/native-select/native-select.json b/docs/translations/api-docs/native-select/native-select.json index d36b5741669048..bd7a4ade72c48b 100644 --- a/docs/translations/api-docs/native-select/native-select.json +++ b/docs/translations/api-docs/native-select/native-select.json @@ -2,61 +2,27 @@ "componentDescription": "An alternative to `