From c95584588eb369b4b05e23a91c0abc82ec6a52be Mon Sep 17 00:00:00 2001 From: Marija Najdova Date: Wed, 29 Mar 2023 10:26:16 +0200 Subject: [PATCH 01/30] [ButtonUnstyled] Drop `component` prop --- .../components/button/UnstyledButtonCustom.js | 2 +- .../button/UnstyledButtonCustom.tsx | 2 +- .../components/button/UnstyledButtonsSpan.js | 4 +-- .../components/button/UnstyledButtonsSpan.tsx | 4 +-- .../button/UnstyledButtonsSpan.tsx.preview | 4 +-- docs/data/base/components/button/button.md | 8 ++--- docs/pages/base/api/button-unstyled.json | 1 - .../button-unstyled/button-unstyled.json | 1 - .../ButtonUnstyled/ButtonUnstyled.spec.tsx | 35 ------------------- .../ButtonUnstyled/ButtonUnstyled.test.tsx | 21 ++++++----- .../src/ButtonUnstyled/ButtonUnstyled.tsx | 18 ++++------ .../ButtonUnstyled/ButtonUnstyled.types.ts | 8 ++--- test/utils/describeConformanceUnstyled.tsx | 32 ----------------- 13 files changed, 33 insertions(+), 107 deletions(-) diff --git a/docs/data/base/components/button/UnstyledButtonCustom.js b/docs/data/base/components/button/UnstyledButtonCustom.js index 3044a6a7a3893a..297d7c65e20cf3 100644 --- a/docs/data/base/components/button/UnstyledButtonCustom.js +++ b/docs/data/base/components/button/UnstyledButtonCustom.js @@ -108,7 +108,7 @@ const CustomButtonRoot = styled(ButtonRoot)( ); const SvgButton = React.forwardRef(function SvgButton(props, ref) { - return ; + return ; }); export default function UnstyledButtonCustom() { diff --git a/docs/data/base/components/button/UnstyledButtonCustom.tsx b/docs/data/base/components/button/UnstyledButtonCustom.tsx index de5113dd3bc9f7..61ac37f1ad8156 100644 --- a/docs/data/base/components/button/UnstyledButtonCustom.tsx +++ b/docs/data/base/components/button/UnstyledButtonCustom.tsx @@ -112,7 +112,7 @@ const SvgButton = React.forwardRef(function SvgButton( props: ButtonUnstyledProps, ref: React.ForwardedRef, ) { - return ; + return ; }); export default function UnstyledButtonCustom() { diff --git a/docs/data/base/components/button/UnstyledButtonsSpan.js b/docs/data/base/components/button/UnstyledButtonsSpan.js index 1528e97a1e419d..a705789b2d7843 100644 --- a/docs/data/base/components/button/UnstyledButtonsSpan.js +++ b/docs/data/base/components/button/UnstyledButtonsSpan.js @@ -43,8 +43,8 @@ const CustomButton = styled(ButtonUnstyled)` export default function UnstyledButtonsSpan() { return ( - Button - + Button + Disabled diff --git a/docs/data/base/components/button/UnstyledButtonsSpan.tsx b/docs/data/base/components/button/UnstyledButtonsSpan.tsx index f05620d89899cb..99a10b8a8939f2 100644 --- a/docs/data/base/components/button/UnstyledButtonsSpan.tsx +++ b/docs/data/base/components/button/UnstyledButtonsSpan.tsx @@ -47,8 +47,8 @@ const CustomButton = styled(ButtonUnstyled)` export default function UnstyledButtonsSpan() { return ( - Button - + Button + Disabled diff --git a/docs/data/base/components/button/UnstyledButtonsSpan.tsx.preview b/docs/data/base/components/button/UnstyledButtonsSpan.tsx.preview index 456f8c68ebbaf6..3bc6f9900b4213 100644 --- a/docs/data/base/components/button/UnstyledButtonsSpan.tsx.preview +++ b/docs/data/base/components/button/UnstyledButtonsSpan.tsx.preview @@ -1,4 +1,4 @@ -Button - +Button + Disabled \ No newline at end of file diff --git a/docs/data/base/components/button/button.md b/docs/data/base/components/button/button.md index bf5a824e172f3c..87fc82f91d1633 100644 --- a/docs/data/base/components/button/button.md +++ b/docs/data/base/components/button/button.md @@ -59,10 +59,10 @@ The following props are available on all non-utility Base components. See [Usage](/base/getting-started/usage/) for full details. ::: -Use the `component` prop to override the root slot with a custom element: +Use the `slots.root` prop to override the root slot with a custom element: ```jsx - + ``` If you provide a non-interactive element such as a ``, the Unstyled Button component will automatically add the necessary accessibility attributes. @@ -72,8 +72,8 @@ Compare the attributes on the `` in this demo with the Button from the pre {{"demo": "UnstyledButtonsSpan.js"}} :::warning -If an Unstyled Button is customized with a non-button element (i.e. ``), it will not submit the form it's in when clicked. -Similarly, `` will not reset its parent form. +If an Unstyled Button is customized with a non-button element (i.e. ``), it will not submit the form it's in when clicked. +Similarly, `` will not reset its parent form. ::: ## Hook diff --git a/docs/pages/base/api/button-unstyled.json b/docs/pages/base/api/button-unstyled.json index db79f2e3ff0d16..4036108b67d0a7 100644 --- a/docs/pages/base/api/button-unstyled.json +++ b/docs/pages/base/api/button-unstyled.json @@ -6,7 +6,6 @@ "description": "func
| { current?: { focusVisible: func } }" } }, - "component": { "type": { "name": "elementType" } }, "disabled": { "type": { "name": "bool" }, "default": "false" }, "focusableWhenDisabled": { "type": { "name": "bool" }, "default": "false" }, "slotProps": { diff --git a/docs/translations/api-docs/button-unstyled/button-unstyled.json b/docs/translations/api-docs/button-unstyled/button-unstyled.json index ca3b0959dcb074..9e7f20da93f4fa 100644 --- a/docs/translations/api-docs/button-unstyled/button-unstyled.json +++ b/docs/translations/api-docs/button-unstyled/button-unstyled.json @@ -2,7 +2,6 @@ "componentDescription": "The foundation for building custom-styled buttons.", "propDescriptions": { "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "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.", "focusableWhenDisabled": "If true, allows a disabled button to receive focus.", "slotProps": "The props used for each slot inside the Button.", diff --git a/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.spec.tsx b/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.spec.tsx index 75b549d3bfbf41..50b163e613cdef 100644 --- a/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.spec.tsx +++ b/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.spec.tsx @@ -22,38 +22,3 @@ const CustomButtonRoot = React.forwardRef(function CustomButtonRoot( function ButtonWithCustomRoot(props: ButtonUnstyledProps) { return ; } - -const polymorphicComponentTest = () => { - const CustomComponent: React.FC<{ stringProp: string; numberProp: number }> = - function CustomComponent() { - return
; - }; - - return ( -
- {/* @ts-expect-error */} - - - - - - {/* @ts-expect-error */} - - - ) => e.currentTarget.checkValidity()} - /> - - - component="div" - ref={(elem) => { - expectType(elem); - }} - onClick={(e) => { - expectType, typeof e>(e); - }} - /> -
- ); -}; diff --git a/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.test.tsx b/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.test.tsx index 0812368e9908c0..f40d3936f5da75 100644 --- a/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.test.tsx +++ b/packages/mui-base/src/ButtonUnstyled/ButtonUnstyled.test.tsx @@ -30,7 +30,7 @@ describe('', () => { describe('role attribute', () => { it('is set when the root component is an HTML element other than a button', () => { - const { getByRole } = render(); + const { getByRole } = render(); expect(getByRole('button')).not.to.equal(null); }); @@ -42,7 +42,7 @@ describe('', () => { ) => , ); - const { getByRole } = render(); + const { getByRole } = render(); expect(getByRole('button')).not.to.equal(null); }); @@ -54,7 +54,7 @@ describe('', () => { ) => ``` -### Slot props - -:::info -The following prop is available on all non-utility Base components. -See [Usage](/base/getting-started/usage/) for full details. -::: +### Custom structure Use the `slots.root` prop to override the root slot with a custom element: @@ -67,6 +62,11 @@ Use the `slots.root` prop to override the root slot with a custom element: ``` +:::info +The `slots` prop is available on all non-utility Base components. +See [Overriding component structure](/base/guides/overriding-component-structure/) for full details. +::: + If you provide a non-interactive element such as a ``, the Unstyled Button component will automatically add the necessary accessibility attributes. Compare the attributes on the `` in this demo with the Button from the previous demo—try inspecting them both with your browser's dev tools: @@ -74,13 +74,13 @@ Compare the attributes on the `` in this demo with the Button from the pre {{"demo": "UnstyledButtonsSpan.js"}} :::warning -If an Unstyled Button is customized with a non-button element (i.e. ``), it will not submit the form it's in when clicked. +If an Unstyled Button is customized with a non-button element (for instance, ``), it will not submit the form it's in when clicked. Similarly, `` will not reset its parent form. ::: #### Usage with TypeScript -If you are using TypeScript, you can specify the custom component type used in the `slots.root` as a generic to the unstyled component. This way, you can safely provide the custom compoenent's props directly on the unstyled compnent: +In TypeScript, you can specify the custom component type used in the `slots.root` as a generic to the unstyled component. This way, you can safely provide the custom compoenent's props directly on the unstyled compnent: ```tsx diff --git a/docs/data/base/guides/overriding-component-structure/overriding-component-structure.md b/docs/data/base/guides/overriding-component-structure/overriding-component-structure.md index b014266a40488f..f85cb3dac7cb2b 100644 --- a/docs/data/base/guides/overriding-component-structure/overriding-component-structure.md +++ b/docs/data/base/guides/overriding-component-structure/overriding-component-structure.md @@ -13,12 +13,9 @@ Slots are most commonly filled by HTML tags, but may also be filled by React com All components contain a root slot that defines their primary node in the DOM tree; more complex components also contain additional interior slots named after the elements they represent. -All _non-utility_ Base UI components accept two props for overriding their rendered HTML structure: +All _non-utility_ Base UI components accept [the `slots` prop](#the-slots-prop) for overriding their rendered HTML structure. -- `component`—to override the root slot -- `slots`—to override any interior slots (when present) as well as the root - -Additionally, you can pass custom props to interior slots using `slotProps`. +Additionally, you can pass custom props to [interior slots](#interior-slots) using `slotProps`. ## The root slot @@ -26,19 +23,7 @@ The root slot represents the component's outermost element. For simpler components, the root slot is often filled by the native HTML element that the component is intended to replace. For example, the [Unstyled Button's](/base/react-button/) root slot is a ` + \ No newline at end of file diff --git a/packages/api-docs-builder/buildApiUtils.test.ts b/packages/api-docs-builder/buildApiUtils.test.ts index f27b85cc38cf64..1fd6c7d14a5733 100644 --- a/packages/api-docs-builder/buildApiUtils.test.ts +++ b/packages/api-docs-builder/buildApiUtils.test.ts @@ -128,7 +128,7 @@ describe('buildApiUtils', () => { path.join(process.cwd(), `/packages/mui-base/src/Button/Button.tsx`), ); sinon.assert.match(info, { - name: 'Button', + name: 'Unstyled Button', apiPathname: '/base/react-button/components-api/#button', muiName: 'MuiButton', apiPagesDirectory: sinon.match((value) => @@ -176,7 +176,7 @@ describe('buildApiUtils', () => { if (existed) { expect(info.getDemos()).to.deep.equal([ { - demoPageTitle: 'Button', + demoPageTitle: 'Unstyled Button', demoPathname: '/base/react-button/#hook', }, ]); From 27e0da13ba9eba656fd85b304d7b7c9778451619 Mon Sep 17 00:00:00 2001 From: Marija Najdova Date: Tue, 25 Apr 2023 09:59:51 +0200 Subject: [PATCH 19/30] fix wrong path separators --- docs/pages/joy-ui/api/alert.js | 2 +- docs/pages/joy-ui/api/aspect-ratio.js | 2 +- docs/pages/joy-ui/api/autocomplete-listbox.js | 2 +- docs/pages/joy-ui/api/autocomplete-option.js | 2 +- docs/pages/joy-ui/api/autocomplete.js | 2 +- docs/pages/joy-ui/api/avatar-group.js | 2 +- docs/pages/joy-ui/api/avatar.js | 2 +- docs/pages/joy-ui/api/badge.js | 2 +- docs/pages/joy-ui/api/breadcrumbs.js | 2 +- docs/pages/joy-ui/api/button.js | 2 +- docs/pages/joy-ui/api/card-content.js | 2 +- docs/pages/joy-ui/api/card-cover.js | 6 +- docs/pages/joy-ui/api/card-overflow.js | 2 +- docs/pages/joy-ui/api/card.js | 2 +- docs/pages/joy-ui/api/checkbox.js | 2 +- docs/pages/joy-ui/api/chip-delete.js | 2 +- docs/pages/joy-ui/api/chip.js | 2 +- docs/pages/joy-ui/api/circular-progress.js | 2 +- docs/pages/joy-ui/api/css-baseline.js | 2 +- docs/pages/joy-ui/api/divider.js | 2 +- docs/pages/joy-ui/api/form-control.js | 2 +- docs/pages/joy-ui/api/form-helper-text.js | 2 +- docs/pages/joy-ui/api/form-label.js | 6 +- docs/pages/joy-ui/api/icon-button.js | 2 +- docs/pages/joy-ui/api/input.js | 2 +- docs/pages/joy-ui/api/linear-progress.js | 2 +- docs/pages/joy-ui/api/link.js | 2 +- docs/pages/joy-ui/api/list-divider.js | 2 +- docs/pages/joy-ui/api/list-item-button.js | 2 +- docs/pages/joy-ui/api/list-item-content.js | 2 +- docs/pages/joy-ui/api/list-item-decorator.js | 2 +- docs/pages/joy-ui/api/list-item.js | 6 +- docs/pages/joy-ui/api/list-subheader.js | 2 +- docs/pages/joy-ui/api/list.js | 2 +- docs/pages/joy-ui/api/menu-item.js | 6 +- docs/pages/joy-ui/api/menu-list.js | 6 +- docs/pages/joy-ui/api/menu.js | 2 +- docs/pages/joy-ui/api/modal-close.js | 2 +- docs/pages/joy-ui/api/modal-dialog.js | 2 +- docs/pages/joy-ui/api/modal-overflow.js | 2 +- docs/pages/joy-ui/api/modal.js | 2 +- docs/pages/joy-ui/api/option.js | 2 +- docs/pages/joy-ui/api/radio-group.js | 2 +- docs/pages/joy-ui/api/radio.js | 2 +- docs/pages/joy-ui/api/scoped-css-baseline.js | 2 +- docs/pages/joy-ui/api/select.js | 2 +- docs/pages/joy-ui/api/sheet.js | 2 +- docs/pages/joy-ui/api/slider.js | 2 +- docs/pages/joy-ui/api/stack.js | 2 +- docs/pages/joy-ui/api/svg-icon.js | 2 +- docs/pages/joy-ui/api/switch.js | 2 +- docs/pages/joy-ui/api/tab-list.js | 2 +- docs/pages/joy-ui/api/tab-panel.js | 6 +- docs/pages/joy-ui/api/tab.js | 2 +- docs/pages/joy-ui/api/table.js | 2 +- docs/pages/joy-ui/api/tabs.js | 2 +- docs/pages/joy-ui/api/textarea.js | 2 +- docs/pages/joy-ui/api/tooltip.js | 2 +- docs/pages/joy-ui/api/typography.js | 6 +- docs/translations/api-docs/alert/alert.json | 140 +++++----- .../api-docs/autocomplete/autocomplete.json | 238 ++++++---------- .../api-docs/avatar-group/avatar-group.json | 23 +- docs/translations/api-docs/avatar/avatar.json | 92 ++---- docs/translations/api-docs/badge/badge.json | 110 +------- .../api-docs/breadcrumbs/breadcrumbs.json | 39 +-- docs/translations/api-docs/button/button.json | 130 +-------- .../api-docs/card-content/card-content.json | 8 +- docs/translations/api-docs/card/card.json | 99 +------ .../api-docs/checkbox/checkbox.json | 126 ++------- docs/translations/api-docs/chip/chip.json | 264 ++++++++++++------ .../circular-progress/circular-progress.json | 116 +++----- .../api-docs/css-baseline/css-baseline.json | 2 +- .../api-docs/divider/divider.json | 81 ++++-- .../api-docs/form-control/form-control.json | 88 +----- .../form-helper-text/form-helper-text.json | 54 +++- .../api-docs/form-label/form-label.json | 48 +++- .../api-docs/icon-button/icon-button.json | 107 +++---- docs/translations/api-docs/input/input.json | 132 +++------ .../linear-progress/linear-progress.json | 138 ++++----- docs/translations/api-docs/link/link.json | 145 ++-------- .../list-item-button/list-item-button.json | 107 ++----- .../api-docs/list-item/list-item.json | 146 +++++----- .../list-subheader/list-subheader.json | 80 ++---- docs/translations/api-docs/list/list.json | 71 ++--- .../api-docs/menu-item/menu-item.json | 78 +----- .../api-docs/menu-list/menu-list.json | 72 ++--- docs/translations/api-docs/menu/menu.json | 70 ++--- docs/translations/api-docs/modal/modal.json | 16 +- docs/translations/api-docs/option/option.json | 79 +----- .../api-docs/radio-group/radio-group.json | 98 +------ docs/translations/api-docs/radio/radio.json | 133 ++------- .../scoped-css-baseline.json | 10 +- docs/translations/api-docs/select/select.json | 141 ++-------- docs/translations/api-docs/slider/slider.json | 108 ++----- .../api-docs/svg-icon/svg-icon.json | 103 ++----- docs/translations/api-docs/switch/switch.json | 118 +------- .../api-docs/tab-list/tab-list.json | 106 +++---- .../api-docs/tab-panel/tab-panel.json | 27 +- docs/translations/api-docs/tab/tab.json | 64 +---- docs/translations/api-docs/table/table.json | 140 +--------- docs/translations/api-docs/tabs/tabs.json | 56 +--- .../api-docs/tooltip/tooltip.json | 156 ++++------- .../api-docs/typography/typography.json | 154 +++++----- .../ApiBuilders/ComponentApiBuilder.ts | 4 +- 104 files changed, 1429 insertions(+), 3034 deletions(-) diff --git a/docs/pages/joy-ui/api/alert.js b/docs/pages/joy-ui/api/alert.js index f676f9ab4475f1..1beef9603135c9 100644 --- a/docs/pages/joy-ui/api/alert.js +++ b/docs/pages/joy-ui/api/alert.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/alert', false, /alert.*.json$/); + const req = require.context('docs/translations/api-docs-joy/alert', false, /alert.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/aspect-ratio.js b/docs/pages/joy-ui/api/aspect-ratio.js index 071e2029415cd8..ff99079a85af64 100644 --- a/docs/pages/joy-ui/api/aspect-ratio.js +++ b/docs/pages/joy-ui/api/aspect-ratio.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/aspect-ratio', + 'docs/translations/api-docs-joy/aspect-ratio', false, /aspect-ratio.*.json$/, ); diff --git a/docs/pages/joy-ui/api/autocomplete-listbox.js b/docs/pages/joy-ui/api/autocomplete-listbox.js index 5922969487241e..e79dc1da495467 100644 --- a/docs/pages/joy-ui/api/autocomplete-listbox.js +++ b/docs/pages/joy-ui/api/autocomplete-listbox.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/autocomplete-listbox', + 'docs/translations/api-docs-joy/autocomplete-listbox', false, /autocomplete-listbox.*.json$/, ); diff --git a/docs/pages/joy-ui/api/autocomplete-option.js b/docs/pages/joy-ui/api/autocomplete-option.js index 8835b989490bfa..8304139be937e1 100644 --- a/docs/pages/joy-ui/api/autocomplete-option.js +++ b/docs/pages/joy-ui/api/autocomplete-option.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/autocomplete-option', + 'docs/translations/api-docs-joy/autocomplete-option', false, /autocomplete-option.*.json$/, ); diff --git a/docs/pages/joy-ui/api/autocomplete.js b/docs/pages/joy-ui/api/autocomplete.js index ea7bc74e15919f..e860d625a4952d 100644 --- a/docs/pages/joy-ui/api/autocomplete.js +++ b/docs/pages/joy-ui/api/autocomplete.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/autocomplete', + 'docs/translations/api-docs-joy/autocomplete', false, /autocomplete.*.json$/, ); diff --git a/docs/pages/joy-ui/api/avatar-group.js b/docs/pages/joy-ui/api/avatar-group.js index b1e7dd07841f4d..c5ccfec00272ea 100644 --- a/docs/pages/joy-ui/api/avatar-group.js +++ b/docs/pages/joy-ui/api/avatar-group.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/avatar-group', + 'docs/translations/api-docs-joy/avatar-group', false, /avatar-group.*.json$/, ); diff --git a/docs/pages/joy-ui/api/avatar.js b/docs/pages/joy-ui/api/avatar.js index ff34aacf10fd9a..57a3395ab0730a 100644 --- a/docs/pages/joy-ui/api/avatar.js +++ b/docs/pages/joy-ui/api/avatar.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/avatar', false, /avatar.*.json$/); + const req = require.context('docs/translations/api-docs-joy/avatar', false, /avatar.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/badge.js b/docs/pages/joy-ui/api/badge.js index 18d7387490b512..934d17137e217d 100644 --- a/docs/pages/joy-ui/api/badge.js +++ b/docs/pages/joy-ui/api/badge.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/badge', false, /badge.*.json$/); + const req = require.context('docs/translations/api-docs-joy/badge', false, /badge.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/breadcrumbs.js b/docs/pages/joy-ui/api/breadcrumbs.js index 4fe89696f281ae..afb0cff96967f1 100644 --- a/docs/pages/joy-ui/api/breadcrumbs.js +++ b/docs/pages/joy-ui/api/breadcrumbs.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/breadcrumbs', + 'docs/translations/api-docs-joy/breadcrumbs', false, /breadcrumbs.*.json$/, ); diff --git a/docs/pages/joy-ui/api/button.js b/docs/pages/joy-ui/api/button.js index 66ad9f22ef0c47..2921080c103f66 100644 --- a/docs/pages/joy-ui/api/button.js +++ b/docs/pages/joy-ui/api/button.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/button', false, /button.*.json$/); + const req = require.context('docs/translations/api-docs-joy/button', false, /button.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/card-content.js b/docs/pages/joy-ui/api/card-content.js index f8529aba2bbde4..9ed9f2faacfc3f 100644 --- a/docs/pages/joy-ui/api/card-content.js +++ b/docs/pages/joy-ui/api/card-content.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/card-content', + 'docs/translations/api-docs-joy/card-content', false, /card-content.*.json$/, ); diff --git a/docs/pages/joy-ui/api/card-cover.js b/docs/pages/joy-ui/api/card-cover.js index 6e14e77bf0666f..0236dc8169b6f1 100644 --- a/docs/pages/joy-ui/api/card-cover.js +++ b/docs/pages/joy-ui/api/card-cover.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/card-cover', false, /card-cover.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/card-cover', + false, + /card-cover.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/card-overflow.js b/docs/pages/joy-ui/api/card-overflow.js index 1106b1c0f7a3c1..2b57750faa905a 100644 --- a/docs/pages/joy-ui/api/card-overflow.js +++ b/docs/pages/joy-ui/api/card-overflow.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/card-overflow', + 'docs/translations/api-docs-joy/card-overflow', false, /card-overflow.*.json$/, ); diff --git a/docs/pages/joy-ui/api/card.js b/docs/pages/joy-ui/api/card.js index 91bcc50d89eac4..5da0e773bb2a6d 100644 --- a/docs/pages/joy-ui/api/card.js +++ b/docs/pages/joy-ui/api/card.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/card', false, /card.*.json$/); + const req = require.context('docs/translations/api-docs-joy/card', false, /card.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/checkbox.js b/docs/pages/joy-ui/api/checkbox.js index 90a006ee745260..0df2f4c56de0b7 100644 --- a/docs/pages/joy-ui/api/checkbox.js +++ b/docs/pages/joy-ui/api/checkbox.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/checkbox', false, /checkbox.*.json$/); + const req = require.context('docs/translations/api-docs-joy/checkbox', false, /checkbox.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/chip-delete.js b/docs/pages/joy-ui/api/chip-delete.js index 0d3f508dfc08ea..39698b8886be15 100644 --- a/docs/pages/joy-ui/api/chip-delete.js +++ b/docs/pages/joy-ui/api/chip-delete.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/chip-delete', + 'docs/translations/api-docs-joy/chip-delete', false, /chip-delete.*.json$/, ); diff --git a/docs/pages/joy-ui/api/chip.js b/docs/pages/joy-ui/api/chip.js index dce59e6ca9c489..becc5c4656a95b 100644 --- a/docs/pages/joy-ui/api/chip.js +++ b/docs/pages/joy-ui/api/chip.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/chip', false, /chip.*.json$/); + const req = require.context('docs/translations/api-docs-joy/chip', false, /chip.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/circular-progress.js b/docs/pages/joy-ui/api/circular-progress.js index 3c1f447e891e4d..99973fb75b7d20 100644 --- a/docs/pages/joy-ui/api/circular-progress.js +++ b/docs/pages/joy-ui/api/circular-progress.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/circular-progress', + 'docs/translations/api-docs-joy/circular-progress', false, /circular-progress.*.json$/, ); diff --git a/docs/pages/joy-ui/api/css-baseline.js b/docs/pages/joy-ui/api/css-baseline.js index 6bb60d8ee9f04c..6fe78ac3fb9d43 100644 --- a/docs/pages/joy-ui/api/css-baseline.js +++ b/docs/pages/joy-ui/api/css-baseline.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/css-baseline', + 'docs/translations/api-docs-joy/css-baseline', false, /css-baseline.*.json$/, ); diff --git a/docs/pages/joy-ui/api/divider.js b/docs/pages/joy-ui/api/divider.js index 72044e9d17d343..018e205ed7d7ea 100644 --- a/docs/pages/joy-ui/api/divider.js +++ b/docs/pages/joy-ui/api/divider.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/divider', false, /divider.*.json$/); + const req = require.context('docs/translations/api-docs-joy/divider', false, /divider.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/form-control.js b/docs/pages/joy-ui/api/form-control.js index 380d4f46e73625..fe1436d9acbf30 100644 --- a/docs/pages/joy-ui/api/form-control.js +++ b/docs/pages/joy-ui/api/form-control.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/form-control', + 'docs/translations/api-docs-joy/form-control', false, /form-control.*.json$/, ); diff --git a/docs/pages/joy-ui/api/form-helper-text.js b/docs/pages/joy-ui/api/form-helper-text.js index f90e49d2cff7d3..bb9f7d5ef3010c 100644 --- a/docs/pages/joy-ui/api/form-helper-text.js +++ b/docs/pages/joy-ui/api/form-helper-text.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/form-helper-text', + 'docs/translations/api-docs-joy/form-helper-text', false, /form-helper-text.*.json$/, ); diff --git a/docs/pages/joy-ui/api/form-label.js b/docs/pages/joy-ui/api/form-label.js index 029a4b5d721a95..a17441b6360311 100644 --- a/docs/pages/joy-ui/api/form-label.js +++ b/docs/pages/joy-ui/api/form-label.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/form-label', false, /form-label.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/form-label', + false, + /form-label.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/icon-button.js b/docs/pages/joy-ui/api/icon-button.js index 8d880c94791f40..b74a97145df7bb 100644 --- a/docs/pages/joy-ui/api/icon-button.js +++ b/docs/pages/joy-ui/api/icon-button.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/icon-button', + 'docs/translations/api-docs-joy/icon-button', false, /icon-button.*.json$/, ); diff --git a/docs/pages/joy-ui/api/input.js b/docs/pages/joy-ui/api/input.js index e23210a40a1e98..5148e848df28b1 100644 --- a/docs/pages/joy-ui/api/input.js +++ b/docs/pages/joy-ui/api/input.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/input', false, /input.*.json$/); + const req = require.context('docs/translations/api-docs-joy/input', false, /input.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/linear-progress.js b/docs/pages/joy-ui/api/linear-progress.js index 9a53abc65ef7bf..913b381ac10b9d 100644 --- a/docs/pages/joy-ui/api/linear-progress.js +++ b/docs/pages/joy-ui/api/linear-progress.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/linear-progress', + 'docs/translations/api-docs-joy/linear-progress', false, /linear-progress.*.json$/, ); diff --git a/docs/pages/joy-ui/api/link.js b/docs/pages/joy-ui/api/link.js index 169cf91892fca4..cefc7a511cf31a 100644 --- a/docs/pages/joy-ui/api/link.js +++ b/docs/pages/joy-ui/api/link.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/link', false, /link.*.json$/); + const req = require.context('docs/translations/api-docs-joy/link', false, /link.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/list-divider.js b/docs/pages/joy-ui/api/list-divider.js index e1fb8484708de4..7368cf339d4cb5 100644 --- a/docs/pages/joy-ui/api/list-divider.js +++ b/docs/pages/joy-ui/api/list-divider.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/list-divider', + 'docs/translations/api-docs-joy/list-divider', false, /list-divider.*.json$/, ); diff --git a/docs/pages/joy-ui/api/list-item-button.js b/docs/pages/joy-ui/api/list-item-button.js index a9307d09e55004..e89eeff96e040a 100644 --- a/docs/pages/joy-ui/api/list-item-button.js +++ b/docs/pages/joy-ui/api/list-item-button.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/list-item-button', + 'docs/translations/api-docs-joy/list-item-button', false, /list-item-button.*.json$/, ); diff --git a/docs/pages/joy-ui/api/list-item-content.js b/docs/pages/joy-ui/api/list-item-content.js index bcc09cb276402a..46a470fbd462f6 100644 --- a/docs/pages/joy-ui/api/list-item-content.js +++ b/docs/pages/joy-ui/api/list-item-content.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/list-item-content', + 'docs/translations/api-docs-joy/list-item-content', false, /list-item-content.*.json$/, ); diff --git a/docs/pages/joy-ui/api/list-item-decorator.js b/docs/pages/joy-ui/api/list-item-decorator.js index 0f0cdca73f183a..34d3416aeb72fa 100644 --- a/docs/pages/joy-ui/api/list-item-decorator.js +++ b/docs/pages/joy-ui/api/list-item-decorator.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/list-item-decorator', + 'docs/translations/api-docs-joy/list-item-decorator', false, /list-item-decorator.*.json$/, ); diff --git a/docs/pages/joy-ui/api/list-item.js b/docs/pages/joy-ui/api/list-item.js index 4fc2f704505775..795326d3b784e8 100644 --- a/docs/pages/joy-ui/api/list-item.js +++ b/docs/pages/joy-ui/api/list-item.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/list-item', false, /list-item.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/list-item', + false, + /list-item.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/list-subheader.js b/docs/pages/joy-ui/api/list-subheader.js index 76f688f634b7b4..40c4ae82a46e44 100644 --- a/docs/pages/joy-ui/api/list-subheader.js +++ b/docs/pages/joy-ui/api/list-subheader.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/list-subheader', + 'docs/translations/api-docs-joy/list-subheader', false, /list-subheader.*.json$/, ); diff --git a/docs/pages/joy-ui/api/list.js b/docs/pages/joy-ui/api/list.js index f9e574b5dd8fee..eb6d30911256fa 100644 --- a/docs/pages/joy-ui/api/list.js +++ b/docs/pages/joy-ui/api/list.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/list', false, /list.*.json$/); + const req = require.context('docs/translations/api-docs-joy/list', false, /list.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/menu-item.js b/docs/pages/joy-ui/api/menu-item.js index 0ade9979d879a0..7c25eabddc7a9d 100644 --- a/docs/pages/joy-ui/api/menu-item.js +++ b/docs/pages/joy-ui/api/menu-item.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/menu-item', false, /menu-item.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/menu-item', + false, + /menu-item.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/menu-list.js b/docs/pages/joy-ui/api/menu-list.js index 98269ca9d3408e..328df9707e3920 100644 --- a/docs/pages/joy-ui/api/menu-list.js +++ b/docs/pages/joy-ui/api/menu-list.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/menu-list', false, /menu-list.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/menu-list', + false, + /menu-list.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/menu.js b/docs/pages/joy-ui/api/menu.js index 7ed6ff1f4cf692..9d8852e164459a 100644 --- a/docs/pages/joy-ui/api/menu.js +++ b/docs/pages/joy-ui/api/menu.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/menu', false, /menu.*.json$/); + const req = require.context('docs/translations/api-docs-joy/menu', false, /menu.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/modal-close.js b/docs/pages/joy-ui/api/modal-close.js index 6acbd161ff954e..2e1f20037a8b9b 100644 --- a/docs/pages/joy-ui/api/modal-close.js +++ b/docs/pages/joy-ui/api/modal-close.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/modal-close', + 'docs/translations/api-docs-joy/modal-close', false, /modal-close.*.json$/, ); diff --git a/docs/pages/joy-ui/api/modal-dialog.js b/docs/pages/joy-ui/api/modal-dialog.js index dca619aae97ae8..7a075af2d745a4 100644 --- a/docs/pages/joy-ui/api/modal-dialog.js +++ b/docs/pages/joy-ui/api/modal-dialog.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/modal-dialog', + 'docs/translations/api-docs-joy/modal-dialog', false, /modal-dialog.*.json$/, ); diff --git a/docs/pages/joy-ui/api/modal-overflow.js b/docs/pages/joy-ui/api/modal-overflow.js index b832c31cedd1d7..05d8f4ee7ca5e4 100644 --- a/docs/pages/joy-ui/api/modal-overflow.js +++ b/docs/pages/joy-ui/api/modal-overflow.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/modal-overflow', + 'docs/translations/api-docs-joy/modal-overflow', false, /modal-overflow.*.json$/, ); diff --git a/docs/pages/joy-ui/api/modal.js b/docs/pages/joy-ui/api/modal.js index d3c0a292b31b49..ef6790a308f66d 100644 --- a/docs/pages/joy-ui/api/modal.js +++ b/docs/pages/joy-ui/api/modal.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/modal', false, /modal.*.json$/); + const req = require.context('docs/translations/api-docs-joy/modal', false, /modal.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/option.js b/docs/pages/joy-ui/api/option.js index 407f0a0c666e6c..5e0ef1712e7508 100644 --- a/docs/pages/joy-ui/api/option.js +++ b/docs/pages/joy-ui/api/option.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/option', false, /option.*.json$/); + const req = require.context('docs/translations/api-docs-joy/option', false, /option.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/radio-group.js b/docs/pages/joy-ui/api/radio-group.js index 3a7599262211b2..d06674a93711c6 100644 --- a/docs/pages/joy-ui/api/radio-group.js +++ b/docs/pages/joy-ui/api/radio-group.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/radio-group', + 'docs/translations/api-docs-joy/radio-group', false, /radio-group.*.json$/, ); diff --git a/docs/pages/joy-ui/api/radio.js b/docs/pages/joy-ui/api/radio.js index f0280245c1d835..3aa10955c27845 100644 --- a/docs/pages/joy-ui/api/radio.js +++ b/docs/pages/joy-ui/api/radio.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/radio', false, /radio.*.json$/); + const req = require.context('docs/translations/api-docs-joy/radio', false, /radio.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/scoped-css-baseline.js b/docs/pages/joy-ui/api/scoped-css-baseline.js index 4cbb0177db7fc6..169d8079db865d 100644 --- a/docs/pages/joy-ui/api/scoped-css-baseline.js +++ b/docs/pages/joy-ui/api/scoped-css-baseline.js @@ -10,7 +10,7 @@ export default function Page(props) { Page.getInitialProps = () => { const req = require.context( - 'docs/translations/api-docs/scoped-css-baseline', + 'docs/translations/api-docs-joy/scoped-css-baseline', false, /scoped-css-baseline.*.json$/, ); diff --git a/docs/pages/joy-ui/api/select.js b/docs/pages/joy-ui/api/select.js index 42e65d0af26441..2aee4a53ac36ce 100644 --- a/docs/pages/joy-ui/api/select.js +++ b/docs/pages/joy-ui/api/select.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/select', false, /select.*.json$/); + const req = require.context('docs/translations/api-docs-joy/select', false, /select.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/sheet.js b/docs/pages/joy-ui/api/sheet.js index 919c00509ce008..01e2356cf17d4e 100644 --- a/docs/pages/joy-ui/api/sheet.js +++ b/docs/pages/joy-ui/api/sheet.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/sheet', false, /sheet.*.json$/); + const req = require.context('docs/translations/api-docs-joy/sheet', false, /sheet.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/slider.js b/docs/pages/joy-ui/api/slider.js index 768c767c931f60..8b09d18829b5fa 100644 --- a/docs/pages/joy-ui/api/slider.js +++ b/docs/pages/joy-ui/api/slider.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/slider', false, /slider.*.json$/); + const req = require.context('docs/translations/api-docs-joy/slider', false, /slider.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/stack.js b/docs/pages/joy-ui/api/stack.js index 9544e37c5e9ad1..fb0d64b8ba91a4 100644 --- a/docs/pages/joy-ui/api/stack.js +++ b/docs/pages/joy-ui/api/stack.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/stack', false, /stack.*.json$/); + const req = require.context('docs/translations/api-docs-joy/stack', false, /stack.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/svg-icon.js b/docs/pages/joy-ui/api/svg-icon.js index 6353473c58fe18..5587325c7a8351 100644 --- a/docs/pages/joy-ui/api/svg-icon.js +++ b/docs/pages/joy-ui/api/svg-icon.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/svg-icon', false, /svg-icon.*.json$/); + const req = require.context('docs/translations/api-docs-joy/svg-icon', false, /svg-icon.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/switch.js b/docs/pages/joy-ui/api/switch.js index 6038ed77d88509..251a53ea2dde37 100644 --- a/docs/pages/joy-ui/api/switch.js +++ b/docs/pages/joy-ui/api/switch.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/switch', false, /switch.*.json$/); + const req = require.context('docs/translations/api-docs-joy/switch', false, /switch.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/tab-list.js b/docs/pages/joy-ui/api/tab-list.js index 922412b7c1ed55..05c1990d59aca3 100644 --- a/docs/pages/joy-ui/api/tab-list.js +++ b/docs/pages/joy-ui/api/tab-list.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/tab-list', false, /tab-list.*.json$/); + const req = require.context('docs/translations/api-docs-joy/tab-list', false, /tab-list.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/tab-panel.js b/docs/pages/joy-ui/api/tab-panel.js index f7a6710df28eb8..a3ad5d3d2b35d0 100644 --- a/docs/pages/joy-ui/api/tab-panel.js +++ b/docs/pages/joy-ui/api/tab-panel.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/tab-panel', false, /tab-panel.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/tab-panel', + false, + /tab-panel.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/tab.js b/docs/pages/joy-ui/api/tab.js index 9a39374793fe55..946f0bad09c092 100644 --- a/docs/pages/joy-ui/api/tab.js +++ b/docs/pages/joy-ui/api/tab.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/tab', false, /tab.*.json$/); + const req = require.context('docs/translations/api-docs-joy/tab', false, /tab.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/table.js b/docs/pages/joy-ui/api/table.js index eac919239c9b5d..f72830a7e92af2 100644 --- a/docs/pages/joy-ui/api/table.js +++ b/docs/pages/joy-ui/api/table.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/table', false, /table.*.json$/); + const req = require.context('docs/translations/api-docs-joy/table', false, /table.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/tabs.js b/docs/pages/joy-ui/api/tabs.js index 89fb45a9a0359a..88c7dbafee813f 100644 --- a/docs/pages/joy-ui/api/tabs.js +++ b/docs/pages/joy-ui/api/tabs.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/tabs', false, /tabs.*.json$/); + const req = require.context('docs/translations/api-docs-joy/tabs', false, /tabs.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/textarea.js b/docs/pages/joy-ui/api/textarea.js index ca4a8077f21281..4acc6adc593e90 100644 --- a/docs/pages/joy-ui/api/textarea.js +++ b/docs/pages/joy-ui/api/textarea.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/textarea', false, /textarea.*.json$/); + const req = require.context('docs/translations/api-docs-joy/textarea', false, /textarea.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/tooltip.js b/docs/pages/joy-ui/api/tooltip.js index 83ec1312d014c9..50d17684416fb8 100644 --- a/docs/pages/joy-ui/api/tooltip.js +++ b/docs/pages/joy-ui/api/tooltip.js @@ -9,7 +9,7 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/tooltip', false, /tooltip.*.json$/); + const req = require.context('docs/translations/api-docs-joy/tooltip', false, /tooltip.*.json$/); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/pages/joy-ui/api/typography.js b/docs/pages/joy-ui/api/typography.js index 5b2785af0f9655..d159b1190f218d 100644 --- a/docs/pages/joy-ui/api/typography.js +++ b/docs/pages/joy-ui/api/typography.js @@ -9,7 +9,11 @@ export default function Page(props) { } Page.getInitialProps = () => { - const req = require.context('docs/translations/api-docs/typography', false, /typography.*.json$/); + const req = require.context( + 'docs/translations/api-docs-joy/typography', + false, + /typography.*.json$/, + ); const descriptions = mapApiPageTranslations(req); return { diff --git a/docs/translations/api-docs/alert/alert.json b/docs/translations/api-docs/alert/alert.json index 272cde996ffc11..ea1893da3a3810 100644 --- a/docs/translations/api-docs/alert/alert.json +++ b/docs/translations/api-docs/alert/alert.json @@ -1,104 +1,112 @@ { "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.", + "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.", - "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.", + "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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "variant": "The variant to use." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "filled": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"primary\"" + "conditions": "variant=\"filled\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlined": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "variant=\"outlined\"" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "standard": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"info\"" + "conditions": "variant=\"standard\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "standardSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "variant=\"standard\" and color=\"success\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "standardInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"success\"" + "conditions": "variant=\"standard\" and color=\"info\"" }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "standardWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"warning\"" + "conditions": "variant=\"standard\" and color=\"warning\"" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "standardError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "endDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the endDecorator element", - "conditions": "supplied" + "conditions": "variant=\"standard\" and color=\"error\"" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlinedSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"sm\"" + "conditions": "variant=\"outlined\" and color=\"success\"" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlinedInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"md\"" + "conditions": "variant=\"outlined\" and color=\"info\"" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlinedWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"lg\"" + "conditions": "variant=\"outlined\" and color=\"warning\"" }, - "startDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the startDecorator element", - "conditions": "supplied" + "outlinedError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"error\"" }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "conditions": "variant=\"filled\" and color=\"success\"" }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "conditions": "variant=\"filled\" and color=\"info\"" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "conditions": "variant=\"filled\" and color=\"warning\"" }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "variant=\"filled\" and color=\"error\"" + }, + "icon": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the icon wrapper element" + }, + "message": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the message wrapper element" + }, + "action": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the action wrapper element", + "conditions": "action is provided" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." } } diff --git a/docs/translations/api-docs/autocomplete/autocomplete.json b/docs/translations/api-docs/autocomplete/autocomplete.json index ae572296547d1a..54ebd6ebd1aba9 100644 --- a/docs/translations/api-docs/autocomplete/autocomplete.json +++ b/docs/translations/api-docs/autocomplete/autocomplete.json @@ -1,34 +1,45 @@ { "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.", + "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.", - "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.", + "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.", - "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.", + "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.", - "getLimitTagsText": "The label to display when the tags are truncated (limitTags).

Signature:
function(more: string | number) => ReactNode
more: The number of truncated tags.", + "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.", - "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".", @@ -36,185 +47,120 @@ "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.", - "placeholder": "The input placeholder", + "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.", - "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "wrapper": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the wrapper element" - }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, - "startDecorator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the startDecorator element" - }, - "endDecorator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the endDecorator element" + "root": { "description": "Styles applied to the root element." }, + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "fullWidth={true}" }, - "formControl": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "expanded": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "the component is a descendant of FormControl" + "conditions": "the listbox is displayed" }, "focused": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "the component is focused" + "conditions": "focused" }, - "disabled": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "disabled={true}" + "tag": { + "description": "Styles applied to {{nodeName}}, {{conditions}}.", + "nodeName": "the tag elements", + "conditions": "e.g. the chips" }, - "error": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "error={true}" + "tagSizeSmall": { + "description": "Styles applied to {{nodeName}}, {{conditions}}.", + "nodeName": "the tag elements", + "conditions": "e.g. the chips if size=\"small\"" + }, + "tagSizeMedium": { + "description": "Styles applied to {{nodeName}}, {{conditions}}.", + "nodeName": "the tag elements", + "conditions": "e.g. the chips if size=\"medium\"" + }, + "hasPopupIcon": { "description": "Styles applied when the popup icon is rendered." }, + "hasClearIcon": { "description": "Styles applied when the clear icon is rendered." }, + "inputRoot": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the Input element" }, - "multiple": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the wrapper element", - "conditions": "multiple={true}" + "input": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the input element" }, + "inputFocused": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the input element", + "conditions": "the input is focused" }, - "limitTag": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the limitTag element" + "endAdornment": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the endAdornment element" }, - "hasPopupIcon": { "description": "Class name applied when the popup icon is rendered." }, - "hasClearIcon": { "description": "Class name applied when the clear icon is rendered." }, "clearIndicator": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the clear indicator" }, "popupIndicator": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the popup indicator" }, "popupIndicatorOpen": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the popup indicator", "conditions": "the popup is open" }, + "popper": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the popper element" + }, + "popperDisablePortal": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the popper element", + "conditions": "disablePortal={true}" + }, + "paper": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the Paper component" + }, "listbox": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the listbox component" }, - "option": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the option component" - }, "loading": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the loading wrapper" }, "noOptions": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the no option wrapper" }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "option": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the option elements" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "groupLabel": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the group's label elements" }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "groupUl": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the group's ul elements" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "wrapper": "The component that renders the wrapper.", - "input": "The component that renders the input.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator.", - "clearIndicator": "The component that renders the clear indicator.", - "popupIndicator": "The component that renders the popup indicator.", - "listbox": "The component that renders the listbox.", - "option": "The component that renders the option.", - "loading": "The component that renders the loading.", - "noOptions": "The component that renders the no-options.", - "limitTag": "The component that renders the limit tag." } } diff --git a/docs/translations/api-docs/avatar-group/avatar-group.json b/docs/translations/api-docs/avatar-group/avatar-group.json index 9d7fae700387dd..af216ecd52b34d 100644 --- a/docs/translations/api-docs/avatar-group/avatar-group.json +++ b/docs/translations/api-docs/avatar-group/avatar-group.json @@ -1,15 +1,22 @@ { "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.", + "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.", - "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.", + "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.", - "variant": "The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "total": "The total number of avatars. Used for calculating the number of extra avatars.", + "variant": "The variant to use." }, - "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, - "slotDescriptions": { "root": "The component that renders the root." } + "classDescriptions": { + "root": { "description": "Styles applied to the root element." }, + "avatar": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the avatar elements" + } + } } diff --git a/docs/translations/api-docs/avatar/avatar.json b/docs/translations/api-docs/avatar/avatar.json index 5297faf8a62a6f..585772ace3613f 100644 --- a/docs/translations/api-docs/avatar/avatar.json +++ b/docs/translations/api-docs/avatar/avatar.json @@ -3,96 +3,42 @@ "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.", + "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.", - "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.", + "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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "variant": "The shape of the avatar." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "colorDefault": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"primary\"" + "conditions": "not src or srcSet" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "circular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "variant=\"circular\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "rounded": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "variant=\"rounded\"" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "square": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "fallback": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the fallback icon" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" + "conditions": "variant=\"square\"" }, "img": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the img element", "conditions": "either src or srcSet is defined" }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "img": "The component that renders the img.", - "fallback": "The component that renders the fallback." + "fallback": { "description": "Styles applied to the fallback icon" } } } diff --git a/docs/translations/api-docs/badge/badge.json b/docs/translations/api-docs/badge/badge.json index 57d56e4627179e..677e829f386373 100644 --- a/docs/translations/api-docs/badge/badge.json +++ b/docs/translations/api-docs/badge/badge.json @@ -1,20 +1,14 @@ { "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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, @@ -22,110 +16,10 @@ "description": "Class name applied to {{nodeName}}.", "nodeName": "the badge `span` element" }, - "anchorOriginTopRight": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "anchorOrigin={{ 'top', 'right' }}" - }, - "anchorOriginBottomRight": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "anchorOrigin={{ 'bottom', 'right' }}" - }, - "anchorOriginTopLeft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "anchorOrigin={{ 'top', 'left' }}" - }, - "anchorOriginBottomLeft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "anchorOrigin={{ 'bottom', 'left' }}" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"primary\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"info\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"neutral\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, "invisible": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the badge `span` element", "conditions": "invisible={true}" - }, - "locationInside": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "location=\"inside\"" - }, - "locationOutside": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "location=\"outside\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "size=\"lg\"" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the badge `span` element", - "conditions": "variant=\"solid\"" } }, "slotDescriptions": { diff --git a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json index cf9e2f9325d7c7..5ec041c625611f 100644 --- a/docs/translations/api-docs/breadcrumbs/breadcrumbs.json +++ b/docs/translations/api-docs/breadcrumbs/breadcrumbs.json @@ -2,41 +2,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.", "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.", - "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.", + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "ol": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the ol element" }, - "li": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the li element" }, + "root": { "description": "Styles applied to the root element." }, + "ol": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the ol element" }, + "li": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the li element" }, "separator": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the separator element" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "ol": "The component that renders the ol.", - "li": "The component that renders the li.", - "separator": "The component that renders the separator." } } diff --git a/docs/translations/api-docs/button/button.json b/docs/translations/api-docs/button/button.json index 1b2359cb447569..e880be5b3dbae4 100644 --- a/docs/translations/api-docs/button/button.json +++ b/docs/translations/api-docs/button/button.json @@ -1,133 +1,29 @@ { - "componentDescription": "", + "componentDescription": "The foundation for building custom-styled buttons.", "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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "focusVisible": { + "active": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the ButtonBase root element", - "conditions": "the button is keyboard focused" + "nodeName": "the root `button` element", + "conditions": "active={true}" }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "nodeName": "the root `button` element", "conditions": "disabled={true}" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "fullWidth": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fullWidth={true}" - }, - "startDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the startDecorator element", - "conditions": "supplied" - }, - "endDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the endDecorator element", - "conditions": "supplied" - }, - "loading": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "loading={true}" - }, - "loadingIndicatorCenter": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the loadingIndicatorCenter element" + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `button` element", + "conditions": "focusVisible={true}" } }, - "slotDescriptions": { - "root": "The component that renders the root.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator.", - "loadingIndicatorCenter": "The component that renders the loading indicator center." - } + "slotDescriptions": { "root": "The component that renders the root." } } diff --git a/docs/translations/api-docs/card-content/card-content.json b/docs/translations/api-docs/card-content/card-content.json index 44696adcb84b77..ff27adf5730304 100644 --- a/docs/translations/api-docs/card-content/card-content.json +++ b/docs/translations/api-docs/card-content/card-content.json @@ -1,12 +1,10 @@ { "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.", + "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.", - "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." }, - "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, - "slotDescriptions": { "root": "The component that renders the root." } + "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 6888ced30db8d9..feb6f7366eddd9 100644 --- a/docs/translations/api-docs/card/card.json +++ b/docs/translations/api-docs/card/card.json @@ -1,99 +1,10 @@ { "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": "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." }, - "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" - }, - "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"vertical\"" - } - }, - "slotDescriptions": { "root": "The component that renders the root." } + "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 a0368b267720c1..edd98e7b792b81 100644 --- a/docs/translations/api-docs/checkbox/checkbox.json +++ b/docs/translations/api-docs/checkbox/checkbox.json @@ -3,56 +3,34 @@ "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.", + "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.", - "disableIcon": "If true, the checked icon is removed and the selected variant is applied on the action element instead.", + "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.", - "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.", + "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. 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.", + "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.", - "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." + "value": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "checkbox": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the checkbox element" - }, - "action": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the action element" - }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, - "label": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the label element" - }, + "root": { "description": "Styles applied to the root element." }, "checked": { - "description": "State class applied to {{nodeName}}.", - "nodeName": "the input component's `checked` class" + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "checked={true}" }, "disabled": { - "description": "State class applied to {{nodeName}}.", - "nodeName": "the input component's disabled class" - }, - "focusVisible": { - "description": "Class name applied to the root element if the switch has visible focus" + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "disabled={true}" }, "indeterminate": { "description": "State class applied to {{nodeName}} if {{conditions}}.", @@ -60,76 +38,14 @@ "conditions": "indeterminate={true}" }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "color=\"secondary\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "checkbox": "The component that renders the checkbox.", - "action": "The component that renders the action.", - "input": "The component that renders the input.", - "label": "The component that renders the label." } } diff --git a/docs/translations/api-docs/chip/chip.json b/docs/translations/api-docs/chip/chip.json index f0443706901b0d..2a39e6b8f90a2e 100644 --- a/docs/translations/api-docs/chip/chip.json +++ b/docs/translations/api-docs/chip/chip.json @@ -1,136 +1,236 @@ { "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.", + "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.", - "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.", + "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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "variant": "The variant to use." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"primary\"" + "conditions": "size=\"small\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "sizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "size=\"medium\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "color=\"error\"" }, "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"info\"" }, + "colorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"primary\"" + }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"secondary\"" + }, "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"success\"" }, "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"warning\"" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "disabled={true}" }, - "endDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the endDecorator element", - "conditions": "supplied" - }, - "focusVisible": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "clickable": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "keyboard focused" + "conditions": "onClick is defined or clickable={true}" }, - "label": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the label `span` element" + "clickableColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "onClick and color=\"primary\" is defined or clickable={true}" }, - "labelSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the label `span` element", - "conditions": "size=\"sm\"" + "clickableColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "onClick and color=\"secondary\" is defined or clickable={true}" }, - "labelMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the label `span` element", - "conditions": "size=\"md\"" + "deletable": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "onDelete is defined" }, - "labelLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the label `span` element", - "conditions": "size=\"lg\"" + "deletableColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "onDelete and color=\"primary\" is defined" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "deletableColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"sm\"" + "conditions": "onDelete and color=\"secondary\" is defined" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlined": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"md\"" + "conditions": "variant=\"outlined\"" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filled": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"lg\"" + "conditions": "variant=\"filled\"" }, - "startDecorator": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the startDecorator element", - "conditions": "supplied" + "outlinedPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"primary\"" }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "outlinedSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "conditions": "variant=\"outlined\" and color=\"secondary\"" }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "variant=\"filled\" and color=\"primary\"" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "filledSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "conditions": "variant=\"filled\" and color=\"secondary\"" + }, + "avatar": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the avatar element" + }, + "avatarSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the avatar element", + "conditions": "size=\"small\"" + }, + "avatarMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the avatar element", + "conditions": "size=\"medium\"" + }, + "avatarColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the avatar element", + "conditions": "color=\"primary\"" + }, + "avatarColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the avatar element", + "conditions": "color=\"secondary\"" + }, + "icon": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the icon element" }, + "iconSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "size=\"small\"" + }, + "iconMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "size=\"medium\"" + }, + "iconColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "color=\"primary\"" + }, + "iconColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "color=\"secondary\"" + }, + "label": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the label `span` element" + }, + "labelSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the label `span` element", + "conditions": "size=\"small\"" + }, + "labelMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the label `span` element", + "conditions": "size=\"medium\"" + }, + "deleteIcon": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the deleteIcon element" + }, + "deleteIconSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "size=\"small\"" + }, + "deleteIconMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "size=\"medium\"" + }, + "deleteIconColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"primary\" and variant=\"filled\"" + }, + "deleteIconColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"secondary\" and variant=\"filled\"" + }, + "deleteIconOutlinedColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"primary\" and variant=\"outlined\"" + }, + "deleteIconOutlinedColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"secondary\" and variant=\"outlined\"" + }, + "deleteIconFilledColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"primary\" and variant=\"filled\"" + }, + "deleteIconFilledColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the deleteIcon element", + "conditions": "color=\"secondary\" and variant=\"filled\"" }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "conditions": "keyboard focused" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "label": "The component that renders the label.", - "action": "The component that renders the action.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." } } diff --git a/docs/translations/api-docs/circular-progress/circular-progress.json b/docs/translations/api-docs/circular-progress/circular-progress.json index cfc511917f4a38..0536e31502071f 100644 --- a/docs/translations/api-docs/circular-progress/circular-progress.json +++ b/docs/translations/api-docs/circular-progress/circular-progress.json @@ -1,108 +1,56 @@ { "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.", + "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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants." + "variant": "The variant to use. Use indeterminate when there is no progress value." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, "determinate": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "determinate is true" + "conditions": "variant=\"determinate\"" }, - "svg": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the svg element" }, - "track": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the `track` element" - }, - "progress": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the `progress` element" + "indeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"indeterminate\"" }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"info\"" + "conditions": "color=\"secondary\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" + "svg": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the svg element" }, + "circle": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the `circle` svg path" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" + "circleDeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the `circle` svg path", + "conditions": "variant=\"determinate\"" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" + "circleIndeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the `circle` svg path", + "conditions": "variant=\"indeterminate\"" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "circleDisableShrink": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the `circle` svg path", + "conditions": "disableShrink={true}" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "svg": "The component that renders the svg.", - "track": "The component that renders the track.", - "progress": "The component that renders the progress." } } diff --git a/docs/translations/api-docs/css-baseline/css-baseline.json b/docs/translations/api-docs/css-baseline/css-baseline.json index f2fcbd9425d184..4ee0b2b962dff0 100644 --- a/docs/translations/api-docs/css-baseline/css-baseline.json +++ b/docs/translations/api-docs/css-baseline/css-baseline.json @@ -2,7 +2,7 @@ "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" + "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" }, "classDescriptions": {} } diff --git a/docs/translations/api-docs/divider/divider.json b/docs/translations/api-docs/divider/divider.json index 82a3af78429e10..df91195b789978 100644 --- a/docs/translations/api-docs/divider/divider.json +++ b/docs/translations/api-docs/divider/divider.json @@ -1,36 +1,83 @@ { "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.", - "inset": "Class name applied to the divider to shrink or stretch the line based on the orientation.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "absolute": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" + "conditions": "absolute={true}" + }, + "inset": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"inset\"" + }, + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"fullWidth\"" + }, + "light": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "light={true}" + }, + "middle": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"middle\"" }, "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "orientation=\"vertical\"" }, - "insetContext": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "flexItem": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "flexItem={true}" + }, + "withChildren": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "divider have text" + }, + "withChildrenVertical": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "divider have text and orientation=\"vertical\"" + }, + "textAlignRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "inset=\"context\"" + "conditions": "textAlign=\"right\" orientation=\"horizontal\"" }, - "insetNone": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "textAlignLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "inset=\"none\"" + "conditions": "textAlign=\"left\" orientation=\"horizontal\"" + }, + "wrapper": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the span children element", + "conditions": "orientation=\"horizontal\"" + }, + "wrapperVertical": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the span children element", + "conditions": "orientation=\"vertical\"" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/form-control/form-control.json b/docs/translations/api-docs/form-control/form-control.json index 595dd81ec7ef20..1af947ce5c1f86 100644 --- a/docs/translations/api-docs/form-control/form-control.json +++ b/docs/translations/api-docs/form-control/form-control.json @@ -1,85 +1,15 @@ { - "componentDescription": "", + "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.", - "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." + "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." }, - "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "disabled": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "disabled={true}" - }, - "error": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "error={true}" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" - }, - "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"vertical\"" - } - }, - "slotDescriptions": { "root": "The component that renders the root." } + "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 3a039cdf5b968b..5c305d80f923a9 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,12 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "children": "The content of the component.", + "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.", - "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." + "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." }, - "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, - "slotDescriptions": { "root": "The component that renders the root." } + "classDescriptions": { + "root": { "description": "Styles applied to the root element." }, + "error": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "error={true}" + }, + "disabled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "disabled={true}" + }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\"" + }, + "contained": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"filled\" or variant=\"outlined\"" + }, + "focused": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "focused={true}" + }, + "filled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "filled={true}" + }, + "required": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "required={true}" + } + } } diff --git a/docs/translations/api-docs/form-label/form-label.json b/docs/translations/api-docs/form-label/form-label.json index 4c11f8cccedcb5..d4cb70dfdbaa70 100644 --- a/docs/translations/api-docs/form-label/form-label.json +++ b/docs/translations/api-docs/form-label/form-label.json @@ -2,21 +2,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.", + "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.", - "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.", + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "the color is secondary" + }, + "focused": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "focused={true}" + }, + "disabled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "disabled={true}" + }, + "error": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "error={true}" + }, + "filled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "filled={true}" + }, + "required": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "required={true}" + }, "asterisk": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the asterisk element" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "asterisk": "The component that renders the asterisk." } } diff --git a/docs/translations/api-docs/icon-button/icon-button.json b/docs/translations/api-docs/icon-button/icon-button.json index 423284b5d883f3..627a0420deb213 100644 --- a/docs/translations/api-docs/icon-button/icon-button.json +++ b/docs/translations/api-docs/icon-button/icon-button.json @@ -1,99 +1,82 @@ { - "componentDescription": "", + "componentDescription": "Refer to the [Icons](/material-ui/icons/) section of the documentation\nregarding the available icon options.", "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "edgeStart": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "edge=\"start\"" + }, + "edgeEnd": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "edge=\"end\"" + }, + "colorInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"inherit\"" + }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "color=\"secondary\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "color=\"error\"" }, "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"info\"" }, "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"success\"" }, "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"warning\"" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "focusVisible": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "the button is keyboard focused" - }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "disabled={true}" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"sm\"" + "conditions": "size=\"small\"" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "sizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"md\"" + "conditions": "size=\"medium\"" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "sizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"lg\"" + "conditions": "size=\"large\"" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/input/input.json b/docs/translations/api-docs/input/input.json index 10f8256303ed62..2853be93336b60 100644 --- a/docs/translations/api-docs/input/input.json +++ b/docs/translations/api-docs/input/input.json @@ -1,124 +1,84 @@ { "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.", - "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." + "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. 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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, "formControl": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "the component is a descendant of FormControl" }, - "focused": { + "adornedStart": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "the component is focused" + "conditions": "startAdornment is provided" }, - "disabled": { + "adornedEnd": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "disabled={true}" + "conditions": "endAdornment is provided" }, - "error": { + "focused": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "error={true}" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" + "conditions": "the component is focused" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "disabled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"lg\"" + "conditions": "disabled={true}" }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "error": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "conditions": "error={true}" }, - "variantOutlined": { + "multiline": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "conditions": "multiline={true}" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "input": { + "description": "Class name applied to {{nodeName}}.", + "nodeName": "the input element" }, - "variantSolid": { + "inputMultiline": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "nodeName": "the input element", + "conditions": "multiline={true}" }, - "fullWidth": { + "inputTypeSearch": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fullWidth={true}" - }, - "startDecorator": { "description": "Class name applied to the startDecorator element" }, - "endDecorator": { "description": "Class name applied to the endDecorator element" } + "nodeName": "the input element", + "conditions": "type=\"search\"" + } }, "slotDescriptions": { "root": "The component that renders the root.", "input": "The component that renders the input.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." + "textarea": "The component that renders the textarea." } } diff --git a/docs/translations/api-docs/linear-progress/linear-progress.json b/docs/translations/api-docs/linear-progress/linear-progress.json index 3060b04436a2cb..002004676364fb 100644 --- a/docs/translations/api-docs/linear-progress/linear-progress.json +++ b/docs/translations/api-docs/linear-progress/linear-progress.json @@ -1,94 +1,98 @@ { "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "colorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root and bar2 element", + "conditions": "color=\"primary\"; bar2 if variant=\"buffer\"" + }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root and bar2 elements", + "conditions": "color=\"secondary\"; bar2 if variant=\"buffer\"" + }, "determinate": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "determinate is true" + "conditions": "variant=\"determinate\"" }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "indeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"primary\"" + "conditions": "variant=\"indeterminate\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "buffer": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "variant=\"buffer\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "query": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "variant=\"query\"" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" + "dashed": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the additional bar element", + "conditions": "variant=\"buffer\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" + "dashedColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the additional bar element", + "conditions": "variant=\"buffer\" and color=\"primary\"" }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" + "dashedColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the additional bar element", + "conditions": "variant=\"buffer\" and color=\"secondary\"" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" + "bar": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the layered bar1 and bar2 elements" }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" + "barColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar elements", + "conditions": "color=\"primary\"; bar2 if variant not \"buffer\"" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" + "barColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar elements", + "conditions": "color=\"secondary\"; bar2 if variant not \"buffer\"" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" + "bar1Indeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar1 element", + "conditions": "variant=\"indeterminate or query\"" }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "bar1Determinate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar1 element", + "conditions": "variant=\"determinate\"" }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "bar1Buffer": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar1 element", + "conditions": "variant=\"buffer\"" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "bar2Indeterminate": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar2 element", + "conditions": "variant=\"indeterminate or query\"" }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "bar2Buffer": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the bar2 element", + "conditions": "variant=\"buffer\"" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/link/link.json b/docs/translations/api-docs/link/link.json index 782e727b76dc4f..cad1c837105e1b 100644 --- a/docs/translations/api-docs/link/link.json +++ b/docs/translations/api-docs/link/link.json @@ -2,153 +2,40 @@ "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.", + "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.", - "textColor": "The system color.", + "TypographyClasses": "classes prop applied to the Typography element.", "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." + "variant": "Applies the theme typography styles." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "disabled": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "disabled={true}" - }, - "focusVisible": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "the link is keyboard focused" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, + "root": { "description": "Styles applied to the root element." }, "underlineNone": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "underline=\"none\"" }, "underlineHover": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "underline=\"hover\"" }, "underlineAlways": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "underline=\"always\"" }, - "h1": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h1\"" - }, - "h2": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h2\"" - }, - "h3": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h3\"" - }, - "h4": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h4\"" - }, - "h5": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h5\"" - }, - "h6": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h6\"" - }, - "body1": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"body1\"" - }, - "body2": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "button": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"body2\"" + "conditions": "component=\"button\"" }, - "body3": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"body3\"" - }, - "startDecorator": { "description": "Class name applied to the startDecorator element" }, - "endDecorator": { "description": "Class name applied to the endDecorator element" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." + "conditions": "the link is keyboard focused" + } } } 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 9c11527415767f..8341f6efc9a6c4 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,101 +1,54 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", + "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.", - "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "vertical": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if orientation=\"vertical\"" - }, - "horizontal": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if orientation=\"horizontal\"" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"context\"" - }, + "root": { "description": "Styles applied to the root element." }, "focusVisible": { "description": "State class applied to {{nodeName}}.", "nodeName": "the `component`'s `focusVisibleClassName` prop" }, + "dense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the component element", + "conditions": "dense" + }, + "alignItemsFlexStart": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the component element", + "conditions": "alignItems=\"flex-start\"" + }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the inner `component` element", "conditions": "disabled={true}" }, - "selected": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "selected={true}" - }, - "variantPlain": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantSoft": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "divider": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "divider={true}" }, - "variantOutlined": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "gutters": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "disableGutters={true}" }, - "variantSolid": { + "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "selected={true}" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/list-item/list-item.json b/docs/translations/api-docs/list-item/list-item.json index 7caf906ef0a3bb..00611759e2cd21 100644 --- a/docs/translations/api-docs/list-item/list-item.json +++ b/docs/translations/api-docs/list-item/list-item.json @@ -1,104 +1,86 @@ { - "componentDescription": "", + "componentDescription": "Uses an additional container component if `ListItemSecondaryAction` is the last child.", "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "startAction": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the component element", - "conditions": "startAction element is provided" - }, - "endAction": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the component element", - "conditions": "endAction element is provided" - }, - "nested": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if nested={true}" - }, - "nesting": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if it is under a nested list item" + "root": { + "description": "Styles applied to {{nodeName}}. May be wrapped by a `container`.", + "nodeName": "the (normally root) `component` element" }, - "sticky": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if sticky={true}" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" + "container": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the container element", + "conditions": "children includes ListItemSecondaryAction" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the `component`'s `focusVisibleClassName` prop", + "conditions": "button={true}" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" + "dense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the component element", + "conditions": "dense" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" + "alignItemsFlexStart": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the component element", + "conditions": "alignItems=\"flex-start\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" + "disabled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "disabled={true}" }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" + "divider": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "divider={true}" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" + "gutters": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "disableGutters={true}" }, - "variantPlain": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "padding": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "conditions": "disablePadding={true}" }, - "variantSoft": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "button": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "button={true}" }, - "variantOutlined": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "secondaryAction": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the component element", + "conditions": "children includes ListItemSecondaryAction" }, - "variantSolid": { + "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "selected={true}" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "startAction": "The component that renders the start action.", - "endAction": "The component that renders the end action." } } diff --git a/docs/translations/api-docs/list-subheader/list-subheader.json b/docs/translations/api-docs/list-subheader/list-subheader.json index 45720b6993a8f0..33932ec54d3552 100644 --- a/docs/translations/api-docs/list-subheader/list-subheader.json +++ b/docs/translations/api-docs/list-subheader/list-subheader.json @@ -2,76 +2,40 @@ "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.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "sticky": { - "description": "Class name applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root element", - "conditions": "if sticky={true}" - }, + "root": { "description": "Styles applied to the root element." }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"success\"" + "conditions": "color=\"inherit\"" }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "gutters": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "disableGutters={true}" }, - "variantSoft": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "inset": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "conditions": "inset={true}" }, - "variantOutlined": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSolid": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "sticky": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "disableSticky={true}" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/list/list.json b/docs/translations/api-docs/list/list.json index 1df1151c16e80f..f90e8bf1693b4a 100644 --- a/docs/translations/api-docs/list/list.json +++ b/docs/translations/api-docs/list/list.json @@ -2,68 +2,29 @@ "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.", + "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.", - "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)." + "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." }, "classDescriptions": { - "root": { "description": "Classname applied to the root element." }, - "nesting": { - "description": "Classname applied to the root element if wrapped with nested context." - }, - "scoped": { "description": "Classname applied to the root element if `scoped` is true." }, - "sizeSm": { "description": "Classname applied to the root element if `size=\"sm\"`." }, - "sizeMd": { "description": "Classname applied to the root element if `size=\"md\"`." }, - "sizeLg": { "description": "Classname applied to the root element if `size=\"lg\"`." }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "padding": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", "nodeName": "the root element", - "conditions": "color inversion is triggered" + "conditions": "disablePadding={true}" }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." - }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "dense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" + "conditions": "dense" }, - "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "subheader": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "orientation=\"vertical\"" + "conditions": "a subheader is provided" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/menu-item/menu-item.json b/docs/translations/api-docs/menu-item/menu-item.json index 9e0532aa4ded04..1d5601b2a7adfa 100644 --- a/docs/translations/api-docs/menu-item/menu-item.json +++ b/docs/translations/api-docs/menu-item/menu-item.json @@ -1,84 +1,22 @@ { "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." + "component": "The component used for the root node. Either a string to use a HTML element or a component.", + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, - "focusVisible": { - "description": "State class applied to {{nodeName}}.", - "nodeName": "the `component`'s `focusVisibleClassName` prop" - }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the inner `component` element", + "nodeName": "the root `button` element", "conditions": "disabled={true}" }, - "selected": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "selected={true}" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantSoft": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantOutlined": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSolid": { + "focusVisible": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "nodeName": "the root `button` element", + "conditions": "focusVisible={true}" } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs/menu-list/menu-list.json b/docs/translations/api-docs/menu-list/menu-list.json index 6f2cb672147c2e..95d35092ebacc3 100644 --- a/docs/translations/api-docs/menu-list/menu-list.json +++ b/docs/translations/api-docs/menu-list/menu-list.json @@ -1,65 +1,29 @@ { - "componentDescription": "", + "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": { - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "padding": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"sm\"" + "conditions": "disablePadding={true}" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "dense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"md\"" + "conditions": "dense" }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "subheader": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." + "conditions": "a subheader is provided" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/menu/menu.json b/docs/translations/api-docs/menu/menu.json index 22900511139739..da3220db4b7701 100644 --- a/docs/translations/api-docs/menu/menu.json +++ b/docs/translations/api-docs/menu/menu.json @@ -2,61 +2,27 @@ "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.", + "anchorEl": "An HTML element, virtualElement, or a function that returns either. It's used to set the position of the popper.", "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.", + "onOpenChange": "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." + "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." }, "classDescriptions": { - "root": { "description": "Classname applied to the root element." }, - "listbox": { "description": "Classname applied to the listbox element." }, - "expanded": { "description": "Classname applied to the root element when the menu open." }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." - }, - "sizeSm": { "description": "Classname applied to the root element if `size=\"sm\"`." }, - "sizeMd": { "description": "Classname applied to the root element if `size=\"md\"`." }, - "sizeLg": { "description": "Classname applied to the root element if `size=\"lg\"`." } + "root": { "description": "Class name applied to the root element." }, + "listbox": { + "description": "Class name applied to {{nodeName}}.", + "nodeName": "the listbox element" + }, + "expanded": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `Popper` element and the listbox `ul` element", + "conditions": "open={true}" + } }, - "slotDescriptions": { "root": "The component that renders the root." } + "slotDescriptions": { + "root": "The component that renders the root.", + "listbox": "The component that renders the listbox." + } } diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index cab58d8e952fe4..83c5cf84ab30ec 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -1,7 +1,8 @@ { - "componentDescription": "", + "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.", "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.", @@ -12,14 +13,19 @@ "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".", + "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.", - "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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, + "hidden": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "the Modal has exited" + }, "backdrop": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the backdrop element" diff --git a/docs/translations/api-docs/option/option.json b/docs/translations/api-docs/option/option.json index a38126f4d6801c..9242960c42375e 100644 --- a/docs/translations/api-docs/option/option.json +++ b/docs/translations/api-docs/option/option.json @@ -1,88 +1,29 @@ { - "componentDescription": "", + "componentDescription": "An unstyled option to be used within a Select.", "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.", + "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.", - "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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"context\"" - }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "nodeName": "the root `li` element", "conditions": "disabled={true}" }, "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "the option is selected" + "nodeName": "the root `li` element", + "conditions": "selected={true}" }, "highlighted": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "the option is highlighted" - }, - "variantPlain": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantSoft": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantOutlined": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSolid": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "nodeName": "the root `li` element", + "conditions": "highlighted={true}" } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs/radio-group/radio-group.json b/docs/translations/api-docs/radio-group/radio-group.json index eef957bb749b2b..f6aaf9b25f7001 100644 --- a/docs/translations/api-docs/radio-group/radio-group.json +++ b/docs/translations/api-docs/radio-group/radio-group.json @@ -1,99 +1,23 @@ { "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.", + "children": "The content of the 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." + "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": { - "root": { "description": "Class name applied to the root element." }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "row": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"sm\"" + "conditions": "row={true}" }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "error": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" - }, - "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"vertical\"" + "conditions": "error={true}" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/radio/radio.json b/docs/translations/api-docs/radio/radio.json index e7824f297bfa91..a37b16ec49df88 100644 --- a/docs/translations/api-docs/radio/radio.json +++ b/docs/translations/api-docs/radio/radio.json @@ -3,133 +3,42 @@ "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.", + "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.", - "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.", + "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.", + "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).", - "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.", + "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.", - "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." + "value": "The value of the component. The DOM API casts this to a string." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "radio": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the radio element" - }, - "icon": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the icon element" - }, - "action": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the action element" - }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, - "label": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the label element" - }, + "root": { "description": "Styles applied to the root element." }, "checked": { - "description": "State class applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root", - "conditions": "action slots if checked" + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "checked={true}" }, "disabled": { - "description": "State class applied to {{nodeName}}, {{conditions}}.", - "nodeName": "the root", - "conditions": "action slots if disabled" - }, - "focusVisible": { - "description": "Class name applied to the root element if the switch has visible focus" + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "disabled={true}" }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "color=\"secondary\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "radio": "The component that renders the radio.", - "icon": "The component that renders the icon.", - "action": "The component that renders the action.", - "input": "The component that renders the input.", - "label": "The component that renders the label." } } diff --git a/docs/translations/api-docs/scoped-css-baseline/scoped-css-baseline.json b/docs/translations/api-docs/scoped-css-baseline/scoped-css-baseline.json index 261555f056fcdd..98a79e623f4841 100644 --- a/docs/translations/api-docs/scoped-css-baseline/scoped-css-baseline.json +++ b/docs/translations/api-docs/scoped-css-baseline/scoped-css-baseline.json @@ -1,13 +1,11 @@ { "componentDescription": "", "propDescriptions": { - "children": "You can wrap a node.", + "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.", - "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.", + "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", "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." }, - "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, - "slotDescriptions": { "root": "The component that renders the root." } + "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/select/select.json b/docs/translations/api-docs/select/select.json index a362701dee65df..590bbb9533d5fc 100644 --- a/docs/translations/api-docs/select/select.json +++ b/docs/translations/api-docs/select/select.json @@ -1,149 +1,58 @@ { - "componentDescription": "", + "componentDescription": "The foundation for building custom-styled select components.", "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.", + "disabled": "If true, the select is disabled.", "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.", + "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.", - "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.", + "optionStringifier": "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.", "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the root slot" }, - "button": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the button slot" - }, - "indicator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the indicator slot" - }, - "startDecorator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the startDecorator slot" - }, - "endDecorator": { + "root": { "description": "Class name applied to the root element." }, + "listbox": { "description": "Class name applied to {{nodeName}}.", - "nodeName": "the endDecorator slot" + "nodeName": "the listbox element" }, "popper": { "description": "Class name applied to {{nodeName}}.", - "nodeName": "the popper slot" - }, - "listbox": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the listbox slot" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"info\"" + "nodeName": "the popper element" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "variant=\"solid\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "size=\"lg\"" + "active": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `button` element", + "conditions": "active={true}" }, - "focusVisible": { + "expanded": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the SelectBase root slot", - "conditions": "the button is keyboard focused" + "nodeName": "the root `button` element", + "conditions": "expanded={true}" }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", + "nodeName": "the root `button` element and the listbox 'ul' element", "conditions": "disabled={true}" }, - "expanded": { + "focusVisible": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root slot", - "conditions": "listbox open" + "nodeName": "the root `button` element", + "conditions": "focusVisible={true}" } }, "slotDescriptions": { "root": "The component that renders the root.", - "button": "The component that renders the button.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator.", - "indicator": "The component that renders the indicator.", - "listbox": "The component that renders the listbox." + "listbox": "The component that renders the listbox.", + "popper": "The component that renders the popper." } } diff --git a/docs/translations/api-docs/slider/slider.json b/docs/translations/api-docs/slider/slider.json index 2d7e7ccd4844b3..3a12486a363953 100644 --- a/docs/translations/api-docs/slider/slider.json +++ b/docs/translations/api-docs/slider/slider.json @@ -2,9 +2,8 @@ "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.", - "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.", @@ -20,17 +19,13 @@ "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.", + "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.", - "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." + "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" }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, @@ -54,11 +49,6 @@ "nodeName": "the root", "conditions": "a thumb is being dragged" }, - "focusVisible": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the thumb element", - "conditions": "it has keyboard focused" - }, "rail": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the rail element" @@ -81,97 +71,33 @@ "description": "Class name applied to {{nodeName}}.", "nodeName": "the thumb element" }, - "valueLabel": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the thumb label element" + "active": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb element", + "conditions": "it's active" }, - "valueLabelOpen": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the thumb label element", - "conditions": "it's open" + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb element", + "conditions": "keyboard focused" }, "mark": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the mark element" }, "markActive": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the mark element", - "conditions": "it is active" + "conditions": "active (depending on the value)" }, "markLabel": { "description": "Class name applied to {{nodeName}}.", "nodeName": "the mark label element" }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { + "markLabelActive": { "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" + "nodeName": "the mark label element", + "conditions": "active (depending on the value)" } }, "slotDescriptions": { diff --git a/docs/translations/api-docs/svg-icon/svg-icon.json b/docs/translations/api-docs/svg-icon/svg-icon.json index 95ecb3f260c547..6a7dfb879cc722 100644 --- a/docs/translations/api-docs/svg-icon/svg-icon.json +++ b/docs/translations/api-docs/svg-icon/svg-icon.json @@ -2,110 +2,63 @@ "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.", + "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. You can use the htmlColor prop to apply a color attribute to the SVG element.", "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.", + "fontSize": "The fontSize applied to the icon. Defaults to 24px, 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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorInherit": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"inherit\"" - }, + "root": { "description": "Styles applied to the root element." }, "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "color=\"primary\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "color=\"secondary\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorAction": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "color=\"action\"" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"info\"" + "conditions": "color=\"error\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "colorDisabled": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" + "conditions": "color=\"disabled\"" }, "fontSizeInherit": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "fontSize=\"inherit\"" }, - "fontSizeXs": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"xs\"" - }, - "fontSizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"sm\"" - }, - "fontSizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"md\"" - }, - "fontSizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "fontSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "fontSize=\"lg\"" + "conditions": "fontSize=\"small\"" }, - "fontSizeXl": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "fontSizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "fontSize=\"xl\"" + "conditions": "fontSize=\"medium\"" }, - "fontSizeXl2": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "fontSizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "fontSize=\"xl2\"" - }, - "fontSizeXl3": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"xl3\"" - }, - "fontSizeXl4": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"xl4\"" - }, - "fontSizeXl5": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"xl5\"" - }, - "fontSizeXl6": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "fontSize=\"xl6\"" + "conditions": "fontSize=\"large\"" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/switch/switch.json b/docs/translations/api-docs/switch/switch.json index 96ddc47f9721cc..c51aac68be0678 100644 --- a/docs/translations/api-docs/switch/switch.json +++ b/docs/translations/api-docs/switch/switch.json @@ -1,130 +1,36 @@ { - "componentDescription": "", + "componentDescription": "The foundation for building custom-styled switches.", "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Class applied to the root element." }, + "input": { "description": "Class applied to the internal input element" }, + "track": { "description": "Class applied to the track element" }, + "thumb": { "description": "Class applied to the thumb element" }, "checked": { - "description": "State class applied to {{nodeName}}.", - "nodeName": "the root `checked` class" + "description": "State class applied to the root element if the switch is checked" }, "disabled": { - "description": "State class applied to {{nodeName}}.", - "nodeName": "the root disabled class" - }, - "action": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the action element" - }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, - "thumb": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" - }, - "track": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the track element" + "description": "State class applied to the root element if the switch is disabled" }, "focusVisible": { "description": "State class applied to the root element if the switch has visible focus" }, - "readOnly": { - "description": "Class name applied to the root element if the switch is read-only" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "startDecorator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the startDecorator element" - }, - "endDecorator": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the endDecorator element" - } + "readOnly": { "description": "Class applied to the root element if the switch is read-only" } }, "slotDescriptions": { "root": "The component that renders the root.", - "thumb": "The component that renders the thumb.", - "action": "The component that renders the action.", "input": "The component that renders the input.", - "track": "The component that renders the track.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." + "thumb": "The component that renders the thumb.", + "track": "The component that renders the track." } } diff --git a/docs/translations/api-docs/tab-list/tab-list.json b/docs/translations/api-docs/tab-list/tab-list.json index 39dfa648bfeaab..60d83960a1645c 100644 --- a/docs/translations/api-docs/tab-list/tab-list.json +++ b/docs/translations/api-docs/tab-list/tab-list.json @@ -1,53 +1,63 @@ { "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." - }, + "propDescriptions": { "children": "A list of <Tab /> elements." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "vertical": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." - }, - "sizeSm": { "description": "Classname applied to the root element if `size=\"sm\"`." }, - "sizeMd": { "description": "Classname applied to the root element if `size=\"md\"`." }, - "sizeLg": { "description": "Classname applied to the root element if `size=\"lg\"`." } - }, - "slotDescriptions": { "root": "The component that renders the root." } + "conditions": "orientation=\"vertical\"" + }, + "flexContainer": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the flex container element" + }, + "flexContainerVertical": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the flex container element", + "conditions": "orientation=\"vertical\"" + }, + "centered": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the flex container element", + "conditions": "centered={true} & !variant=\"scrollable\"" + }, + "scroller": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the tablist element" + }, + "fixed": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "!variant=\"scrollable\"\b\b\b" + }, + "scrollableX": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and orientation=\"horizontal\"" + }, + "scrollableY": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and orientation=\"vertical\"" + }, + "hideScrollbar": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and visibleScrollbar={false}" + }, + "scrollButtons": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the ScrollButtonComponent component" + }, + "scrollButtonsHideMobile": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the ScrollButtonComponent component", + "conditions": "allowScrollButtonsMobile={true}" + }, + "indicator": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the TabIndicator component" + } + } } diff --git a/docs/translations/api-docs/tab-panel/tab-panel.json b/docs/translations/api-docs/tab-panel/tab-panel.json index eb37a0a8e71422..fa22ca26bbdc73 100644 --- a/docs/translations/api-docs/tab-panel/tab-panel.json +++ b/docs/translations/api-docs/tab-panel/tab-panel.json @@ -3,27 +3,16 @@ "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." + "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." }, "classDescriptions": { - "root": { "description": "Classname applied to the root element." }, - "hidden": { "description": "Classname applied to the root element if the tab is not active." }, - "sizeSm": { "description": "Classname applied to the root element if `size=\"sm\"`." }, - "sizeMd": { "description": "Classname applied to the root element if `size=\"md\"`." }, - "sizeLg": { "description": "Classname applied to the root element if `size=\"lg\"`." }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"horizontal\"" - }, - "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation=\"vertical\"" + "root": { "description": "Class name applied to the root element." }, + "hidden": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `div` element", + "conditions": "hidden={true}" } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs/tab/tab.json b/docs/translations/api-docs/tab/tab.json index cf4c7c2d8de2cf..a022f725a44992 100644 --- a/docs/translations/api-docs/tab/tab.json +++ b/docs/translations/api-docs/tab/tab.json @@ -2,62 +2,24 @@ "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." + "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." }, "classDescriptions": { - "root": { "description": "Classname applied to the root element." }, - "disabled": { "description": "Classname applied to the root element if `disabled={true}`." }, - "focusVisible": { - "description": "Classname applied to the root element when its focus is visible." - }, - "selected": { "description": "Classname applied to the root element when it is selected." }, - "horizontal": { - "description": "Classname applied to the root element if `orientation=\"horizontal\"`." - }, - "vertical": { - "description": "Classname applied to the root element if `orientation=\"vertical\"`." - }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." + "root": { "description": "Class name applied to the root element." }, + "selected": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `button` element", + "conditions": "selected={true}" + }, + "disabled": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root `button` element", + "conditions": "disabled={true}" } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs/table/table.json b/docs/translations/api-docs/table/table.json index 46bc9be0b4865f..0db74bcc4a1f4f 100644 --- a/docs/translations/api-docs/table/table.json +++ b/docs/translations/api-docs/table/table.json @@ -1,142 +1,20 @@ { "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.", + "children": "The content of the table, normally TableHead and TableBody.", + "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.", - "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.", + "padding": "Allows TableCells to inherit padding of the Table.", + "size": "Allows TableCells to inherit size of the Table.", "stickyHeader": "Set the header sticky.
⚠️ 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." + "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, + "root": { "description": "Styles applied to the root element." }, "stickyHeader": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "stickyHeader is true" - }, - "noWrap": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "noWrap is true" - }, - "hoverRow": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "hoverRow is true" - }, - "borderAxisNone": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"none\"" - }, - "borderAxisX": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "borderAxis=\"x\"" - }, - "borderAxisXBetween": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"xBetween\"" - }, - "borderAxisY": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"y\"" - }, - "borderAxisYBetween": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"yBetween\"" - }, - "borderAxisBoth": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"both\"" - }, - "borderAxisBothBetween": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "borderAxis=\"bothBetween\"" + "conditions": "stickyHeader={true}" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/tabs/tabs.json b/docs/translations/api-docs/tabs/tabs.json index 321ce823397512..fe065328796929 100644 --- a/docs/translations/api-docs/tabs/tabs.json +++ b/docs/translations/api-docs/tabs/tabs.json @@ -2,64 +2,28 @@ "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." + "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." }, "classDescriptions": { - "root": { "description": "Classname applied to the root element." }, + "root": { "description": "Class name applied to the root element." }, "horizontal": { - "description": "Classname applied to the root element if `orientation=\"horizontal\"`." + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "orientation='horizontal'" }, "vertical": { - "description": "Classname applied to the root element if `orientation=\"vertical\"`." - }, - "colorPrimary": { - "description": "Classname applied to the root element if `color=\"primary\"`." - }, - "colorNeutral": { - "description": "Classname applied to the root element if `color=\"neutral\"`." - }, - "colorDanger": { - "description": "Classname applied to the root element if `color=\"danger\"`." - }, - "colorInfo": { "description": "Classname applied to the root element if `color=\"info\"`." }, - "colorSuccess": { - "description": "Classname applied to the root element if `color=\"success\"`." - }, - "colorWarning": { - "description": "Classname applied to the root element if `color=\"warning\"`." - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "description": "Class name applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "variantPlain": { - "description": "Classname applied to the root element if `variant=\"plain\"`." - }, - "variantOutlined": { - "description": "Classname applied to the root element if `variant=\"outlined\"`." - }, - "variantSoft": { - "description": "Classname applied to the root element if `variant=\"soft\"`." - }, - "variantSolid": { - "description": "Classname applied to the root element if `variant=\"solid\"`." - }, - "sizeSm": { "description": "Classname applied to the root element if `size=\"sm\"`." }, - "sizeMd": { "description": "Classname applied to the root element if `size=\"md\"`." }, - "sizeLg": { "description": "Classname applied to the root element if `size=\"lg\"`." } + "conditions": "orientation='vertical'" + } }, "slotDescriptions": { "root": "The component that renders the root." } } diff --git a/docs/translations/api-docs/tooltip/tooltip.json b/docs/translations/api-docs/tooltip/tooltip.json index 1052515510406b..410fdec86caacf 100644 --- a/docs/translations/api-docs/tooltip/tooltip.json +++ b/docs/translations/api-docs/tooltip/tooltip.json @@ -2,145 +2,89 @@ "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.", + "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.
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.", "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.", + "PopperComponent": "The component used for the popper.", + "PopperProps": "Props applied to the Popper element.", + "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.", "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "tooltipArrow": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "popper": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the Popper component" + }, + "popperInteractive": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the Popper component", + "conditions": "disableInteractive={true}" + }, + "popperArrow": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the Popper component", "conditions": "arrow={true}" }, - "arrow": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the arrow element" + "popperClose": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the Popper component", + "conditions": "the tooltip is open" + }, + "tooltip": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the tooltip (label wrapper) element" + }, + "tooltipArrow": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", + "conditions": "arrow={true}" }, + "arrow": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the arrow element" }, "touch": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", "conditions": "the tooltip is opened by touch" }, - "placementLeft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "tooltipPlacementLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", "conditions": "placement contains \"left\"" }, - "placementRight": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "tooltipPlacementRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", "conditions": "placement contains \"right\"" }, - "placementTop": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "tooltipPlacementTop": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", "conditions": "placement contains \"top\"" }, - "placementBottom": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", + "tooltipPlacementBottom": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tooltip (label wrapper) element", "conditions": "placement contains \"bottom\"" - }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"primary\"" - }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"danger\"" - }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"info\"" - }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"neutral\"" - }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"success\"" - }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "color=\"warning\"" - }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", - "nodeName": "the root element", - "conditions": "color inversion is triggered" - }, - "sizeSm": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"sm\"" - }, - "sizeMd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"md\"" - }, - "sizeLg": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "size=\"lg\"" - }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"plain\"" - }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"outlined\"" - }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"soft\"" - }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "variant=\"solid\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "arrow": "The component that renders the arrow." } } diff --git a/docs/translations/api-docs/typography/typography.json b/docs/translations/api-docs/typography/typography.json index fc995f10b485ef..8438692a0a0bea 100644 --- a/docs/translations/api-docs/typography/typography.json +++ b/docs/translations/api-docs/typography/typography.json @@ -1,139 +1,123 @@ { "componentDescription": "", "propDescriptions": { + "align": "Set the text-align on the component.", "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.", + "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.", - "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.", + "paragraph": "If true, the element will be a paragraph element.", "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." + "variant": "Applies the theme typography styles.", + "variantMapping": "The component maps the variant prop to a range of different HTML element types. For instance, subtitle1 to <h6>. If you wish to change that mapping, you can provide your own. Alternatively, you can use the component prop." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "h1": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "level=\"h1\"" - }, - "h2": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "root": { "description": "Styles applied to the root element." }, + "body2": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"h2\"" + "conditions": "variant=\"body2\"" }, - "h3": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "body1": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"h3\"" + "conditions": "variant=\"body1\"" }, - "h4": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "caption": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"h4\"" + "conditions": "variant=\"caption\"" }, - "h5": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "button": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"h5\"" + "conditions": "variant=\"button\"" }, - "h6": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h1": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"h6\"" + "conditions": "variant=\"h1\"" }, - "body1": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h2": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"body1\"" + "conditions": "variant=\"h2\"" }, - "body2": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h3": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"body2\"" + "conditions": "variant=\"h3\"" }, - "body3": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h4": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "level=\"body3\"" + "conditions": "variant=\"h4\"" }, - "noWrap": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h5": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "nowrap={true}" + "conditions": "variant=\"h5\"" }, - "gutterBottom": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "h6": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "gutterBottom={true}" + "conditions": "variant=\"h6\"" }, - "startDecorator": { "description": "Class name applied to the startDecorator element" }, - "endDecorator": { "description": "Class name applied to the endDecorator element" }, - "colorPrimary": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "subtitle1": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"primary\"" + "conditions": "variant=\"subtitle1\"" }, - "colorNeutral": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "subtitle2": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"neutral\"" + "conditions": "variant=\"subtitle2\"" }, - "colorDanger": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "overline": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"danger\"" + "conditions": "variant=\"overline\"" }, - "colorInfo": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "inherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"info\"" + "conditions": "variant=\"inherit\"" }, - "colorSuccess": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "alignLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"success\"" + "conditions": "align=\"left\"" }, - "colorWarning": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "alignCenter": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color=\"warning\"" + "conditions": "align=\"center\"" }, - "colorContext": { - "description": "Class name applied to {{nodeName}} when {{conditions}}.", + "alignRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "color inversion is triggered" + "conditions": "align=\"right\"" }, - "variantPlain": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "alignJustify": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"plain\"" + "conditions": "align=\"justify\"" }, - "variantOutlined": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "noWrap": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"outlined\"" + "conditions": "nowrap={true}" }, - "variantSoft": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "gutterBottom": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"soft\"" + "conditions": "gutterBottom={true}" }, - "variantSolid": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "paragraph": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "variant=\"solid\"" + "conditions": "paragraph={true}" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "startDecorator": "The component that renders the start decorator.", - "endDecorator": "The component that renders the end decorator." } } diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts index f1f6d8934b85fe..bf1a34a12ba14d 100644 --- a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts +++ b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts @@ -685,10 +685,10 @@ export default async function generateComponentApi( if (!skipApiGeneration) { // Generate pages, json and translations let translationPagesDirectory = 'docs/translations/api-docs'; - if (reactApi.apiPathname.startsWith('/joy-ui') && reactApi.filename.includes('mui-joy/src')) { + if (reactApi.apiPathname.match(/[\\/]joy-ui/) && reactApi.filename.match(/[\\/]mui-joy[\\/]src/)) { translationPagesDirectory = 'docs/translations/api-docs-joy'; } else if ( - reactApi.apiPathname.startsWith('/base') && + reactApi.apiPathname.match(/[\\/]base/) && reactApi.filename.includes('mui-base/src') ) { translationPagesDirectory = 'docs/translations/api-docs-base'; From cb6229174abf5cba08f1421d909144deb855c926 Mon Sep 17 00:00:00 2001 From: Marija Najdova Date: Tue, 25 Apr 2023 10:02:26 +0200 Subject: [PATCH 20/30] One more fix --- packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts index bf1a34a12ba14d..821e75089c93b3 100644 --- a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts +++ b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts @@ -689,7 +689,7 @@ export default async function generateComponentApi( translationPagesDirectory = 'docs/translations/api-docs-joy'; } else if ( reactApi.apiPathname.match(/[\\/]base/) && - reactApi.filename.includes('mui-base/src') + reactApi.filename.match(/[\\/]mui-base[\\/]src/) ) { translationPagesDirectory = 'docs/translations/api-docs-base'; } From 4ebe89fc959a881215f36ccb56dd1b99b9729690 Mon Sep 17 00:00:00 2001 From: Marija Najdova Date: Tue, 25 Apr 2023 10:24:27 +0200 Subject: [PATCH 21/30] more changes --- docs/translations/api-docs/badge/badge.json | 128 ++++++++- docs/translations/api-docs/button/button.json | 256 ++++++++++++++++-- .../api-docs/form-control/form-control.json | 34 ++- docs/translations/api-docs/input/input.json | 83 +++--- .../api-docs/menu-item/menu-item.json | 45 ++- docs/translations/api-docs/menu/menu.json | 39 +-- docs/translations/api-docs/modal/modal.json | 14 +- docs/translations/api-docs/option/option.json | 79 +++++- docs/translations/api-docs/popper/popper.json | 8 +- docs/translations/api-docs/select/select.json | 119 +++++--- docs/translations/api-docs/slider/slider.json | 104 ++++--- .../api-docs/snackbar/snackbar.json | 51 +++- docs/translations/api-docs/switch/switch.json | 79 ++++-- .../api-docs/tab-panel/tab-panel.json | 17 +- docs/translations/api-docs/tab/tab.json | 64 ++++- .../table-pagination/table-pagination.json | 46 ++-- docs/translations/api-docs/tabs/tabs.json | 90 ++++-- .../ApiBuilders/ComponentApiBuilder.ts | 23 +- 18 files changed, 987 insertions(+), 292 deletions(-) diff --git a/docs/translations/api-docs/badge/badge.json b/docs/translations/api-docs/badge/badge.json index 677e829f386373..d4581d9dd4ae06 100644 --- a/docs/translations/api-docs/badge/badge.json +++ b/docs/translations/api-docs/badge/badge.json @@ -1,29 +1,143 @@ { "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. See Slots API below for more details." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, "badge": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the badge `span` element" }, + "dot": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "variant=\"dot\"" + }, + "standard": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "variant=\"standard\"" + }, + "anchorOriginTopRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'right' }}" + }, + "anchorOriginBottomRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'right' }}" + }, + "anchorOriginTopLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'left' }}" + }, + "anchorOriginBottomLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'left' }}" + }, "invisible": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the badge `span` element", "conditions": "invisible={true}" + }, + "colorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"primary\"" + }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"secondary\"" + }, + "colorError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"error\"" + }, + "colorInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"info\"" + }, + "colorSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"success\"" + }, + "colorWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "color=\"warning\"" + }, + "anchorOriginTopRightRectangular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'right' }} overlap=\"rectangular\"" + }, + "anchorOriginBottomRightRectangular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'right' }} overlap=\"rectangular\"" + }, + "anchorOriginTopLeftRectangular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'left' }} overlap=\"rectangular\"" + }, + "anchorOriginBottomLeftRectangular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'left' }} overlap=\"rectangular\"" + }, + "anchorOriginTopRightCircular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'right' }} overlap=\"circular\"" + }, + "anchorOriginBottomRightCircular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'right' }} overlap=\"circular\"" + }, + "anchorOriginTopLeftCircular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'top', 'left' }} overlap=\"circular\"" + }, + "anchorOriginBottomLeftCircular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "anchorOrigin={{ 'bottom', 'left' }} overlap=\"circular\"" + }, + "overlapRectangular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "overlap=\"rectangular\"" + }, + "overlapCircular": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the badge `span` element", + "conditions": "overlap=\"circular\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "badge": "The component that renders the badge." } } diff --git a/docs/translations/api-docs/button/button.json b/docs/translations/api-docs/button/button.json index e880be5b3dbae4..da71ba84da8ec4 100644 --- a/docs/translations/api-docs/button/button.json +++ b/docs/translations/api-docs/button/button.json @@ -1,29 +1,253 @@ { - "componentDescription": "The foundation for building custom-styled buttons.", + "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", + "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "active": { + "root": { "description": "Styles applied to the root element." }, + "text": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\"" + }, + "textInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"inherit\"" + }, + "textPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"primary\"" + }, + "textSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"secondary\"" + }, + "textSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"success\"" + }, + "textError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"error\"" + }, + "textInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"info\"" + }, + "textWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"text\" and color=\"warning\"" + }, + "outlined": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\"" + }, + "outlinedInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"inherit\"" + }, + "outlinedPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"primary\"" + }, + "outlinedSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"secondary\"" + }, + "outlinedSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"success\"" + }, + "outlinedError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"error\"" + }, + "outlinedInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"info\"" + }, + "outlinedWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\" and color=\"warning\"" + }, + "contained": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\"" + }, + "containedInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"inherit\"" + }, + "containedPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"primary\"" + }, + "containedSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"secondary\"" + }, + "containedSuccess": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"success\"" + }, + "containedInfo": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"info\"" + }, + "containedError": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"error\"" + }, + "containedWarning": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"contained\" and color=\"warning\"" + }, + "disableElevation": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "disableElevation={true}" + }, + "focusVisible": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "active={true}" + "nodeName": "the ButtonBase root element", + "conditions": "the button is keyboard focused" }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", + "nodeName": "the root element", "conditions": "disabled={true}" }, - "focusVisible": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "focusVisible={true}" + "colorInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"inherit\"" + }, + "textSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\" and variant=\"text\"" + }, + "textSizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"medium\" and variant=\"text\"" + }, + "textSizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"large\" and variant=\"text\"" + }, + "outlinedSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\" and variant=\"outlined\"" + }, + "outlinedSizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"medium\" and variant=\"outlined\"" + }, + "outlinedSizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"large\" and variant=\"outlined\"" + }, + "containedSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\" and variant=\"contained\"" + }, + "containedSizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"medium\" and variant=\"contained\"" + }, + "containedSizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"large\" and variant=\"contained\"" + }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\"" + }, + "sizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"medium\"" + }, + "sizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"large\"" + }, + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "fullWidth={true}" + }, + "startIcon": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the startIcon element", + "conditions": "supplied" + }, + "endIcon": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the endIcon element", + "conditions": "supplied" + }, + "iconSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "supplied and size=\"small\"" + }, + "iconSizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "supplied and size=\"medium\"" + }, + "iconSizeLarge": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon element", + "conditions": "supplied and size=\"large\"" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/form-control/form-control.json b/docs/translations/api-docs/form-control/form-control.json index 1af947ce5c1f86..31c98e255dbb53 100644 --- a/docs/translations/api-docs/form-control/form-control.json +++ b/docs/translations/api-docs/form-control/form-control.json @@ -1,15 +1,37 @@ { - "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.", + "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.", - "onChange": "Callback fired when the form element's value is modified.", + "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.", - "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." + "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." }, - "classDescriptions": {} + "classDescriptions": { + "root": { "description": "Styles applied to the root element." }, + "marginNormal": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "margin=\"normal\"" + }, + "marginDense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "margin=\"dense\"" + }, + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "fullWidth={true}" + } + } } diff --git a/docs/translations/api-docs/input/input.json b/docs/translations/api-docs/input/input.json index 2853be93336b60..7b9e265eeed5c1 100644 --- a/docs/translations/api-docs/input/input.json +++ b/docs/translations/api-docs/input/input.json @@ -3,82 +3,99 @@ "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.", - "component": "The component used for the root node. Either a string to use a HTML element or a 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. 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.", - "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.", + "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 textarea element is rendered.", + "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 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.", + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, "formControl": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "the component is a descendant of FormControl" }, - "adornedStart": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "startAdornment is provided" - }, - "adornedEnd": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "endAdornment is provided" - }, "focused": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "the component is focused" }, "disabled": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "disabled={true}" }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color secondary" + }, + "underline": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the root element", + "conditions": "disableUnderline={true}" + }, "error": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "error={true}" }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the input element", + "conditions": "size=\"small\"" + }, "multiline": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "multiline={true}" }, - "input": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the input element" + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "fullWidth={true}" + }, + "input": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the input element" }, + "inputSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the input element", + "conditions": "size=\"small\"" }, "inputMultiline": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the input element", "conditions": "multiline={true}" }, "inputTypeSearch": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the input element", "conditions": "type=\"search\"" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "input": "The component that renders the input.", - "textarea": "The component that renders the textarea." } } diff --git a/docs/translations/api-docs/menu-item/menu-item.json b/docs/translations/api-docs/menu-item/menu-item.json index 1d5601b2a7adfa..007092738de45b 100644 --- a/docs/translations/api-docs/menu-item/menu-item.json +++ b/docs/translations/api-docs/menu-item/menu-item.json @@ -1,23 +1,48 @@ { "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.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "focusVisible": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "keyboard focused" + }, + "dense": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "dense" + }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", + "nodeName": "the root element", "conditions": "disabled={true}" }, - "focusVisible": { + "divider": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "divider={true}" + }, + "gutters": { + "description": "Styles applied to {{nodeName}} unless {{conditions}}.", + "nodeName": "the inner `component` element", + "conditions": "disableGutters={true}" + }, + "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "focusVisible={true}" + "nodeName": "the root element", + "conditions": "selected={true}" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/menu/menu.json b/docs/translations/api-docs/menu/menu.json index da3220db4b7701..6880082fd0f57a 100644 --- a/docs/translations/api-docs/menu/menu.json +++ b/docs/translations/api-docs/menu/menu.json @@ -1,28 +1,29 @@ { "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.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", - "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." + "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." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "listbox": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the listbox element" + "root": { "description": "Styles applied to the root element." }, + "paper": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the Paper component" }, - "expanded": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `Popper` element and the listbox `ul` element", - "conditions": "open={true}" + "list": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the List component via `MenuList`" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "listbox": "The component that renders the listbox." } } diff --git a/docs/translations/api-docs/modal/modal.json b/docs/translations/api-docs/modal/modal.json index 83c5cf84ab30ec..97b62347bb30e4 100644 --- a/docs/translations/api-docs/modal/modal.json +++ b/docs/translations/api-docs/modal/modal.json @@ -1,9 +1,14 @@ { - "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).", + "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.", @@ -17,7 +22,8 @@ "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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, @@ -30,9 +36,5 @@ "description": "Class name applied to {{nodeName}}.", "nodeName": "the backdrop element" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "backdrop": "The component that renders the backdrop." } } diff --git a/docs/translations/api-docs/option/option.json b/docs/translations/api-docs/option/option.json index 9242960c42375e..a38126f4d6801c 100644 --- a/docs/translations/api-docs/option/option.json +++ b/docs/translations/api-docs/option/option.json @@ -1,29 +1,88 @@ { - "componentDescription": "An unstyled option to be used within a Select.", + "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 option will be disabled.", + "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 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." + "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." }, "classDescriptions": { "root": { "description": "Class name applied to the root element." }, + "colorPrimary": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"primary\"" + }, + "colorNeutral": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"neutral\"" + }, + "colorDanger": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"danger\"" + }, + "colorInfo": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"info\"" + }, + "colorSuccess": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"success\"" + }, + "colorWarning": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"warning\"" + }, + "colorContext": { + "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"context\"" + }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `li` element", + "nodeName": "the root element", "conditions": "disabled={true}" }, "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `li` element", - "conditions": "selected={true}" + "nodeName": "the root element", + "conditions": "the option is selected" }, "highlighted": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `li` element", - "conditions": "highlighted={true}" + "nodeName": "the root element", + "conditions": "the option is highlighted" + }, + "variantPlain": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"plain\"" + }, + "variantSoft": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"soft\"" + }, + "variantOutlined": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"outlined\"" + }, + "variantSolid": { + "description": "State class applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "variant=\"solid\"" } }, "slotDescriptions": { "root": "The component that renders the root." } diff --git a/docs/translations/api-docs/popper/popper.json b/docs/translations/api-docs/popper/popper.json index 2fee1eb3dd079f..b6533b390e8cf1 100644 --- a/docs/translations/api-docs/popper/popper.json +++ b/docs/translations/api-docs/popper/popper.json @@ -1,10 +1,11 @@ { - "componentDescription": "Poppers rely on the 3rd party library [Popper.js](https://popper.js.org/docs/v2/) for positioning.", + "componentDescription": "", "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.", + "components": "The components used for each slot inside the Popper. Either a string to use a HTML element or a component.", + "componentsProps": "The props used for each slot inside the Popper.", "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.", @@ -13,7 +14,8 @@ "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.", + "slots": "The components used for each slot inside the Popper. 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.", "transition": "Help supporting a react-transition-group/Transition component." }, "classDescriptions": {} diff --git a/docs/translations/api-docs/select/select.json b/docs/translations/api-docs/select/select.json index 590bbb9533d5fc..0e09fe6d4805dd 100644 --- a/docs/translations/api-docs/select/select.json +++ b/docs/translations/api-docs/select/select.json @@ -1,58 +1,89 @@ { - "componentDescription": "The foundation for building custom-styled select components.", + "componentDescription": "", "propDescriptions": { - "autoFocus": "If true, the select element is focused during the first mount", - "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 select is disabled.", - "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).", - "optionStringifier": "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.", - "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." + "autoWidth": "If true, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.", + "children": "The option elements to populate the select with. Can be some MenuItem when native is false and option when native is true.
⚠️The MenuItem elements must be direct descendants when native is false.", + "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", + "defaultOpen": "If true, the component is initially open. Use when the component open state is not controlled (i.e. the open prop is not defined). You can only use it when the native prop is false (default).", + "defaultValue": "The default value. Use when the component is not controlled.", + "displayEmpty": "If true, a value is displayed even if no items are selected.
In order to display a meaningful value, a function can be passed to the renderValue prop which returns the value to be displayed when no items are selected.
⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state.", + "IconComponent": "The icon that displays the arrow.", + "id": "The id of the wrapper element or the select element when native.", + "input": "An Input element; does not have to be a material-ui specific Input.", + "inputProps": "Attributes applied to the input element. When native is true, the attributes are applied on the select element.", + "label": "See OutlinedInput#label", + "labelId": "The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.", + "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.", + "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.", + "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.", + "variant": "The variant to use." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "listbox": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the listbox element" + "select": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the select component `select` class" }, - "popper": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the popper element" + "multiple": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the select component", + "conditions": "multiple={true}" }, - "active": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "active={true}" + "filled": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the select component", + "conditions": "variant=\"filled\"" }, - "expanded": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "expanded={true}" + "outlined": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the select component", + "conditions": "variant=\"outlined\"" + }, + "standard": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the select component", + "conditions": "variant=\"standard\"" }, "disabled": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element and the listbox 'ul' element", - "conditions": "disabled={true}" + "description": "State class applied to {{nodeName}}.", + "nodeName": "the select component `disabled` class" + }, + "icon": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the icon component" }, + "iconOpen": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon component", + "conditions": "the popup is open" }, - "focusVisible": { + "iconFilled": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon component", + "conditions": "variant=\"filled\"" + }, + "iconOutlined": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon component", + "conditions": "variant=\"outlined\"" + }, + "iconStandard": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the icon component", + "conditions": "variant=\"standard\"" + }, + "nativeInput": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the underlying native input component" + }, + "error": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "focusVisible={true}" + "nodeName": "the root element", + "conditions": "error={true}" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "listbox": "The component that renders the listbox.", - "popper": "The component that renders the popper." } } diff --git a/docs/translations/api-docs/slider/slider.json b/docs/translations/api-docs/slider/slider.json index 3a12486a363953..e7e7dce95d28cc 100644 --- a/docs/translations/api-docs/slider/slider.json +++ b/docs/translations/api-docs/slider/slider.json @@ -4,13 +4,15 @@ "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.", - "component": "The component used for the root node. Either a string to use a HTML element or a 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.", + "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.", "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.", @@ -19,23 +21,36 @@ "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.", "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.", + "slots": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component.", "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" }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "colorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"primary\"" + }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "color=\"secondary\"" + }, "marked": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "marks is provided with at least one label" }, "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "orientation=\"vertical\"" }, @@ -49,28 +64,19 @@ "nodeName": "the root", "conditions": "a thumb is being dragged" }, - "rail": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the rail element" - }, - "track": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the track element" - }, + "rail": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the rail element" }, + "track": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the track element" }, "trackFalse": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "track={false}" }, "trackInverted": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "track=\"inverted\"" }, - "thumb": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the thumb element" - }, + "thumb": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the thumb element" }, "active": { "description": "State class applied to {{nodeName}} if {{conditions}}.", "nodeName": "the thumb element", @@ -81,33 +87,57 @@ "nodeName": "the thumb element", "conditions": "keyboard focused" }, - "mark": { - "description": "Class name applied to {{nodeName}}.", - "nodeName": "the mark element" - }, + "mark": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the mark element" }, "markActive": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the mark element", "conditions": "active (depending on the value)" }, "markLabel": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the mark label element" }, "markLabelActive": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the mark label element", "conditions": "active (depending on the value)" + }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\"" + }, + "thumbColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb element", + "conditions": "color=\"primary\"" + }, + "thumbColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb element", + "conditions": "color=\"secondary\"" + }, + "thumbSizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb element", + "conditions": "size=\"small\"" + }, + "valueLabel": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the thumb label element" + }, + "valueLabelOpen": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the thumb label element", + "conditions": "it's open" + }, + "valueLabelCircle": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the thumb label's circle element" + }, + "valueLabelLabel": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the thumb label's label element" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "track": "The component that renders the track.", - "rail": "The component that renders the rail.", - "thumb": "The component that renders the thumb.", - "mark": "The component that renders the mark.", - "markLabel": "The component that renders the mark label.", - "valueLabel": "The component that renders the value label.", - "input": "The component that renders the input." } } diff --git a/docs/translations/api-docs/snackbar/snackbar.json b/docs/translations/api-docs/snackbar/snackbar.json index 6c4f7ffd1ef1fd..f711f727361f42 100644 --- a/docs/translations/api-docs/snackbar/snackbar.json +++ b/docs/translations/api-docs/snackbar/snackbar.json @@ -1,16 +1,55 @@ { "componentDescription": "", "propDescriptions": { + "action": "The action to display. It renders after the message, at the end of the snackbar.", + "anchorOrigin": "The anchor of the Snackbar. On smaller screens, the component grows to occupy all the available width, the horizontal alignment is ignored.", "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.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", + "children": "Replace the SnackbarContent component.", + "classes": "Override or extend the styles applied to the component. See CSS API below for more details.", + "ClickAwayListenerProps": "Props applied to the ClickAwayListener element.", + "ContentProps": "Props applied to the SnackbarContent element.", "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.", + "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".", "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." + "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." }, - "classDescriptions": { "root": { "description": "Class name applied to the root element." } }, - "slotDescriptions": { "root": "The component that renders the root." } + "classDescriptions": { + "root": { "description": "Styles applied to the root element." }, + "anchorOriginTopCenter": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'top', 'center' }}" + }, + "anchorOriginBottomCenter": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'bottom', 'center' }}" + }, + "anchorOriginTopRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'top', 'right' }}" + }, + "anchorOriginBottomRight": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'bottom', 'right' }}" + }, + "anchorOriginTopLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'top', 'left' }}" + }, + "anchorOriginBottomLeft": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "anchorOrigin={{ 'bottom', 'left' }}" + } + } } diff --git a/docs/translations/api-docs/switch/switch.json b/docs/translations/api-docs/switch/switch.json index c51aac68be0678..1e5c6b7daab8ad 100644 --- a/docs/translations/api-docs/switch/switch.json +++ b/docs/translations/api-docs/switch/switch.json @@ -1,36 +1,75 @@ { - "componentDescription": "The foundation for building custom-styled switches.", + "componentDescription": "", "propDescriptions": { "checked": "If true, the component is checked.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", + "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.", + "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).", + "icon": "The icon to display when the component is unchecked.", + "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).", - "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." + "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.", + "value": "The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value." }, "classDescriptions": { - "root": { "description": "Class applied to the root element." }, - "input": { "description": "Class applied to the internal input element" }, - "track": { "description": "Class applied to the track element" }, - "thumb": { "description": "Class applied to the thumb element" }, + "root": { "description": "Styles applied to the root element." }, + "edgeStart": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "edge=\"start\"" + }, + "edgeEnd": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "edge=\"end\"" + }, + "switchBase": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the internal `SwitchBase` component's `root` class" + }, + "colorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the internal SwitchBase component's root element", + "conditions": "color=\"primary\"" + }, + "colorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the internal SwitchBase component's root element", + "conditions": "color=\"secondary\"" + }, + "sizeSmall": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"small\"" + }, + "sizeMedium": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "size=\"medium\"" + }, "checked": { - "description": "State class applied to the root element if the switch is checked" + "description": "State class applied to {{nodeName}}.", + "nodeName": "the internal `SwitchBase` component's `checked` class" }, "disabled": { - "description": "State class applied to the root element if the switch is disabled" + "description": "State class applied to {{nodeName}}.", + "nodeName": "the internal SwitchBase component's disabled class" }, - "focusVisible": { - "description": "State class applied to the root element if the switch has visible focus" + "input": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the internal SwitchBase component's input element" }, - "readOnly": { "description": "Class applied to the root element if the switch is read-only" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "input": "The component that renders the input.", - "thumb": "The component that renders the thumb.", - "track": "The component that renders the track." + "thumb": { + "description": "Styles used to create the thumb passed to the internal `SwitchBase` component `icon` prop." + }, + "track": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the track element" } } } diff --git a/docs/translations/api-docs/tab-panel/tab-panel.json b/docs/translations/api-docs/tab-panel/tab-panel.json index fa22ca26bbdc73..9dddc21ca16db5 100644 --- a/docs/translations/api-docs/tab-panel/tab-panel.json +++ b/docs/translations/api-docs/tab-panel/tab-panel.json @@ -2,18 +2,9 @@ "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 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." + "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.", + "value": "The value of the corresponding Tab. Must use the index of the Tab when no value was passed to Tab." }, - "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "hidden": { - "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `div` element", - "conditions": "hidden={true}" - } - }, - "slotDescriptions": { "root": "The component that renders the root." } + "classDescriptions": { "root": { "description": "Styles applied to the root element." } } } diff --git a/docs/translations/api-docs/tab/tab.json b/docs/translations/api-docs/tab/tab.json index a022f725a44992..1326365b9a0752 100644 --- a/docs/translations/api-docs/tab/tab.json +++ b/docs/translations/api-docs/tab/tab.json @@ -1,26 +1,64 @@ { "componentDescription": "", "propDescriptions": { - "action": "A ref for imperative actions. It currently only supports focusVisible() action.", - "component": "The component used for the root node. Either a string to use a HTML element or a component.", + "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.", "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." + "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.", + "icon": "The icon to display.", + "iconPosition": "The position of the icon relative to the label.", + "label": "The label element.", + "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.", + "wrapped": "Tab labels appear in a single row. They can use a second line if needed." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, + "labelIcon": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "both icon and label are provided" + }, + "textColorInherit": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "the parent [Tabs](/material-ui/api/tabs/) has textColor=\"inherit\"" + }, + "textColorPrimary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "the parent [Tabs](/material-ui/api/tabs/) has textColor=\"primary\"" + }, + "textColorSecondary": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "the parent [Tabs](/material-ui/api/tabs/) has textColor=\"secondary\"" + }, "selected": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "selected={true}" + "nodeName": "the root element", + "conditions": "selected={true} (controlled by the Tabs component)" }, "disabled": { "description": "State class applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root `button` element", - "conditions": "disabled={true}" + "nodeName": "the root element", + "conditions": "disabled={true} (controlled by the Tabs component)" + }, + "fullWidth": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "fullWidth={true} (controlled by the Tabs component)" + }, + "wrapped": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the root element", + "conditions": "wrapped={true}" + }, + "iconWrapper": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the wrapper element of `icon`", + "conditions": "icon is provided" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/docs/translations/api-docs/table-pagination/table-pagination.json b/docs/translations/api-docs/table-pagination/table-pagination.json index 106432ab9dccd0..cff49eb2a8cacb 100644 --- a/docs/translations/api-docs/table-pagination/table-pagination.json +++ b/docs/translations/api-docs/table-pagination/table-pagination.json @@ -1,72 +1,66 @@ { - "componentDescription": "A pagination for tables.", + "componentDescription": "A `TableCell` based component for placing inside `TableFooter` for pagination.", "propDescriptions": { + "ActionsComponent": "The component used for displaying the actions. Either a string to use a HTML element or a component.", + "backIconButtonProps": "Props applied to the back arrow IconButton 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.", "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.", + "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.", "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." + "SelectProps": "Props applied to the rows per page Select element.", + "showFirstButton": "If true, show the first-page button.", + "showLastButton": "If true, show the last-page button.", + "sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, + "root": { "description": "Styles applied to the root element." }, "toolbar": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the Toolbar component" }, "spacer": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the spacer element" }, "selectLabel": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the select label Typography element" }, "selectRoot": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the Select component `root` element" }, "select": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the Select component `select` class" }, "selectIcon": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the Select component `icon` class" }, "input": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the Select component `root` element" }, "menuItem": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the MenuItem component" }, "displayedRows": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the displayed rows Typography element" }, "actions": { - "description": "Class name applied to {{nodeName}}.", + "description": "Styles applied to {{nodeName}}.", "nodeName": "the internal `TablePaginationActions` component" } - }, - "slotDescriptions": { - "root": "The component that renders the root.", - "actions": "The component that renders the actions.", - "select": "The component that renders the select.", - "selectLabel": "The component that renders the select label.", - "menuItem": "The component that renders the menu item.", - "displayedRows": "The component that renders the displayed rows.", - "toolbar": "The component that renders the toolbar.", - "spacer": "The component that renders the spacer." } } diff --git a/docs/translations/api-docs/tabs/tabs.json b/docs/translations/api-docs/tabs/tabs.json index fe065328796929..4fae2073b12685 100644 --- a/docs/translations/api-docs/tabs/tabs.json +++ b/docs/translations/api-docs/tabs/tabs.json @@ -1,29 +1,87 @@ { "componentDescription": "", "propDescriptions": { + "action": "Callback fired when the component mounts. This is useful when you want to trigger an action programmatically. It supports two actions: updateIndicator() and updateScrollButtons()", + "allowScrollButtonsMobile": "If true, the scroll buttons aren't forced hidden on mobile. By default the scroll buttons are hidden on mobile and takes precedence over scrollButtons.", + "aria-label": "The label for the Tabs as a string.", + "aria-labelledby": "An id or list of ids separated by a space that label the Tabs.", + "centered": "If true, the tabs are centered. This prop is intended for large views.", "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.", - "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.", + "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)", "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.", "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." + "slotProps": "The extra props for the slot components. You can override the existing props or add new ones.", + "slots": "The components 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.", + "TabIndicatorProps": "Props applied to the tab indicator element.", + "TabScrollButtonProps": "Props applied to the TabScrollButton element.", + "textColor": "Determines the color of the Tab.", + "value": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to false.", + "variant": "Determines additional display behavior of the tabs:
- scrollable will invoke scrolling properties and allow for horizontally scrolling (or swiping) of the tab bar. -fullWidth will make the tabs grow to use all the available space, which should be used for small views, like on mobile. - standard will render the default state.", + "visibleScrollbar": "If true, the scrollbar is visible. It can be useful when displaying a long vertical list of tabs." }, "classDescriptions": { - "root": { "description": "Class name applied to the root element." }, - "horizontal": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", - "nodeName": "the root element", - "conditions": "orientation='horizontal'" - }, + "root": { "description": "Styles applied to the root element." }, "vertical": { - "description": "Class name applied to {{nodeName}} if {{conditions}}.", + "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", - "conditions": "orientation='vertical'" + "conditions": "orientation=\"vertical\"" + }, + "flexContainer": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the flex container element" + }, + "flexContainerVertical": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the flex container element", + "conditions": "orientation=\"vertical\"" + }, + "centered": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the flex container element", + "conditions": "centered={true} & !variant=\"scrollable\"" + }, + "scroller": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the tablist element" + }, + "fixed": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "!variant=\"scrollable\"\b\b\b" + }, + "scrollableX": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and orientation=\"horizontal\"" + }, + "scrollableY": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and orientation=\"vertical\"" + }, + "hideScrollbar": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the tablist element", + "conditions": "variant=\"scrollable\" and visibleScrollbar={false}" + }, + "scrollButtons": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the ScrollButtonComponent component" + }, + "scrollButtonsHideMobile": { + "description": "Styles applied to {{nodeName}} if {{conditions}}.", + "nodeName": "the ScrollButtonComponent component", + "conditions": "allowScrollButtonsMobile={true}" + }, + "indicator": { + "description": "Styles applied to {{nodeName}}.", + "nodeName": "the TabIndicator component" } - }, - "slotDescriptions": { "root": "The component that renders the root." } + } } diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts index 821e75089c93b3..0e15ffa00d0ca5 100644 --- a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts +++ b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts @@ -313,6 +313,7 @@ const generateApiPage = ( reactApi: ReactApi, onlyJsonFile: boolean = false, ) => { + const normalizedApiPathname = reactApi.apiPathname.replace(/\\/g, '/'); /** * Gather the metadata needed for the component's API page. */ @@ -351,7 +352,7 @@ const generateApiPage = ( }), spread: reactApi.spread, themeDefaultProps: reactApi.themeDefaultProps, - muiName: reactApi.apiPathname.startsWith('/joy-ui') + muiName: normalizedApiPathname.startsWith('/joy-ui') ? reactApi.muiName.replace('Mui', 'Joy') : reactApi.muiName, forwardsRefTo: reactApi.forwardsRefTo, @@ -421,14 +422,16 @@ const attachTranslations = (reactApi: ReactApi) => { let description = generatePropDescription(prop, propName); description = renderMarkdownInline(description); + const normalizedApiPathname = reactApi.apiPathname.replace(/\\/g, '/'); + 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' && !reactApi.apiPathname.startsWith('/material-ui')) { + } else if (propName === 'slots' && !normalizedApiPathname.startsWith('/material-ui')) { description += ' See Slots API below for more details.'; - } else if (reactApi.apiPathname.startsWith('/joy-ui')) { + } else if (normalizedApiPathname.startsWith('/joy-ui')) { switch (propName) { case 'size': description += @@ -682,14 +685,20 @@ export default async function generateComponentApi( // eslint-disable-next-line no-console console.log('Built API docs for', reactApi.name); + const normalizedApiPathname = reactApi.apiPathname.replace(/\\/g, '/'); + const noramlizedFilename = reactApi.filename.replace(/\\/g, '/'); + if (!skipApiGeneration) { // Generate pages, json and translations let translationPagesDirectory = 'docs/translations/api-docs'; - if (reactApi.apiPathname.match(/[\\/]joy-ui/) && reactApi.filename.match(/[\\/]mui-joy[\\/]src/)) { + if ( + normalizedApiPathname.startsWith('/joy-ui') && + noramlizedFilename.includes('/mui-joy/src') + ) { translationPagesDirectory = 'docs/translations/api-docs-joy'; } else if ( - reactApi.apiPathname.match(/[\\/]base/) && - reactApi.filename.match(/[\\/]mui-base[\\/]src/) + normalizedApiPathname.startsWith('/base') && + noramlizedFilename.includes('/mui-base/src') ) { translationPagesDirectory = 'docs/translations/api-docs-base'; } @@ -697,7 +706,7 @@ export default async function generateComponentApi( generateApiTranslations(path.join(process.cwd(), translationPagesDirectory), reactApi); // Once we have the tabs API in all projects, we can make this default - const generateOnlyJsonFile = reactApi.apiPathname.startsWith('/base'); + const generateOnlyJsonFile = normalizedApiPathname.startsWith('/base'); generateApiPage(apiPagesDirectory, translationPagesDirectory, reactApi, generateOnlyJsonFile); // Add comment about demo & api links (including inherited component) to the component file From 41845e681ffbb5754a1f348ab97fe34b15b59661 Mon Sep 17 00:00:00 2001 From: Benny Joo Date: Tue, 25 Apr 2023 10:01:05 +0100 Subject: [PATCH 22/30] Remove occurrences of unstyled from button doc --- docs/data/base/components/button/button.md | 20 +++++++++---------- .../api-docs-builder/buildApiUtils.test.ts | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/data/base/components/button/button.md b/docs/data/base/components/button/button.md index 5dad2afbcbb2da..dc5ab6660147c5 100644 --- a/docs/data/base/components/button/button.md +++ b/docs/data/base/components/button/button.md @@ -1,13 +1,13 @@ --- product: base -title: Unstyled React Button component and hook +title: React Button component and hook components: Button hooks: useButton githubLabel: 'component: button' waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/ --- -# Unstyled Button +# Button

Buttons let users take actions and make choices with a single tap.

@@ -17,7 +17,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/ ## Introduction -The Unstyled Button component replaces the native HTML `