diff --git a/docs/data/base/pages.ts b/docs/data/base/pages.ts index cc77564f51..741451b887 100644 --- a/docs/data/base/pages.ts +++ b/docs/data/base/pages.ts @@ -1,5 +1,4 @@ import type { MuiPage } from 'docs/src/MuiPage'; -import pagesApi from 'docs/data/base/pagesApi'; const pages: readonly MuiPage[] = [ { @@ -23,86 +22,75 @@ const pages: readonly MuiPage[] = [ pathname: '/base-ui/components/inputs', subheader: 'inputs', children: [ - { pathname: '/base-ui/react-autocomplete', title: 'Autocomplete' }, - { pathname: '/base-ui/react-button', title: 'Button' }, + // { pathname: '/base-ui/react-autocomplete', title: 'Autocomplete' }, + // { pathname: '/base-ui/react-button', title: 'Button' }, { pathname: '/base-ui/react-checkbox', title: 'Checkbox' }, - { pathname: '/base-ui/react-input', title: 'Input' }, + // { pathname: '/base-ui/react-input', title: 'Input' }, { pathname: '/base-ui/react-number-field', title: 'Number Field' }, - { pathname: '/base-ui/react-radio-group', title: 'Radio Group', planned: true }, - { pathname: '/base-ui/react-rating', title: 'Rating', planned: true }, - { pathname: '/base-ui/react-select', title: 'Select' }, - { pathname: '/base-ui/react-slider', title: 'Slider' }, + // { pathname: '/base-ui/react-radio-group', title: 'Radio Group', planned: true }, + // { pathname: '/base-ui/react-rating', title: 'Rating', planned: true }, + // { pathname: '/base-ui/react-select', title: 'Select' }, + // { pathname: '/base-ui/react-slider', title: 'Slider' }, { pathname: '/base-ui/react-switch', title: 'Switch' }, - { - pathname: '/base-ui/react-toggle-button-group', - title: 'Toggle Button Group', - planned: true, - }, - ], - }, - { - pathname: '/base-ui/components/data-display', - subheader: 'data-display', - children: [ - { pathname: '/base-ui/react-badge', title: 'Badge' }, - { pathname: '/base-ui/react-tooltip', title: 'Tooltip', planned: true }, - ], - }, - { - pathname: '/base-ui/components/feedback', - subheader: 'feedback', - children: [ - { - pathname: '/base-ui/react-snackbar', - title: 'Snackbar', - }, - ], - }, - { - pathname: '/base-ui/components/surfaces', - subheader: 'surfaces', - children: [ - { - pathname: '/base-ui/react-accordion', - title: 'Accordion', - planned: true, - }, - ], - }, - { - pathname: '/base-ui/components/navigation', - subheader: 'navigation', - children: [ - { pathname: '/base-ui/react-drawer', title: 'Drawer', planned: true }, - { pathname: '/base-ui/react-menu', title: 'Menu' }, - { pathname: '/base-ui/react-pagination', title: 'Pagination', planned: true }, - { pathname: '/base-ui/react-table-pagination', title: 'Table Pagination' }, - { pathname: '/base-ui/react-tabs', title: 'Tabs' }, - ], - }, - { - pathname: '/base-ui/components/utils', - subheader: 'utils', - children: [ - { pathname: '/base-ui/react-click-away-listener', title: 'Click-Away Listener' }, - { pathname: '/base-ui/react-focus-trap', title: 'Focus Trap' }, - { pathname: '/base-ui/react-form-control', title: 'Form Control' }, - { pathname: '/base-ui/react-modal', title: 'Modal' }, - { pathname: '/base-ui/react-no-ssr', title: 'No-SSR' }, - { pathname: '/base-ui/react-popper', title: 'Popper' }, - { pathname: '/base-ui/react-popup', title: 'Popup', unstable: true }, - { pathname: '/base-ui/react-portal', title: 'Portal' }, - { pathname: '/base-ui/react-textarea-autosize', title: 'Textarea Autosize' }, - { pathname: '/base-ui/react-transitions', title: 'Transitions' }, + // { pathname: '/base-ui/react-toggle-button-group', title: 'Toggle Button Group', planned: true }, ], }, + // { + // pathname: '/base-ui/components/data-display', + // subheader: 'data-display', + // children: [ + // { pathname: '/base-ui/react-badge', title: 'Badge' }, + // { pathname: '/base-ui/react-tooltip', title: 'Tooltip', planned: true }, + // ], + // }, + // { + // pathname: '/base-ui/components/feedback', + // subheader: 'feedback', + // children: [ + // { pathname: '/base-ui/react-snackbar', title: 'Snackbar' }, + // ], + // }, + // { + // pathname: '/base-ui/components/surfaces', + // subheader: 'surfaces', + // children: [ + // { pathname: '/base-ui/react-accordion', title: 'Accordion', planned: true }, + // ], + // }, + // { + // pathname: '/base-ui/components/navigation', + // subheader: 'navigation', + // children: [ + // { pathname: '/base-ui/react-drawer', title: 'Drawer', planned: true }, + // { pathname: '/base-ui/react-menu', title: 'Menu' }, + // { pathname: '/base-ui/react-pagination', title: 'Pagination', planned: true }, + // { pathname: '/base-ui/react-table-pagination', title: 'Table Pagination' }, + // { pathname: '/base-ui/react-tabs', title: 'Tabs' }, + // ], + // }, + // { + // pathname: '/base-ui/components/utils', + // subheader: 'utils', + // children: [ + // { pathname: '/base-ui/react-click-away-listener', title: 'Click-Away Listener' }, + // { pathname: '/base-ui/react-focus-trap', title: 'Focus Trap' }, + // { pathname: '/base-ui/react-form-control', title: 'Form Control' }, + // { pathname: '/base-ui/react-modal', title: 'Modal' }, + // { pathname: '/base-ui/react-no-ssr', title: 'No-SSR' }, + // { pathname: '/base-ui/react-popper', title: 'Popper' }, + // { pathname: '/base-ui/react-popup', title: 'Popup', unstable: true }, + // { pathname: '/base-ui/react-portal', title: 'Portal' }, + // { pathname: '/base-ui/react-textarea-autosize', title: 'Textarea Autosize' }, + // { pathname: '/base-ui/react-transitions', title: 'Transitions' }, + // ], + // }, ], }, - { + /* { title: 'APIs', pathname: '/base-ui/api', children: pagesApi, - }, + }, */ { pathname: '/base-ui/guides', title: 'How-to guides', diff --git a/docs/pages/base-ui/api/use-autocomplete.json b/docs/pages/base-ui/api/use-autocomplete.json index a8e531b205..fcbd916253 100644 --- a/docs/pages/base-ui/api/use-autocomplete.json +++ b/docs/pages/base-ui/api/use-autocomplete.json @@ -1,247 +1,6 @@ { - "parameters": { - "options": { - "type": { "name": "ReadonlyArray<Value>", "description": "ReadonlyArray<Value>" }, - "required": true - }, - "autoComplete": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "autoHighlight": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "autoSelect": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "blurOnSelect": { - "type": { - "name": "'touch' | 'mouse' | true | false", - "description": "'touch' | 'mouse' | true | false" - }, - "default": "false" - }, - "clearOnBlur": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "!props.freeSolo" - }, - "clearOnEscape": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "componentName": { "type": { "name": "string", "description": "string" } }, - "defaultValue": { - "type": { - "name": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>", - "description": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>" - }, - "default": "props.multiple ? [] : null" - }, - "disableClearable": { - "type": { "name": "DisableClearable", "description": "DisableClearable" }, - "default": "false" - }, - "disableCloseOnSelect": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "disabledItemsFocusable": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "disableListWrap": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "filterOptions": { - "type": { - "name": "(options: Value[], state: FilterOptionsState<Value>) => Value[]", - "description": "(options: Value[], state: FilterOptionsState<Value>) => Value[]" - }, - "default": "createFilterOptions()" - }, - "filterSelectedOptions": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "freeSolo": { "type": { "name": "FreeSolo", "description": "FreeSolo" }, "default": "false" }, - "getOptionDisabled": { - "type": { - "name": "(option: Value) => boolean", - "description": "(option: Value) => boolean" - } - }, - "getOptionKey": { - "type": { - "name": "(option: Value | AutocompleteFreeSoloValueMapping<FreeSolo>) => string | number", - "description": "(option: Value | AutocompleteFreeSoloValueMapping<FreeSolo>) => string | number" - } - }, - "getOptionLabel": { - "type": { - "name": "(option: Value | AutocompleteFreeSoloValueMapping<FreeSolo>) => string", - "description": "(option: Value | AutocompleteFreeSoloValueMapping<FreeSolo>) => string" - }, - "default": "(option) => option.label ?? option" - }, - "groupBy": { - "type": { - "name": "(option: Value) => string", - "description": "(option: Value) => string" - } - }, - "handleHomeEndKeys": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "!props.freeSolo" - }, - "id": { "type": { "name": "string", "description": "string" } }, - "includeInputInList": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "inputValue": { "type": { "name": "string", "description": "string" } }, - "isOptionEqualToValue": { - "type": { - "name": "(option: Value, value: Value) => boolean", - "description": "(option: Value, value: Value) => boolean" - } - }, - "multiple": { "type": { "name": "Multiple", "description": "Multiple" }, "default": "false" }, - "onChange": { - "type": { - "name": "(event: React.SyntheticEvent, value: AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<Value>) => void", - "description": "(event: React.SyntheticEvent, value: AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<Value>) => void" - } - }, - "onClose": { - "type": { - "name": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) => void", - "description": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) => void" - } - }, - "onHighlightChange": { - "type": { - "name": "(event: React.SyntheticEvent, option: Value | null, reason: AutocompleteHighlightChangeReason) => void", - "description": "(event: React.SyntheticEvent, option: Value | null, reason: AutocompleteHighlightChangeReason) => void" - } - }, - "onInputChange": { - "type": { - "name": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) => void", - "description": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) => void" - } - }, - "onOpen": { - "type": { - "name": "(event: React.SyntheticEvent) => void", - "description": "(event: React.SyntheticEvent) => void" - } - }, - "open": { "type": { "name": "boolean", "description": "boolean" } }, - "openOnFocus": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "readOnly": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "selectOnFocus": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "!props.freeSolo" - }, - "unstable_classNamePrefix": { - "type": { "name": "string", "description": "string" }, - "default": "'Mui'" - }, - "unstable_isActiveElementInListbox": { - "type": { - "name": "(listbox: React.RefObject<HTMLElement>) => boolean", - "description": "(listbox: React.RefObject<HTMLElement>) => boolean" - } - }, - "value": { - "type": { - "name": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>", - "description": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>" - } - } - }, - "returnValue": { - "anchorEl": { - "type": { "name": "null | HTMLElement", "description": "null | HTMLElement" }, - "required": true - }, - "dirty": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "expanded": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focused": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focusedTag": { "type": { "name": "number", "description": "number" }, "required": true }, - "getClearProps": { - "type": { - "name": "() => React.HTMLAttributes<HTMLButtonElement>", - "description": "() => React.HTMLAttributes<HTMLButtonElement>" - }, - "required": true - }, - "getInputLabelProps": { - "type": { - "name": "() => Omit<React.HTMLAttributes<HTMLLabelElement>, 'color'>", - "description": "() => Omit<React.HTMLAttributes<HTMLLabelElement>, 'color'>" - }, - "required": true - }, - "getInputProps": { - "type": { - "name": "() => React.InputHTMLAttributes<HTMLInputElement> & {\n ref: React.Ref<HTMLInputElement>\n}", - "description": "() => React.InputHTMLAttributes<HTMLInputElement> & {\n ref: React.Ref<HTMLInputElement>\n}" - }, - "required": true - }, - "getListboxProps": { - "type": { - "name": "() => React.HTMLAttributes<HTMLUListElement>", - "description": "() => React.HTMLAttributes<HTMLUListElement>" - }, - "required": true - }, - "getOptionProps": { - "type": { - "name": "(renderedOption: UseAutocompleteRenderedOption<Value>) => React.HTMLAttributes<HTMLLIElement>", - "description": "(renderedOption: UseAutocompleteRenderedOption<Value>) => React.HTMLAttributes<HTMLLIElement>" - }, - "required": true - }, - "getPopupIndicatorProps": { - "type": { - "name": "() => React.HTMLAttributes<HTMLButtonElement>", - "description": "() => React.HTMLAttributes<HTMLButtonElement>" - }, - "required": true - }, - "getRootProps": { - "type": { - "name": "(externalProps?: any) => React.HTMLAttributes<HTMLDivElement>", - "description": "(externalProps?: any) => React.HTMLAttributes<HTMLDivElement>" - }, - "required": true - }, - "getTagProps": { - "type": { "name": "AutocompleteGetTagProps", "description": "AutocompleteGetTagProps" }, - "required": true - }, - "groupedOptions": { - "type": { - "name": "Value[] | Array<AutocompleteGroupedOption<Value>>", - "description": "Value[] | Array<AutocompleteGroupedOption<Value>>" - }, - "required": true - }, - "id": { "type": { "name": "string", "description": "string" }, "required": true }, - "inputValue": { "type": { "name": "string", "description": "string" }, "required": true }, - "popupOpen": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "setAnchorEl": { - "type": { "name": "() => void", "description": "() => void" }, - "required": true - }, - "value": { - "type": { - "name": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>", - "description": "AutocompleteValue<Value, Multiple, DisableClearable, FreeSolo>" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useAutocomplete", "filename": "/packages/mui-base/src/useAutocomplete/useAutocomplete.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-badge.json b/docs/pages/base-ui/api/use-badge.json index 2599860e63..1d400bb459 100644 --- a/docs/pages/base-ui/api/use-badge.json +++ b/docs/pages/base-ui/api/use-badge.json @@ -1,22 +1,6 @@ { - "parameters": { - "badgeContent": { "type": { "name": "React.ReactNode", "description": "React.ReactNode" } }, - "invisible": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "max": { "type": { "name": "number", "description": "number" }, "default": "99" }, - "showZero": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" } - }, - "returnValue": { - "badgeContent": { - "type": { "name": "React.ReactNode", "description": "React.ReactNode" }, - "required": true - }, - "displayValue": { - "type": { "name": "React.ReactNode", "description": "React.ReactNode" }, - "required": true - }, - "invisible": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "max": { "type": { "name": "number", "description": "number" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useBadge", "filename": "/packages/mui-base/src/useBadge/useBadge.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-button.json b/docs/pages/base-ui/api/use-button.json index e646d88bb3..888b7d1fc0 100644 --- a/docs/pages/base-ui/api/use-button.json +++ b/docs/pages/base-ui/api/use-button.json @@ -1,64 +1,6 @@ { - "parameters": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "focusableWhenDisabled": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "href": { "type": { "name": "string", "description": "string" } }, - "onFocusVisible": { - "type": { "name": "React.FocusEventHandler", "description": "React.FocusEventHandler" } - }, - "rootElementName": { - "type": { - "name": "keyof HTMLElementTagNameMap", - "description": "keyof HTMLElementTagNameMap" - }, - "default": "''" - }, - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "tabIndex": { - "type": { - "name": "NonNullable<React.HTMLAttributes<any>['tabIndex']>", - "description": "NonNullable<React.HTMLAttributes<any>['tabIndex']>" - } - }, - "to": { "type": { "name": "string", "description": "string" } }, - "type": { - "type": { - "name": "React.ButtonHTMLAttributes<HTMLButtonElement>['type']", - "description": "React.ButtonHTMLAttributes<HTMLButtonElement>['type']" - }, - "default": "'button'" - } - }, - "returnValue": { - "active": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focusVisible": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseButtonRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseButtonRootSlotProps<ExternalProps>" - }, - "required": true - }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "setFocusVisible": { - "type": { - "name": "React.Dispatch<React.SetStateAction<boolean>>", - "description": "React.Dispatch<React.SetStateAction<boolean>>" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useButton", "filename": "/packages/mui-base/src/useButton/useButton.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-dropdown.json b/docs/pages/base-ui/api/use-dropdown.json index 72a551c82e..c19b132c8c 100644 --- a/docs/pages/base-ui/api/use-dropdown.json +++ b/docs/pages/base-ui/api/use-dropdown.json @@ -1,25 +1,6 @@ { - "parameters": { - "componentName": { - "type": { "name": "string", "description": "string" }, - "default": "'useDropdown'" - }, - "defaultOpen": { "type": { "name": "boolean", "description": "boolean" } }, - "onOpenChange": { - "type": { - "name": "(event: React.MouseEvent | React.KeyboardEvent | React.FocusEvent | null, open: boolean) => void", - "description": "(event: React.MouseEvent | React.KeyboardEvent | React.FocusEvent | null, open: boolean) => void" - } - }, - "open": { "type": { "name": "boolean", "description": "boolean" } } - }, - "returnValue": { - "contextValue": { - "type": { "name": "DropdownContextValue", "description": "DropdownContextValue" }, - "required": true - }, - "open": { "type": { "name": "boolean", "description": "boolean" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useDropdown", "filename": "/packages/mui-base/src/useDropdown/useDropdown.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-form-control-context.json b/docs/pages/base-ui/api/use-form-control-context.json index ed4ebf4c1e..773f459e36 100644 --- a/docs/pages/base-ui/api/use-form-control-context.json +++ b/docs/pages/base-ui/api/use-form-control-context.json @@ -1,28 +1,6 @@ { "parameters": {}, - "returnValue": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "error": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "filled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focused": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "onBlur": { - "type": { "name": "() => void", "description": "() => void" }, - "required": true - }, - "onChange": { - "type": { - "name": "React.ChangeEventHandler<NativeFormControlElement>", - "description": "React.ChangeEventHandler<NativeFormControlElement>" - }, - "required": true - }, - "onFocus": { - "type": { "name": "() => void", "description": "() => void" }, - "required": true - }, - "required": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "value": { "type": { "name": "unknown", "description": "unknown" }, "required": true } - }, + "returnValue": {}, "name": "useFormControlContext", "filename": "/packages/mui-base/src/FormControl/useFormControlContext.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-input.json b/docs/pages/base-ui/api/use-input.json index dafebdd4c5..f73526f4ef 100644 --- a/docs/pages/base-ui/api/use-input.json +++ b/docs/pages/base-ui/api/use-input.json @@ -1,73 +1,6 @@ { - "parameters": { - "defaultValue": { "type": { "name": "unknown", "description": "unknown" } }, - "disabled": { "type": { "name": "boolean", "description": "boolean" } }, - "error": { "type": { "name": "boolean", "description": "boolean" } }, - "inputRef": { - "type": { - "name": "React.Ref<HTMLInputElement | HTMLTextAreaElement>", - "description": "React.Ref<HTMLInputElement | HTMLTextAreaElement>" - } - }, - "onBlur": { - "type": { - "name": "React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>", - "description": "React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>" - } - }, - "onChange": { - "type": { - "name": "React.ChangeEventHandler<HTMLInputElement | HTMLTextAreaElement>", - "description": "React.ChangeEventHandler<HTMLInputElement | HTMLTextAreaElement>" - } - }, - "onClick": { - "type": { "name": "React.MouseEventHandler", "description": "React.MouseEventHandler" } - }, - "onFocus": { - "type": { - "name": "React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>", - "description": "React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>" - } - }, - "required": { "type": { "name": "boolean", "description": "boolean" } }, - "value": { "type": { "name": "unknown", "description": "unknown" } } - }, - "returnValue": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "error": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focused": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "formControlContext": { - "type": { - "name": "FormControlState | undefined", - "description": "FormControlState | undefined" - }, - "required": true - }, - "getInputProps": { - "type": { - "name": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseInputInputSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseInputInputSlotProps<ExternalProps>" - }, - "required": true - }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseInputRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, any> = {}>(externalProps?: ExternalProps) => UseInputRootSlotProps<ExternalProps>" - }, - "required": true - }, - "inputRef": { - "type": { - "name": "React.RefCallback<HTMLInputElement | HTMLTextAreaElement> | null", - "description": "React.RefCallback<HTMLInputElement | HTMLTextAreaElement> | null" - }, - "required": true - }, - "required": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "value": { "type": { "name": "unknown", "description": "unknown" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useInput", "filename": "/packages/mui-base/src/useInput/useInput.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-menu-button.json b/docs/pages/base-ui/api/use-menu-button.json index 40b321b2e7..cb36f47fca 100644 --- a/docs/pages/base-ui/api/use-menu-button.json +++ b/docs/pages/base-ui/api/use-menu-button.json @@ -1,35 +1,6 @@ { - "parameters": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "focusableWhenDisabled": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "rootRef": { - "type": { - "name": "React.Ref<HTMLElement>", - "description": "React.Ref<HTMLElement>" - } - } - }, - "returnValue": { - "active": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuButtonRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuButtonRootSlotProps<ExternalProps>" - }, - "required": true - }, - "open": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useMenuButton", "filename": "/packages/mui-base/src/useMenuButton/useMenuButton.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-menu-item.json b/docs/pages/base-ui/api/use-menu-item.json index 2830f0a822..0d2f0331d6 100644 --- a/docs/pages/base-ui/api/use-menu-item.json +++ b/docs/pages/base-ui/api/use-menu-item.json @@ -1,44 +1,6 @@ { - "parameters": { - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" }, - "required": true - }, - "disabled": { "type": { "name": "boolean", "description": "boolean" } }, - "disableFocusOnHover": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "id": { "type": { "name": "string", "description": "string" } }, - "label": { "type": { "name": "string", "description": "string" } }, - "onClick": { - "type": { - "name": "React.MouseEventHandler<any>", - "description": "React.MouseEventHandler<any>" - } - } - }, - "returnValue": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focusVisible": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuItemRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuItemRootSlotProps<ExternalProps>" - }, - "required": true - }, - "highlighted": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "index": { "type": { "name": "number", "description": "number" }, "required": true }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "totalItemCount": { "type": { "name": "number", "description": "number" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useMenuItem", "filename": "/packages/mui-base/src/useMenuItem/useMenuItem.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-menu.json b/docs/pages/base-ui/api/use-menu.json index f117ccfae6..81ded1a70b 100644 --- a/docs/pages/base-ui/api/use-menu.json +++ b/docs/pages/base-ui/api/use-menu.json @@ -1,72 +1,6 @@ { - "parameters": { - "autoFocus": { "type": { "name": "boolean", "description": "boolean" }, "default": "true" }, - "componentName": { - "type": { "name": "string", "description": "string" }, - "default": "'useMenu'" - }, - "disabledItemsFocusable": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "true" - }, - "disableListWrap": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "id": { "type": { "name": "string", "description": "string" } }, - "listboxRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "onItemsChange": { - "type": { - "name": "(items: string[]) => void", - "description": "(items: string[]) => void" - } - } - }, - "returnValue": { - "contextValue": { - "type": { "name": "MenuProviderValue", "description": "MenuProviderValue" }, - "required": true - }, - "dispatch": { - "type": { - "name": "(action: ListAction<string>) => void", - "description": "(action: ListAction<string>) => void" - }, - "required": true - }, - "getListboxProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuListboxSlotProps", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseMenuListboxSlotProps" - }, - "required": true - }, - "highlightedValue": { - "type": { "name": "string | null", "description": "string | null" }, - "required": true - }, - "listboxRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "menuItems": { - "type": { - "name": "Map<string, MenuItemMetadata>", - "description": "Map<string, MenuItemMetadata>" - }, - "required": true - }, - "open": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "triggerElement": { - "type": { "name": "HTMLElement | null", "description": "HTMLElement | null" }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useMenu", "filename": "/packages/mui-base/src/useMenu/useMenu.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-modal.json b/docs/pages/base-ui/api/use-modal.json index 494620611c..b687e9a91e 100644 --- a/docs/pages/base-ui/api/use-modal.json +++ b/docs/pages/base-ui/api/use-modal.json @@ -1,96 +1,6 @@ { - "parameters": { - "children": { - "type": { - "name": "React.ReactElement | undefined | null", - "description": "React.ReactElement | undefined | null" - }, - "required": true - }, - "open": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" }, - "required": true - }, - "aria-hidden": { - "type": { - "name": "React.AriaAttributes['aria-hidden']", - "description": "React.AriaAttributes['aria-hidden']" - } - }, - "closeAfterTransition": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "container": { - "type": { - "name": "PortalProps['container']", - "description": "PortalProps['container']" - } - }, - "disableEscapeKeyDown": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "disableScrollLock": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "onClose": { - "type": { - "name": "{\n bivarianceHack(event: {}, reason: 'backdropClick' | 'escapeKeyDown'): void\n}['bivarianceHack']", - "description": "{\n bivarianceHack(event: {}, reason: 'backdropClick' | 'escapeKeyDown'): void\n}['bivarianceHack']" - } - }, - "onKeyDown": { - "type": { "name": "React.KeyboardEventHandler", "description": "React.KeyboardEventHandler" } - }, - "onTransitionEnter": { "type": { "name": "() => void", "description": "() => void" } }, - "onTransitionExited": { "type": { "name": "() => void", "description": "() => void" } } - }, - "returnValue": { - "exited": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "getBackdropProps": { - "type": { - "name": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalBackdropSlotProps<TOther>", - "description": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalBackdropSlotProps<TOther>" - }, - "required": true - }, - "getRootProps": { - "type": { - "name": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalRootSlotProps<TOther>", - "description": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => UseModalRootSlotProps<TOther>" - }, - "required": true - }, - "getTransitionProps": { - "type": { - "name": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => { onEnter: () => void; onExited: () => void }", - "description": "<TOther extends EventHandlers = {}>(externalProps?: TOther) => { onEnter: () => void; onExited: () => void }" - }, - "required": true - }, - "hasTransition": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "isTopModal": { - "type": { "name": "() => boolean", "description": "() => boolean" }, - "required": true - }, - "portalRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useModal", "filename": "/packages/mui-base/src/unstable_useModal/useModal.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-option.json b/docs/pages/base-ui/api/use-option.json index 0db56f9c19..de9c7def97 100644 --- a/docs/pages/base-ui/api/use-option.json +++ b/docs/pages/base-ui/api/use-option.json @@ -1,35 +1,6 @@ { - "parameters": { - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "label": { - "type": { "name": "string | React.ReactNode", "description": "string | React.ReactNode" }, - "required": true - }, - "value": { "type": { "name": "Value", "description": "Value" }, "required": true }, - "id": { "type": { "name": "string", "description": "string" } }, - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - } - }, - "returnValue": { - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown>>(externalProps?: ExternalProps) => UseOptionRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown>>(externalProps?: ExternalProps) => UseOptionRootSlotProps<ExternalProps>" - }, - "required": true - }, - "highlighted": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "index": { "type": { "name": "number", "description": "number" }, "required": true }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "selected": { "type": { "name": "boolean", "description": "boolean" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useOption", "filename": "/packages/mui-base/src/useOption/useOption.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-select.json b/docs/pages/base-ui/api/use-select.json index 7039d1053f..0921e8f03a 100644 --- a/docs/pages/base-ui/api/use-select.json +++ b/docs/pages/base-ui/api/use-select.json @@ -1,152 +1,6 @@ { - "parameters": { - "areOptionsEqual": { - "type": { - "name": "(a: OptionValue, b: OptionValue) => boolean", - "description": "(a: OptionValue, b: OptionValue) => boolean" - } - }, - "buttonRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "componentName": { - "type": { "name": "string", "description": "string" }, - "default": "'useSelect'" - }, - "defaultOpen": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "defaultValue": { - "type": { - "name": "SelectValue<OptionValue, Multiple>", - "description": "SelectValue<OptionValue, Multiple>" - } - }, - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "getOptionAsString": { - "type": { - "name": "(option: SelectOption<OptionValue>) => string", - "description": "(option: SelectOption<OptionValue>) => string" - }, - "default": "defaultOptionStringifier" - }, - "getSerializedValue": { - "type": { - "name": "(option: SelectValue<SelectOption<OptionValue>, Multiple>) => React.InputHTMLAttributes<HTMLInputElement>['value']", - "description": "(option: SelectValue<SelectOption<OptionValue>, Multiple>) => React.InputHTMLAttributes<HTMLInputElement>['value']" - } - }, - "listboxId": { "type": { "name": "string", "description": "string" } }, - "listboxRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "multiple": { "type": { "name": "Multiple", "description": "Multiple" }, "default": "false" }, - "name": { "type": { "name": "string", "description": "string" } }, - "onChange": { - "type": { - "name": "(event: React.MouseEvent | React.KeyboardEvent | React.FocusEvent | null, value: SelectValue<OptionValue, Multiple>) => void", - "description": "(event: React.MouseEvent | React.KeyboardEvent | React.FocusEvent | null, value: SelectValue<OptionValue, Multiple>) => void" - } - }, - "onHighlightChange": { - "type": { - "name": "(event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<Element> | React.FocusEvent<Element, Element> | null, highlighted: OptionValue | null) => void", - "description": "(event: React.MouseEvent<Element, MouseEvent> | React.KeyboardEvent<Element> | React.FocusEvent<Element, Element> | null, highlighted: OptionValue | null) => void" - } - }, - "onOpenChange": { - "type": { "name": "(open: boolean) => void", "description": "(open: boolean) => void" } - }, - "open": { "type": { "name": "boolean", "description": "boolean" } }, - "options": { - "type": { - "name": "ReadonlyArray<SelectOptionDefinition<OptionValue>>", - "description": "ReadonlyArray<SelectOptionDefinition<OptionValue>>" - } - }, - "required": { "type": { "name": "boolean", "description": "boolean" } }, - "value": { - "type": { - "name": "SelectValue<OptionValue, Multiple>", - "description": "SelectValue<OptionValue, Multiple>" - } - } - }, - "returnValue": { - "buttonActive": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "buttonFocusVisible": { - "type": { "name": "boolean", "description": "boolean" }, - "required": true - }, - "buttonRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "contextValue": { - "type": { - "name": "SelectProviderValue<Value>", - "description": "SelectProviderValue<Value>" - }, - "required": true - }, - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "dispatch": { - "type": { - "name": "(action: ListAction<Value> | SelectAction<Value>) => void", - "description": "(action: ListAction<Value> | SelectAction<Value>) => void" - }, - "required": true - }, - "getButtonProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectButtonSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectButtonSlotProps<ExternalProps>" - }, - "required": true - }, - "getHiddenInputProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectHiddenInputSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectHiddenInputSlotProps<ExternalProps>" - }, - "required": true - }, - "getListboxProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectListboxSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSelectListboxSlotProps<ExternalProps>" - }, - "required": true - }, - "getOptionMetadata": { - "type": { - "name": "(optionValue: Value) => SelectOption<Value> | undefined", - "description": "(optionValue: Value) => SelectOption<Value> | undefined" - }, - "required": true - }, - "highlightedOption": { - "type": { "name": "Value | null", "description": "Value | null" }, - "required": true - }, - "listboxRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "open": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "options": { "type": { "name": "Value[]", "description": "Value[]" }, "required": true }, - "value": { - "type": { - "name": "SelectValue<Value, Multiple>", - "description": "SelectValue<Value, Multiple>" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useSelect", "filename": "/packages/mui-base/src/useSelect/useSelect.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-slider.json b/docs/pages/base-ui/api/use-slider.json index 80574b4b45..3308cd410c 100644 --- a/docs/pages/base-ui/api/use-slider.json +++ b/docs/pages/base-ui/api/use-slider.json @@ -1,121 +1,6 @@ { - "parameters": { - "aria-labelledby": { "type": { "name": "string", "description": "string" } }, - "defaultValue": { - "type": { - "name": "number | ReadonlyArray<number>", - "description": "number | ReadonlyArray<number>" - } - }, - "disabled": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "disableSwap": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "isRtl": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" }, - "marks": { - "type": { - "name": "boolean | ReadonlyArray<Mark>", - "description": "boolean | ReadonlyArray<Mark>" - }, - "default": "false" - }, - "max": { "type": { "name": "number", "description": "number" }, "default": "100" }, - "min": { "type": { "name": "number", "description": "number" }, "default": "0" }, - "name": { "type": { "name": "string", "description": "string" } }, - "onChange": { - "type": { - "name": "(event: Event, value: number | number[], activeThumb: number) => void", - "description": "(event: Event, value: number | number[], activeThumb: number) => void" - } - }, - "onChangeCommitted": { - "type": { - "name": "(event: React.SyntheticEvent | Event, value: number | number[]) => void", - "description": "(event: React.SyntheticEvent | Event, value: number | number[]) => void" - } - }, - "orientation": { - "type": { - "name": "'horizontal' | 'vertical'", - "description": "'horizontal' | 'vertical'" - }, - "default": "'horizontal'" - }, - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "scale": { - "type": { - "name": "(value: number) => number", - "description": "(value: number) => number" - }, - "default": "function Identity(x) {\nreturn x;\n}" - }, - "shiftStep": { "type": { "name": "number", "description": "number" }, "default": "10" }, - "step": { "type": { "name": "number | null", "description": "number | null" }, "default": "1" }, - "tabIndex": { "type": { "name": "number", "description": "number" } }, - "value": { - "type": { - "name": "number | ReadonlyArray<number>", - "description": "number | ReadonlyArray<number>" - } - } - }, - "returnValue": { - "active": { "type": { "name": "number", "description": "number" }, "required": true }, - "axis": { "type": { "name": "Axis", "description": "Axis" }, "required": true }, - "axisProps": { - "type": { - "name": "{ [key in Axis]: AxisProps<key> }", - "description": "{ [key in Axis]: AxisProps<key> }" - }, - "required": true - }, - "dragging": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focusedThumbIndex": { - "type": { "name": "number", "description": "number" }, - "required": true - }, - "getHiddenInputProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderHiddenInputProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderHiddenInputProps<ExternalProps>" - }, - "required": true - }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderRootSlotProps<ExternalProps>" - }, - "required": true - }, - "getThumbProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderThumbSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSliderThumbSlotProps<ExternalProps>" - }, - "required": true - }, - "getThumbStyle": { - "type": { - "name": "(index: number) => object", - "description": "(index: number) => object" - }, - "required": true - }, - "marks": { "type": { "name": "Mark[]", "description": "Mark[]" }, "required": true }, - "open": { "type": { "name": "number", "description": "number" }, "required": true }, - "range": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "trackLeap": { "type": { "name": "number", "description": "number" }, "required": true }, - "trackOffset": { "type": { "name": "number", "description": "number" }, "required": true }, - "values": { "type": { "name": "number[]", "description": "number[]" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useSlider", "filename": "/packages/mui-base/src/useSlider/useSlider.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-snackbar.json b/docs/pages/base-ui/api/use-snackbar.json index 84d9eda9f5..888e14c080 100644 --- a/docs/pages/base-ui/api/use-snackbar.json +++ b/docs/pages/base-ui/api/use-snackbar.json @@ -1,38 +1,6 @@ { - "parameters": { - "autoHideDuration": { - "type": { "name": "number | null", "description": "number | null" }, - "default": "null" - }, - "disableWindowBlurListener": { - "type": { "name": "boolean", "description": "boolean" }, - "default": "false" - }, - "onClose": { - "type": { - "name": "(event: React.SyntheticEvent<any> | Event | null, reason: SnackbarCloseReason) => void", - "description": "(event: React.SyntheticEvent<any> | Event | null, reason: SnackbarCloseReason) => void" - } - }, - "open": { "type": { "name": "boolean", "description": "boolean" } }, - "resumeHideDuration": { "type": { "name": "number", "description": "number" } } - }, - "returnValue": { - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSnackbarRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSnackbarRootSlotProps<ExternalProps>" - }, - "required": true - }, - "onClickAway": { - "type": { - "name": "(event: React.SyntheticEvent<any> | Event) => void", - "description": "(event: React.SyntheticEvent<any> | Event) => void" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useSnackbar", "filename": "/packages/mui-base/src/useSnackbar/useSnackbar.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-tab-panel.json b/docs/pages/base-ui/api/use-tab-panel.json index 1a3a16364f..a5b6efda91 100644 --- a/docs/pages/base-ui/api/use-tab-panel.json +++ b/docs/pages/base-ui/api/use-tab-panel.json @@ -1,31 +1,6 @@ { - "parameters": { - "id": { "type": { "name": "string", "description": "string" } }, - "rootRef": { - "type": { - "name": "React.Ref<HTMLElement>", - "description": "React.Ref<HTMLElement>" - } - }, - "value": { "type": { "name": "number | string", "description": "number | string" } } - }, - "returnValue": { - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabPanelRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabPanelRootSlotProps<ExternalProps>" - }, - "required": true - }, - "hidden": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "rootRef": { - "type": { - "name": "React.Ref<HTMLElement>", - "description": "React.Ref<HTMLElement>" - }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useTabPanel", "filename": "/packages/mui-base/src/useTabPanel/useTabPanel.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-tab.json b/docs/pages/base-ui/api/use-tab.json index 3f8cbe9fad..88d1809214 100644 --- a/docs/pages/base-ui/api/use-tab.json +++ b/docs/pages/base-ui/api/use-tab.json @@ -1,50 +1,6 @@ { - "parameters": { - "disabled": { "type": { "name": "boolean", "description": "boolean" } }, - "id": { "type": { "name": "string", "description": "string" } }, - "onChange": { - "type": { - "name": "(event: React.SyntheticEvent, value: number | string) => void", - "description": "(event: React.SyntheticEvent, value: number | string) => void" - } - }, - "onClick": { - "type": { "name": "React.MouseEventHandler", "description": "React.MouseEventHandler" } - }, - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" } - }, - "value": { "type": { "name": "number | string", "description": "number | string" } } - }, - "returnValue": { - "active": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "focusVisible": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabRootSlotProps<ExternalProps>" - }, - "required": true - }, - "highlighted": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "index": { "type": { "name": "number", "description": "number" }, "required": true }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "selected": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "setFocusVisible": { - "type": { - "name": "React.Dispatch<React.SetStateAction<boolean>>", - "description": "React.Dispatch<React.SetStateAction<boolean>>" - }, - "required": true - }, - "totalTabsCount": { "type": { "name": "number", "description": "number" }, "required": true } - }, + "parameters": {}, + "returnValue": {}, "name": "useTab", "filename": "/packages/mui-base/src/useTab/useTab.ts", "imports": ["import { useTab } from '@mui/base/useTab';", "import { useTab } from '@mui/base';"], diff --git a/docs/pages/base-ui/api/use-tabs-list.json b/docs/pages/base-ui/api/use-tabs-list.json index a853f2012c..a438a5b09b 100644 --- a/docs/pages/base-ui/api/use-tabs-list.json +++ b/docs/pages/base-ui/api/use-tabs-list.json @@ -1,53 +1,6 @@ { - "parameters": { - "rootRef": { - "type": { "name": "React.Ref<Element>", "description": "React.Ref<Element>" }, - "required": true - } - }, - "returnValue": { - "contextValue": { - "type": { "name": "TabsListProviderValue", "description": "TabsListProviderValue" }, - "required": true - }, - "dispatch": { - "type": { - "name": "(action: ListAction<string | number>) => void", - "description": "(action: ListAction<string | number>) => void" - }, - "required": true - }, - "getRootProps": { - "type": { - "name": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabsListRootSlotProps<ExternalProps>", - "description": "<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseTabsListRootSlotProps<ExternalProps>" - }, - "required": true - }, - "highlightedValue": { - "type": { "name": "string | number | null", "description": "string | number | null" }, - "required": true - }, - "isRtl": { "type": { "name": "boolean", "description": "boolean" }, "required": true }, - "orientation": { - "type": { - "name": "'horizontal' | 'vertical'", - "description": "'horizontal' | 'vertical'" - }, - "required": true - }, - "rootRef": { - "type": { - "name": "React.RefCallback<Element> | null", - "description": "React.RefCallback<Element> | null" - }, - "required": true - }, - "selectedValue": { - "type": { "name": "string | number | null", "description": "string | number | null" }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useTabsList", "filename": "/packages/mui-base/src/useTabsList/useTabsList.ts", "imports": [ diff --git a/docs/pages/base-ui/api/use-tabs.json b/docs/pages/base-ui/api/use-tabs.json index 488fd8915e..79d96f7425 100644 --- a/docs/pages/base-ui/api/use-tabs.json +++ b/docs/pages/base-ui/api/use-tabs.json @@ -1,39 +1,6 @@ { - "parameters": { - "defaultValue": { - "type": { "name": "string | number | null", "description": "string | number | null" } - }, - "direction": { - "type": { - "name": "'ltr' | 'rtl'", - "description": "'ltr' | 'rtl'" - }, - "default": "'ltr'" - }, - "onChange": { - "type": { - "name": "(event: React.SyntheticEvent | null, value: number | string | null) => void", - "description": "(event: React.SyntheticEvent | null, value: number | string | null) => void" - } - }, - "orientation": { - "type": { - "name": "'horizontal' | 'vertical'", - "description": "'horizontal' | 'vertical'" - }, - "default": "'horizontal'" - }, - "selectionFollowsFocus": { "type": { "name": "boolean", "description": "boolean" } }, - "value": { - "type": { "name": "string | number | null", "description": "string | number | null" } - } - }, - "returnValue": { - "contextValue": { - "type": { "name": "TabsProviderValue", "description": "TabsProviderValue" }, - "required": true - } - }, + "parameters": {}, + "returnValue": {}, "name": "useTabs", "filename": "/packages/mui-base/src/useTabs/useTabs.ts", "imports": [ diff --git a/docs/src/modules/components/BaseUIComponents.js b/docs/src/modules/components/BaseUIComponents.js index 6a540763cd..c91263acdd 100644 --- a/docs/src/modules/components/BaseUIComponents.js +++ b/docs/src/modules/components/BaseUIComponents.js @@ -8,132 +8,132 @@ import { Link } from '@mui/docs/Link'; function components() { return [ - { - title: 'Autocomplete', - srcLight: '/static/base-ui/react-components/autocomplete-light.png', - srcDark: '/static/base-ui/react-components/autocomplete-dark.png', - href: '/base-ui/react-autocomplete/', - }, - { - title: 'Badge', - srcLight: '/static/base-ui/react-components/badge-light.png', - srcDark: '/static/base-ui/react-components/badge-dark.png', - href: '/base-ui/react-badge/', - }, - { - title: 'Button', - srcLight: '/static/base-ui/react-components/button-light.png', - srcDark: '/static/base-ui/react-components/button-dark.png', - href: '/base-ui/react-button/', - }, + // { + // title: 'Autocomplete', + // srcLight: '/static/base-ui/react-components/autocomplete-light.png', + // srcDark: '/static/base-ui/react-components/autocomplete-dark.png', + // href: '/base-ui/react-autocomplete/', + // }, + // { + // title: 'Badge', + // srcLight: '/static/base-ui/react-components/badge-light.png', + // srcDark: '/static/base-ui/react-components/badge-dark.png', + // href: '/base-ui/react-badge/', + // }, + // { + // title: 'Button', + // srcLight: '/static/base-ui/react-components/button-light.png', + // srcDark: '/static/base-ui/react-components/button-dark.png', + // href: '/base-ui/react-button/', + // }, { title: 'Checkbox', srcLight: '/static/base-ui/react-components/checkbox-light.png', srcDark: '/static/base-ui/react-components/checkbox-dark.png', href: '/base-ui/react-checkbox/', }, - { - title: 'Click-Away Listener', - srcLight: '/static/base-ui/react-components/click-away-light.png', - srcDark: '/static/base-ui/react-components/click-away-dark.png', - href: '/base-ui/react-click-away-listener/', - }, - { - title: 'Focus Trap', - srcLight: '/static/base-ui/react-components/focus-trap-light.png', - srcDark: '/static/base-ui/react-components/focus-trap-dark.png', - href: '/base-ui/react-focus-trap/', - }, - { - title: 'Form Control', - srcLight: '/static/base-ui/react-components/form-control-light.png', - srcDark: '/static/base-ui/react-components/form-control-dark.png', - href: '/base-ui/react-form-control/', - }, - { - title: 'Input', - srcLight: '/static/base-ui/react-components/input-light.png', - srcDark: '/static/base-ui/react-components/input-dark.png', - href: '/base-ui/react-input/', - }, - { - title: 'Menu', - srcLight: '/static/base-ui/react-components/menu-light.png', - srcDark: '/static/base-ui/react-components/menu-dark.png', - href: '/base-ui/react-menu/', - }, - { - title: 'Modal', - srcLight: '/static/base-ui/react-components/modal-light.png', - srcDark: '/static/base-ui/react-components/modal-dark.png', - href: '/base-ui/react-modal/', - }, - { - title: 'No-SSR', - srcLight: '/static/base-ui/react-components/no-ssr-light.png', - srcDark: '/static/base-ui/react-components/no-ssr-dark.png', - href: '/base-ui/react-no-ssr/', - }, + // { + // title: 'Click-Away Listener', + // srcLight: '/static/base-ui/react-components/click-away-light.png', + // srcDark: '/static/base-ui/react-components/click-away-dark.png', + // href: '/base-ui/react-click-away-listener/', + // }, + // { + // title: 'Focus Trap', + // srcLight: '/static/base-ui/react-components/focus-trap-light.png', + // srcDark: '/static/base-ui/react-components/focus-trap-dark.png', + // href: '/base-ui/react-focus-trap/', + // }, + // { + // title: 'Form Control', + // srcLight: '/static/base-ui/react-components/form-control-light.png', + // srcDark: '/static/base-ui/react-components/form-control-dark.png', + // href: '/base-ui/react-form-control/', + // }, + // { + // title: 'Input', + // srcLight: '/static/base-ui/react-components/input-light.png', + // srcDark: '/static/base-ui/react-components/input-dark.png', + // href: '/base-ui/react-input/', + // }, + // { + // title: 'Menu', + // srcLight: '/static/base-ui/react-components/menu-light.png', + // srcDark: '/static/base-ui/react-components/menu-dark.png', + // href: '/base-ui/react-menu/', + // }, + // { + // title: 'Modal', + // srcLight: '/static/base-ui/react-components/modal-light.png', + // srcDark: '/static/base-ui/react-components/modal-dark.png', + // href: '/base-ui/react-modal/', + // }, + // { + // title: 'No-SSR', + // srcLight: '/static/base-ui/react-components/no-ssr-light.png', + // srcDark: '/static/base-ui/react-components/no-ssr-dark.png', + // href: '/base-ui/react-no-ssr/', + // }, { title: 'Number Field', srcLight: '/static/base-ui/react-components/number-field-light.png', srcDark: '/static/base-ui/react-components/number-field-dark.png', href: '/base-ui/react-number-field/', }, - { - title: 'Popper', - srcLight: '/static/base-ui/react-components/popper-light.png', - srcDark: '/static/base-ui/react-components/popper-dark.png', - href: '/base-ui/react-popper/', - }, - { - title: 'Portal', - srcLight: '/static/base-ui/react-components/portal-light.png', - srcDark: '/static/base-ui/react-components/portal-dark.png', - href: '/base-ui/react-portal/', - }, - { - title: 'Select', - srcLight: '/static/base-ui/react-components/select-light.png', - srcDark: '/static/base-ui/react-components/select-dark.png', - href: '/base-ui/react-select/', - }, - { - title: 'Slider', - srcLight: '/static/base-ui/react-components/slider-light.png', - srcDark: '/static/base-ui/react-components/slider-dark.png', - href: '/base-ui/react-slider/', - }, - { - title: 'Snackbar', - srcLight: '/static/base-ui/react-components/snackbar-light.png', - srcDark: '/static/base-ui/react-components/snackbar-dark.png', - href: '/base-ui/react-snackbar/', - }, + // { + // title: 'Popper', + // srcLight: '/static/base-ui/react-components/popper-light.png', + // srcDark: '/static/base-ui/react-components/popper-dark.png', + // href: '/base-ui/react-popper/', + // }, + // { + // title: 'Portal', + // srcLight: '/static/base-ui/react-components/portal-light.png', + // srcDark: '/static/base-ui/react-components/portal-dark.png', + // href: '/base-ui/react-portal/', + // }, + // { + // title: 'Select', + // srcLight: '/static/base-ui/react-components/select-light.png', + // srcDark: '/static/base-ui/react-components/select-dark.png', + // href: '/base-ui/react-select/', + // }, + // { + // title: 'Slider', + // srcLight: '/static/base-ui/react-components/slider-light.png', + // srcDark: '/static/base-ui/react-components/slider-dark.png', + // href: '/base-ui/react-slider/', + // }, + // { + // title: 'Snackbar', + // srcLight: '/static/base-ui/react-components/snackbar-light.png', + // srcDark: '/static/base-ui/react-components/snackbar-dark.png', + // href: '/base-ui/react-snackbar/', + // }, { title: 'Switch', srcLight: '/static/base-ui/react-components/switch-light.png', srcDark: '/static/base-ui/react-components/switch-dark.png', href: '/base-ui/react-switch/', }, - { - title: 'Table Pagination', - srcLight: '/static/base-ui/react-components/pagination-light.png', - srcDark: '/static/base-ui/react-components/pagination-dark.png', - href: '/base-ui/react-table-pagination/', - }, - { - title: 'Tabs', - srcLight: '/static/base-ui/react-components/tabs-light.png', - srcDark: '/static/base-ui/react-components/tabs-dark.png', - href: '/base-ui/react-tabs/', - }, - { - title: 'Textarea Autosize', - srcLight: '/static/base-ui/react-components/textarea-light.png', - srcDark: '/static/base-ui/react-components/textarea-dark.png', - href: '/base-ui/react-textarea-autosize/', - }, + // { + // title: 'Table Pagination', + // srcLight: '/static/base-ui/react-components/pagination-light.png', + // srcDark: '/static/base-ui/react-components/pagination-dark.png', + // href: '/base-ui/react-table-pagination/', + // }, + // { + // title: 'Tabs', + // srcLight: '/static/base-ui/react-components/tabs-light.png', + // srcDark: '/static/base-ui/react-components/tabs-dark.png', + // href: '/base-ui/react-tabs/', + // }, + // { + // title: 'Textarea Autosize', + // srcLight: '/static/base-ui/react-components/textarea-light.png', + // srcDark: '/static/base-ui/react-components/textarea-dark.png', + // href: '/base-ui/react-textarea-autosize/', + // }, ]; } diff --git a/docs/translations/api-docs/use-autocomplete/use-autocomplete.json b/docs/translations/api-docs/use-autocomplete/use-autocomplete.json index 53a5026f43..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-autocomplete/use-autocomplete.json +++ b/docs/translations/api-docs/use-autocomplete/use-autocomplete.json @@ -1,125 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "autoComplete": { - "description": "If true, the portion of the selected suggestion that the user hasn't typed, known as the completion string, appears inline after the input cursor in the textbox. The inline completion string is visually highlighted and has a selected state." - }, - "autoHighlight": { - "description": "If true, the first option is automatically highlighted." - }, - "autoSelect": { - "description": "If true, the selected option becomes the value of the input when the Autocomplete loses focus unless the user chooses a different option or changes the character string in the input.
When using the freeSolo mode, the typed value will be the input value if the Autocomplete loses focus without highlighting an option." - }, - "blurOnSelect": { - "description": "

Control if the input should be blurred when an option is selected:

\n\n" - }, - "clearOnBlur": { - "description": "If true, the input's text is cleared on blur if no value is selected.
Set it to true if you want to help the user enter a new value. Set it to false if you want to help the user resume their search." - }, - "clearOnEscape": { - "description": "If true, clear all values when the user presses escape and the popup is closed." - }, - "componentName": { - "description": "The component name that is using this hook. Used for warnings." - }, - "defaultValue": { - "description": "The default value. Use when the component is not controlled." - }, - "disableClearable": { "description": "If true, the input can't be cleared." }, - "disableCloseOnSelect": { - "description": "If true, the popup won't close when a value is selected." - }, - "disabled": { "description": "If true, the component is disabled." }, - "disabledItemsFocusable": { - "description": "If true, will allow focus on disabled items." - }, - "disableListWrap": { - "description": "If true, the list box in the popup will not wrap focus." - }, - "filterOptions": { - "description": "A function that determines the filtered options to be rendered on search." - }, - "filterSelectedOptions": { - "description": "If true, hide the selected options from the list box." - }, - "freeSolo": { - "description": "If true, the Autocomplete is free solo, meaning that the user input is not bound to provided options." - }, - "getOptionDisabled": { - "description": "Used to determine the disabled state for a given option." - }, - "getOptionKey": { - "description": "Used to determine the key for a given option. This can be useful when the labels of options are not unique (since labels are used as keys by default)." - }, - "getOptionLabel": { - "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if renderOption is not provided).
If used in free solo mode, it must accept both the type of the options and a string." - }, - "groupBy": { - "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when renderGroup is not provided." - }, - "handleHomeEndKeys": { - "description": "If true, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively." - }, - "id": { - "description": "This prop is used to help implement the accessibility logic. If you don't provide an id it will fall back to a randomly generated one." - }, - "includeInputInList": { - "description": "If true, the highlight can move to the input." - }, - "inputValue": { "description": "The input value." }, - "isOptionEqualToValue": { - "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value." - }, - "multiple": { - "description": "If true, value must be an array and the menu will support multiple selections." - }, - "onChange": { "description": "Callback fired when the value changes." }, - "onClose": { - "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open)." - }, - "onHighlightChange": { "description": "Callback fired when the highlight option changes." }, - "onInputChange": { "description": "Callback fired when the input value changes." }, - "onOpen": { - "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open)." - }, - "open": { "description": "If true, the component is shown." }, - "openOnFocus": { "description": "If true, the popup will open on input focus." }, - "options": { "description": "Array of options." }, - "readOnly": { - "description": "If true, the component becomes readonly. It is also supported for multiple tags where the tag cannot be deleted." - }, - "selectOnFocus": { - "description": "If true, the input's text is selected on focus. It helps the user clear the selected value." - }, - "value": { - "description": "The value of the autocomplete.
The value must have reference equality with the option in order to be selected. You can customize the equality behavior with the isOptionEqualToValue prop." - } - }, - "returnValueDescriptions": { - "anchorEl": { - "description": "An HTML element that is used to set the position of the component." - }, - "dirty": { "description": "If true, the component input has some values." }, - "expanded": { "description": "If true, the listbox is being displayed." }, - "focused": { "description": "If true, the component is focused." }, - "focusedTag": { "description": "Index of the focused tag for the component." }, - "getClearProps": { - "description": "Resolver for the clear button element's props." - }, - "getInputLabelProps": { "description": "Resolver for the input label element's props." }, - "getInputProps": { "description": "Resolver for the input element's props." }, - "getListboxProps": { "description": "Resolver for the listbox component's props." }, - "getOptionProps": { "description": "Resolver for the rendered option element's props." }, - "getPopupIndicatorProps": { "description": "Resolver for the popup icon's props." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "getTagProps": { "description": "A tag props getter." }, - "groupedOptions": { - "description": "The options to render. It's either Value[] or AutocompleteGroupedOption<Value>[] if the groupBy prop is provided." - }, - "id": { "description": "Id for the Autocomplete." }, - "inputValue": { "description": "The input value." }, - "popupOpen": { "description": "If true, the popup is open on the component." }, - "setAnchorEl": { "description": "Setter for the component anchorEl." }, - "value": { "description": "The value of the autocomplete." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-badge/use-badge.json b/docs/translations/api-docs/use-badge/use-badge.json index 943bcb8cf5..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-badge/use-badge.json +++ b/docs/translations/api-docs/use-badge/use-badge.json @@ -1,19 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "badgeContent": { "description": "The content rendered within the badge." }, - "invisible": { "description": "If true, the badge is invisible." }, - "max": { "description": "Max count to show." }, - "showZero": { - "description": "Controls whether the badge is hidden when badgeContent is zero." - } - }, - "returnValueDescriptions": { - "badgeContent": { "description": "Defines the content that's displayed inside the badge." }, - "displayValue": { - "description": "Value to be displayed in the badge. If badgeContent is greater than max, it will return max+." - }, - "invisible": { "description": "If true, the component will not be visible." }, - "max": { "description": "Maximum number to be displayed in the badge." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-button/use-button.json b/docs/translations/api-docs/use-button/use-button.json index 8efee36156..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-button/use-button.json +++ b/docs/translations/api-docs/use-button/use-button.json @@ -1,24 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "disabled": { "description": "If true, the component is disabled." }, - "focusableWhenDisabled": { - "description": "If true, allows a disabled button to receive focus." - }, - "rootElementName": { "description": "The HTML element, e.g.'button', 'a' etc" }, - "type": { - "description": "Type attribute applied when the component is button." - } - }, - "returnValueDescriptions": { - "active": { "description": "If true, the component is active (pressed)." }, - "focusVisible": { - "description": "If true, the component is being focused using keyboard." - }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "rootRef": { "description": "A ref to the component's root DOM element." }, - "setFocusVisible": { - "description": "Callback for setting the focusVisible param." - } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-dropdown/use-dropdown.json b/docs/translations/api-docs/use-dropdown/use-dropdown.json index 636ab4b782..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-dropdown/use-dropdown.json +++ b/docs/translations/api-docs/use-dropdown/use-dropdown.json @@ -1,19 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "componentName": { - "description": "The name of the component using useDropdown. For debugging purposes." - }, - "defaultOpen": { "description": "If true, the dropdown is initially open." }, - "onOpenChange": { - "description": "Callback fired when the component requests to be opened or closed." - }, - "open": { - "description": "Allows to control whether the dropdown is open. This is a controlled counterpart of defaultOpen." - } - }, - "returnValueDescriptions": { - "contextValue": { "description": "The value to be passed into the DropdownContext provider." }, - "open": { "description": "If true, the dropdown is open." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-form-control-context/use-form-control-context.json b/docs/translations/api-docs/use-form-control-context/use-form-control-context.json index 6ed136768a..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-form-control-context/use-form-control-context.json +++ b/docs/translations/api-docs/use-form-control-context/use-form-control-context.json @@ -1,21 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": {}, - "returnValueDescriptions": { - "disabled": { - "description": "If true, the label, input and helper text should be displayed in a disabled state." - }, - "error": { "description": "If true, the label is displayed in an error state." }, - "filled": { "description": "If true, the form element has some value." }, - "focused": { - "description": "If true, the form element is focused and not disabled." - }, - "onBlur": { "description": "Callback fired when the form element has lost focus." }, - "onChange": { "description": "Callback fired when the form element's value is modified." }, - "onFocus": { "description": "Callback fired when the form element receives focus." }, - "required": { - "description": "If true, the label will indicate that the input is required." - }, - "value": { "description": "The value of the form element." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-input/use-input.json b/docs/translations/api-docs/use-input/use-input.json index f2af733d55..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-input/use-input.json +++ b/docs/translations/api-docs/use-input/use-input.json @@ -1,33 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "defaultValue": { - "description": "The default value. Use when the component is not controlled." - }, - "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." - }, - "error": { - "description": "If true, the input will indicate an error by setting the aria-invalid attribute. The prop defaults to the value (false) inherited from the parent FormControl component." - }, - "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." - } - }, - "returnValueDescriptions": { - "disabled": { "description": "If true, the component will be disabled." }, - "error": { - "description": "If true, the input will indicate an error by setting the aria-invalid attribute." - }, - "focused": { "description": "If true, the input will be focused." }, - "formControlContext": { - "description": "Return value from the useFormControlContext hook." - }, - "getInputProps": { "description": "Resolver for the input slot's props." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "required": { - "description": "If true, the input will indicate that it's required." - }, - "value": { "description": "The value of the input element." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-menu-button/use-menu-button.json b/docs/translations/api-docs/use-menu-button/use-menu-button.json index 7de07f8245..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-menu-button/use-menu-button.json +++ b/docs/translations/api-docs/use-menu-button/use-menu-button.json @@ -1,15 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "disabled": { "description": "If true, the component is disabled." }, - "focusableWhenDisabled": { - "description": "If true, allows a disabled button to receive focus." - }, - "rootRef": { "description": "The ref to the root element." } - }, - "returnValueDescriptions": { - "active": { "description": "If true, the component is active (pressed)." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "rootRef": { "description": "The ref to the root element." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-menu-item/use-menu-item.json b/docs/translations/api-docs/use-menu-item/use-menu-item.json index 771ad3967e..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-menu-item/use-menu-item.json +++ b/docs/translations/api-docs/use-menu-item/use-menu-item.json @@ -1,19 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "disableFocusOnHover": { - "description": "If true, the menu item won't receive focus when the mouse moves over it." - } - }, - "returnValueDescriptions": { - "disabled": { "description": "If true, the component is disabled." }, - "focusVisible": { - "description": "If true, the component is being focused using keyboard." - }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "highlighted": { "description": "If true, the component is being highlighted." }, - "index": { "description": "0-based index of the item in the menu." }, - "rootRef": { "description": "The ref to the component's root DOM element." }, - "totalItemCount": { "description": "Total number of items in the menu." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-menu/use-menu.json b/docs/translations/api-docs/use-menu/use-menu.json index 07e143579e..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-menu/use-menu.json +++ b/docs/translations/api-docs/use-menu/use-menu.json @@ -1,32 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "autoFocus": { - "description": "If true (Default) will focus the highligted item. If you set this prop to false the focus will not be moved inside the Menu component. This has severe accessibility implications and should only be considered if you manage focus otherwise." - }, - "componentName": { - "description": "The name of the component using useMenu. For debugging purposes." - }, - "disabledItemsFocusable": { - "description": "If true, it will be possible to highlight disabled items." - }, - "disableListWrap": { - "description": "If true, the highlight will not wrap around the list if arrow keys are used." - }, - "id": { "description": "The id of the menu. If not provided, it will be generated." }, - "listboxRef": { "description": "The ref to the menu's listbox node." }, - "onItemsChange": { "description": "Callback fired when the menu items change." } - }, - "returnValueDescriptions": { - "contextValue": { "description": "The value to be passed into the MenuProvider." }, - "dispatch": { - "description": "Action dispatcher for the menu component. Allows to programmatically control the menu." - }, - "getListboxProps": { "description": "Resolver for the listbox slot's props." }, - "highlightedValue": { "description": "The highlighted option in the menu listbox." }, - "listboxRef": { "description": "The ref to the menu's listbox node." }, - "menuItems": { "description": "Items in the menu listbox." }, - "open": { "description": "If true, the menu is open." }, - "triggerElement": { "description": "An element that triggers the visibility of the menu." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-modal/use-modal.json b/docs/translations/api-docs/use-modal/use-modal.json index 4552414fc0..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-modal/use-modal.json +++ b/docs/translations/api-docs/use-modal/use-modal.json @@ -1,36 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "children": { "description": "A single child content element." }, - "closeAfterTransition": { - "description": "When set to true the Modal waits until a nested Transition is completed before closing." - }, - "container": { - "description": "An HTML element or function that returns one. The container will have the portal children appended to it.
You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time." - }, - "disableEscapeKeyDown": { - "description": "If true, hitting escape will not fire the onClose callback." - }, - "disableScrollLock": { "description": "Disable the scroll lock behavior." }, - "onClose": { - "description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose." - }, - "onTransitionEnter": { "description": "A function called when a transition enters." }, - "onTransitionExited": { "description": "A function called when a transition has exited." }, - "open": { "description": "If true, the component is shown." } - }, - "returnValueDescriptions": { - "exited": { - "description": "If true, the exiting transition finished (to be used for unmounting the component)." - }, - "getBackdropProps": { "description": "Resolver for the backdrop slot's props." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "getTransitionProps": { "description": "Resolver for the transition related props." }, - "hasTransition": { - "description": "If true, the component's child is transition component." - }, - "isTopModal": { "description": "If true, the modal is the top most one." }, - "portalRef": { "description": "A ref to the component's portal DOM element." }, - "rootRef": { "description": "A ref to the component's root DOM element." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-number-input/use-number-input.json b/docs/translations/api-docs/use-number-input/use-number-input.json index 6a2b9cfdbb..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-number-input/use-number-input.json +++ b/docs/translations/api-docs/use-number-input/use-number-input.json @@ -1,69 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "componentName": { - "description": "The name of the component using useNumberInput. For debugging purposes." - }, - "defaultValue": { - "description": "The default value. Use when the component is not controlled." - }, - "disabled": { - "description": "If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component." - }, - "error": { - "description": "If true, the input will indicate an error by setting the aria-invalid attribute. The prop defaults to the value (false) inherited from the parent FormControl component." - }, - "inputId": { "description": "The id attribute of the input element." }, - "inputRef": { "description": "The ref of the input element." }, - "max": { "description": "The maximum value." }, - "min": { "description": "The minimum value." }, - "onChange": { - "description": "Callback fired after the value is clamped and changes - when the input is blurred or when the stepper buttons are triggered. Called with undefined when the value is unset." - }, - "onInputChange": { - "description": "Callback fired when the input value changes after each keypress, before clamping is applied. Note that event.target.value may contain values that fall outside of min and max or are otherwise "invalid"." - }, - "readOnly": { - "description": "If true, the input element becomes read-only. The stepper buttons remain active, with the addition that they are now keyboard focusable." - }, - "required": { - "description": "If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component." - }, - "shiftMultiplier": { - "description": "Multiplier applied to step if the shift key is held while incrementing or decrementing the value. Defaults to 10." - }, - "step": { "description": "The amount that the value changes on each increment or decrement." }, - "value": { "description": "The current value. Use when the component is controlled." } - }, - "returnValueDescriptions": { - "disabled": { "description": "If true, the component will be disabled." }, - "error": { - "description": "If true, the input will indicate an error by setting the aria-invalid attribute." - }, - "focused": { "description": "If true, the input will be focused." }, - "formControlContext": { - "description": "Return value from the useFormControlContext hook." - }, - "getDecrementButtonProps": { - "description": "Resolver for the decrement button slot's props." - }, - "getIncrementButtonProps": { - "description": "Resolver for the increment button slot's props." - }, - "getInputProps": { "description": "Resolver for the input slot's props." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "inputValue": { - "description": "The dirty value of the input element when it is in focus." - }, - "isDecrementDisabled": { - "description": "If true, the decrement button will be disabled. e.g. when the value is already at min" - }, - "isIncrementDisabled": { - "description": "If true, the increment button will be disabled. e.g. when the value is already at max" - }, - "required": { - "description": "If true, the input will indicate that it's required." - }, - "value": { "description": "The clamped value of the input element." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-option/use-option.json b/docs/translations/api-docs/use-option/use-option.json index 07b5b62753..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-option/use-option.json +++ b/docs/translations/api-docs/use-option/use-option.json @@ -1,10 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": {}, - "returnValueDescriptions": { - "getRootProps": { "description": "Resolver for the root slot's props." }, - "highlighted": { "description": "If true, the option is highlighted." }, - "rootRef": { "description": "Ref to the root slot DOM node." }, - "selected": { "description": "If true, the option is selected." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-select/use-select.json b/docs/translations/api-docs/use-select/use-select.json index e9c367b813..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-select/use-select.json +++ b/docs/translations/api-docs/use-select/use-select.json @@ -1,73 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "areOptionsEqual": { - "description": "A function used to determine if two options' values are equal. By default, reference equality is used.
There is a performance impact when using the areOptionsEqual prop (proportional to the number of options). Therefore, it's recommented to use the default reference equality comparison whenever possible." - }, - "buttonRef": { "description": "The ref of the trigger button element." }, - "componentName": { - "description": "The name of the component using useSelect. For debugging purposes." - }, - "defaultOpen": { "description": "If true, the select will be open by default." }, - "defaultValue": { - "description": "The default selected value. Use when the component is not controlled." - }, - "disabled": { "description": "If true, the select is disabled." }, - "getOptionAsString": { - "description": "A function used to convert the option label to a string. This is useful when labels are elements and need to be converted to plain text to enable keyboard navigation with character keys." - }, - "getSerializedValue": { - "description": "A function to convert the currently selected value to a string. Used to set a value of a hidden input associated with the select, so that the selected value can be posted with a form." - }, - "listboxId": { "description": "The id attribute of the listbox element." }, - "listboxRef": { "description": "The ref of the listbox element." }, - "multiple": { - "description": "If true, the end user can select multiple values. This affects the type of the value, defaultValue, and onChange props." - }, - "name": { - "description": "The name attribute of the hidden input element. This is useful when the select is embedded in a form and you want to access the selected value in the form data." - }, - "onChange": { "description": "Callback fired when an option is selected." }, - "onHighlightChange": { "description": "Callback fired when an option is highlighted." }, - "onOpenChange": { "description": "Callback fired when the listbox is opened or closed." }, - "open": { - "description": "Controls the open state of the select's listbox. This is the controlled equivalent of the defaultOpen prop." - }, - "options": { - "description": "An alternative way to specify the options. If this parameter is set, options defined as JSX children are ignored." - }, - "required": { - "description": "If true, the select embedded in a form must have a selected value. Otherwise, the form submission will fail." - }, - "value": { - "description": "The selected value. Set to null to deselect all options." - } - }, - "returnValueDescriptions": { - "buttonActive": { - "description": "If true, the trigger button is active (pressed)." - }, - "buttonFocusVisible": { - "description": "If true, the trigger button has a visible focus." - }, - "buttonRef": { "description": "Ref to the button slot DOM node." }, - "contextValue": { - "description": "A value to be passed to the SelectProvider component." - }, - "disabled": { "description": "If true, the select is disabled." }, - "dispatch": { - "description": "Action dispatcher for the select component. Allows to programmatically control the select." - }, - "getButtonProps": { "description": "Resolver for the button slot's props." }, - "getHiddenInputProps": { "description": "Resolver for the hidden input slot's props." }, - "getListboxProps": { "description": "Resolver for the listbox slot's props." }, - "getOptionMetadata": { - "description": "A function that returns the metadata of an option with a given value." - }, - "highlightedOption": { "description": "The value of the highlighted option." }, - "listboxRef": { "description": "Ref to the listbox slot DOM node." }, - "open": { "description": "If true, the listbox is open." }, - "options": { "description": "Values of all the registered options." }, - "value": { "description": "The value of the selected option(s)." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-slider/use-slider.json b/docs/translations/api-docs/use-slider/use-slider.json index b155809ae0..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-slider/use-slider.json +++ b/docs/translations/api-docs/use-slider/use-slider.json @@ -1,73 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "aria-labelledby": { - "description": "The id of the element containing a label for the slider." - }, - "defaultValue": { - "description": "The default value. Use when the component is not controlled." - }, - "disabled": { "description": "If true, the component is disabled." }, - "disableSwap": { - "description": "If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb." - }, - "isRtl": { - "description": "If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side)." - }, - "marks": { - "description": "Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys." - }, - "max": { - "description": "The maximum allowed value of the slider. Should not be equal to min." - }, - "min": { - "description": "The minimum allowed value of the slider. Should not be equal to max." - }, - "name": { "description": "Name attribute of the hidden input element." }, - "onChange": { - "description": "Callback function that is fired when the slider's value changed." - }, - "onChangeCommitted": { - "description": "Callback function that is fired when the mouseup is triggered." - }, - "orientation": { "description": "The component orientation." }, - "rootRef": { "description": "The ref attached to the root of the Slider." }, - "scale": { "description": "A transformation function, to change the scale of the slider." }, - "shiftStep": { - "description": "The granularity with which the slider can step through values when using Page Up/Page Down or Shift + Arrow Up/Arrow Down." - }, - "step": { - "description": "The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.
When step is null, the thumb can only be slid onto marks provided with the marks prop." - }, - "tabIndex": { "description": "Tab index attribute of the hidden input element." }, - "value": { - "description": "The value of the slider. For ranged sliders, provide an array with two values." - } - }, - "returnValueDescriptions": { - "active": { "description": "The active index of the slider." }, - "axis": { "description": "The orientation of the slider." }, - "axisProps": { - "description": "Returns the offset and leap methods to calculate the positioning styles based on the slider axis." - }, - "dragging": { "description": "If true, the slider is being dragged." }, - "focusedThumbIndex": { - "description": "The index of the thumb which is focused on the slider." - }, - "getHiddenInputProps": { "description": "Resolver for the hidden input slot's props." }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "getThumbProps": { "description": "Resolver for the thumb slot's props." }, - "getThumbStyle": { "description": "Resolver for the thumb slot's style prop." }, - "marks": { - "description": "The marks of the slider. Marks indicate predetermined values to which the user can move the slider." - }, - "open": { "description": "The thumb index for the current value when in hover state." }, - "range": { - "description": "If true, the slider is a range slider when the value prop passed is an array." - }, - "rootRef": { "description": "Ref to the root slot's DOM node." }, - "trackLeap": { "description": "The track leap for the current value of the slider." }, - "trackOffset": { "description": "The track offset for the current value of the slider." }, - "values": { "description": "The possible values of the slider." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-snackbar/use-snackbar.json b/docs/translations/api-docs/use-snackbar/use-snackbar.json index eb9ec5d42c..3e597e6c05 100644 --- a/docs/translations/api-docs/use-snackbar/use-snackbar.json +++ b/docs/translations/api-docs/use-snackbar/use-snackbar.json @@ -1,24 +1,5 @@ { "hookDescription": "The basic building block for creating custom snackbar.", - "parametersDescriptions": { - "autoHideDuration": { - "description": "The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value." - }, - "disableWindowBlurListener": { - "description": "If true, the autoHideDuration timer will expire even if the window is not focused." - }, - "onClose": { - "description": "Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway." - }, - "open": { "description": "If true, the component is shown." }, - "resumeHideDuration": { - "description": "The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms." - } - }, - "returnValueDescriptions": { - "getRootProps": { "description": "Resolver for the root slot's props." }, - "onClickAway": { - "description": "Callback fired when a "click away" event is detected." - } - } + "parametersDescriptions": {}, + "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-tab-panel/use-tab-panel.json b/docs/translations/api-docs/use-tab-panel/use-tab-panel.json index 7f1a725f5f..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-tab-panel/use-tab-panel.json +++ b/docs/translations/api-docs/use-tab-panel/use-tab-panel.json @@ -1,16 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "id": { "description": "The id of the TabPanel." }, - "rootRef": { "description": "The ref of the TabPanel." }, - "value": { - "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected." - } - }, - "returnValueDescriptions": { - "getRootProps": { "description": "Resolver for the root slot's props." }, - "hidden": { - "description": "If true, it indicates that the tab panel will be hidden." - } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-tab/use-tab.json b/docs/translations/api-docs/use-tab/use-tab.json index 2325bf0016..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-tab/use-tab.json +++ b/docs/translations/api-docs/use-tab/use-tab.json @@ -1,34 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "disabled": { "description": "If true, the tab will be disabled." }, - "id": { - "description": "The id of the tab. If not provided, it will be automatically generated." - }, - "onChange": { "description": "If true, the tab will be disabled." }, - "onClick": { "description": "Callback fired when the tab is clicked." }, - "rootRef": { "description": "Ref to the root slot's DOM element." }, - "value": { - "description": "The value of the tab. It's used to associate the tab with a tab panel(s) with the same value. If the value is not provided, it falls back to the position index." - } - }, - "returnValueDescriptions": { - "active": { - "description": "If true, the tab is active (as in :active pseudo-class; in other words, pressed)." - }, - "focusVisible": { - "description": "If true, the tab has visible focus. This is a workaround for browsers that do not support this feature natively." - }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "highlighted": { "description": "If true, the tab is highlighted." }, - "index": { "description": "0-based index of the tab in the list of tabs." }, - "rootRef": { "description": "Ref to the root slot's DOM element." }, - "selected": { "description": "If true, the tab is selected." }, - "setFocusVisible": { - "description": "Sets the focus-visible state of the tab. This is a workaround for browsers that do not support this feature natively." - }, - "totalTabsCount": { - "description": "Total number of tabs in the nearest parent TabsList. This can be used to determine if the tab is the last one to style it accordingly." - } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-tabs-list/use-tabs-list.json b/docs/translations/api-docs/use-tabs-list/use-tabs-list.json index 3b0f1a3a19..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-tabs-list/use-tabs-list.json +++ b/docs/translations/api-docs/use-tabs-list/use-tabs-list.json @@ -1,19 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { "rootRef": { "description": "Ref to the root element." } }, - "returnValueDescriptions": { - "contextValue": { - "description": "The value to be passed to the TabListProvider above all the tabs." - }, - "dispatch": { - "description": "Action dispatcher for the tabs list component. Allows to programmatically control the tabs list." - }, - "getRootProps": { "description": "Resolver for the root slot's props." }, - "highlightedValue": { "description": "The value of the currently highlighted tab." }, - "isRtl": { - "description": "If true, it will indicate that the text's direction in right-to-left." - }, - "orientation": { "description": "The component orientation (layout flow direction)." }, - "selectedValue": { "description": "The value of the currently selected tab." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/api-docs/use-tabs/use-tabs.json b/docs/translations/api-docs/use-tabs/use-tabs.json index 6ff631febc..e3eb65c6e4 100644 --- a/docs/translations/api-docs/use-tabs/use-tabs.json +++ b/docs/translations/api-docs/use-tabs/use-tabs.json @@ -1,20 +1 @@ -{ - "hookDescription": "", - "parametersDescriptions": { - "defaultValue": { - "description": "The default value. Use when the component is not controlled." - }, - "direction": { "description": "The direction of the text." }, - "onChange": { "description": "Callback invoked when new value is being set." }, - "orientation": { "description": "The component orientation (layout flow direction)." }, - "selectionFollowsFocus": { - "description": "If true the selected tab changes on focus. Otherwise it only changes on activation." - }, - "value": { - "description": "The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to false." - } - }, - "returnValueDescriptions": { - "contextValue": { "description": "Returns the values to be passed to the tabs provider." } - } -} +{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} } diff --git a/docs/translations/translations.json b/docs/translations/translations.json index 979cd16d00..b737d5bdec 100644 --- a/docs/translations/translations.json +++ b/docs/translations/translations.json @@ -221,105 +221,9 @@ "/base-ui/react-": "Components", "/base-ui/all-components": "All components", "inputs": "Inputs", - "/base-ui/react-autocomplete": "Autocomplete", - "/base-ui/react-button": "Button", "/base-ui/react-checkbox": "Checkbox", - "/base-ui/react-input": "Input", "/base-ui/react-number-field": "Number Field", - "/base-ui/react-radio-group": "Radio Group", - "/base-ui/react-rating": "Rating", - "/base-ui/react-select": "Select", - "/base-ui/react-slider": "Slider", "/base-ui/react-switch": "Switch", - "/base-ui/react-toggle-button-group": "Toggle Button Group", - "data-display": "Data display", - "/base-ui/react-badge": "Badge", - "/base-ui/react-tooltip": "Tooltip", - "feedback": "Feedback", - "/base-ui/react-snackbar": "Snackbar", - "surfaces": "Surfaces", - "/base-ui/react-accordion": "Accordion", - "navigation": "Navigation", - "/base-ui/react-drawer": "Drawer", - "/base-ui/react-menu": "Menu", - "/base-ui/react-pagination": "Pagination", - "/base-ui/react-table-pagination": "Table Pagination", - "/base-ui/react-tabs": "Tabs", - "utils": "Utils", - "/base-ui/react-click-away-listener": "Click-Away Listener", - "/base-ui/react-focus-trap": "Focus Trap", - "/base-ui/react-form-control": "Form Control", - "/base-ui/react-modal": "Modal", - "/base-ui/react-no-ssr": "No-SSR", - "/base-ui/react-popper": "Popper", - "/base-ui/react-popup": "Popup", - "/base-ui/react-portal": "Portal", - "/base-ui/react-textarea-autosize": "Textarea Autosize", - "/base-ui/react-transitions": "Transitions", - "/base-ui/react-badge/components-api/#badge": "Badge", - "/base-ui/react-button/components-api/#button": "Button", - "/base-ui/react-checkbox/components-api/#checkbox-indicator": "CheckboxIndicator", - "/base-ui/react-checkbox/components-api/#checkbox-root": "CheckboxRoot", - "/base-ui/react-click-away-listener/components-api/#click-away-listener": "ClickAwayListener", - "/base-ui/react-transitions/components-api/#css-animation": "CssAnimation", - "/base-ui/react-transitions/components-api/#css-transition": "CssTransition", - "/base-ui/react-menu/components-api/#dropdown": "Dropdown", - "/base-ui/react-focus-trap/components-api/#focus-trap": "FocusTrap", - "/base-ui/react-form-control/components-api/#form-control": "FormControl", - "/base-ui/react-input/components-api/#input": "Input", - "/base-ui/react-menu/components-api/#menu": "Menu", - "/base-ui/react-menu/components-api/#menu-button": "MenuButton", - "/base-ui/react-menu/components-api/#menu-item": "MenuItem", - "/base-ui/react-modal/components-api/#modal": "Modal", - "/base-ui/react-no-ssr/components-api/#no-ssr": "NoSsr", - "/base-ui/react-number-field/components-api/#number-field-decrement": "NumberFieldDecrement", - "/base-ui/react-number-field/components-api/#number-field-group": "NumberFieldGroup", - "/base-ui/react-number-field/components-api/#number-field-increment": "NumberFieldIncrement", - "/base-ui/react-number-field/components-api/#number-field-input": "NumberFieldInput", - "/base-ui/react-number-field/components-api/#number-field-root": "NumberFieldRoot", - "/base-ui/react-number-field/components-api/#number-field-scrub-area": "NumberFieldScrubArea", - "/base-ui/react-number-field/components-api/#number-field-scrub-area-cursor": "NumberFieldScrubAreaCursor", - "/base-ui/react-select/components-api/#option": "Option", - "/base-ui/react-select/components-api/#option-group": "OptionGroup", - "/base-ui/react-popper/components-api/#popper": "Popper", - "/base-ui/react-popup/components-api/#popup": "Popup", - "/base-ui/react-portal/components-api/#portal": "Portal", - "/base-ui/react-select/components-api/#select": "Select", - "/base-ui/react-slider/components-api/#slider": "Slider", - "/base-ui/react-snackbar/components-api/#snackbar": "Snackbar", - "/base-ui/react-switch/components-api/#switch-root": "SwitchRoot", - "/base-ui/react-switch/components-api/#switch-thumb": "SwitchThumb", - "/base-ui/react-tabs/components-api/#tab": "Tab", - "/base-ui/react-tabs/components-api/#tab-panel": "TabPanel", - "/base-ui/react-table-pagination/components-api/#table-pagination": "TablePagination", - "/base-ui/react-tabs/components-api/#tabs": "Tabs", - "/base-ui/react-tabs/components-api/#tabs-list": "TabsList", - "/base-ui/react-textarea-autosize/components-api/#textarea-autosize": "TextareaAutosize", - "/base-ui/react-autocomplete/hooks-api/#use-autocomplete": "useAutocomplete", - "/base-ui/react-badge/hooks-api/#use-badge": "useBadge", - "/base-ui/react-button/hooks-api/#use-button": "useButton", - "/base-ui/react-checkbox/hooks-api/#use-checkbox": "useCheckbox", - "/base-ui/react-menu/hooks-api/#use-dropdown": "useDropdown", - "/base-ui/react-form-control/hooks-api/#use-form-control-context": "useFormControlContext", - "/base-ui/react-input/hooks-api/#use-input": "useInput", - "/base-ui/react-menu/hooks-api/#use-menu": "useMenu", - "/base-ui/react-menu/hooks-api/#use-menu-button": "useMenuButton", - "/base-ui/react-menu/hooks-api/#use-menu-item": "useMenuItem", - "/base-ui/react-menu/hooks-api/#use-menu-item-context-stabilizer": "useMenuItemContextStabilizer", - "/base-ui/react-modal/hooks-api/#use-modal": "useModal", - "/base-ui/react-number-field/hooks-api/#use-number-field": "useNumberField", - "/base-ui/react-select/hooks-api/#use-option": "useOption", - "/base-ui/react-select/hooks-api/#use-option-context-stabilizer": "useOptionContextStabilizer", - "/base-ui/react-select/hooks-api/#use-select": "useSelect", - "/base-ui/react-slider/hooks-api/#use-slider": "useSlider", - "/base-ui/react-snackbar/hooks-api/#use-snackbar": "useSnackbar", - "/base-ui/react-switch/hooks-api/#use-switch": "useSwitch", - "/base-ui/react-tabs/hooks-api/#use-tab": "useTab", - "/base-ui/react-tabs/hooks-api/#use-tab-panel": "useTabPanel", - "/base-ui/react-tabs/hooks-api/#use-tabs": "useTabs", - "/base-ui/react-tabs/hooks-api/#use-tabs-list": "useTabsList", - "/base-ui/react-transitions/hooks-api/#use-transition-state-manager": "useTransitionStateManager", - "/base-ui/react-transitions/hooks-api/#use-transition-trigger": "useTransitionTrigger", "/base-ui/guides": "How-to guides", "/base-ui/guides/working-with-tailwind-css": "Working with Tailwind CSS", "/base-ui/guides/overriding-component-structure": "Overriding component structure", diff --git a/packages/mui-base/package.json b/packages/mui-base/package.json index c68dea95aa..fb8773f2c7 100644 --- a/packages/mui-base/package.json +++ b/packages/mui-base/package.json @@ -83,5 +83,35 @@ }, "engines": { "node": ">=12.0.0" - } + }, + "files": [ + "Checkbox/", + "ClickAwayListener/", + "FocusTrap/", + "NoSsr/", + "Portal/", + "Switch/", + "Transitions/", + "useButton", + "useCheckbox/", + "useCompound", + "useList", + "useSwitch/", + "useTransition/", + "utils/", + "node/Checkbox/", + "node/ClickAwayListener/", + "node/FocusTrap/", + "node/NoSsr/", + "node/Portal/", + "node/Switch/", + "node/Transitions/", + "node/useButton", + "node/useCheckbox/", + "node/useCompound", + "node/useList", + "node/useSwitch/", + "node/utils/", + "node/useTransition/" + ] } diff --git a/packages/mui-base/src/index.ts b/packages/mui-base/src/index.ts index 5ffd3c8cc6..064fb47411 100644 --- a/packages/mui-base/src/index.ts +++ b/packages/mui-base/src/index.ts @@ -1,18 +1,4 @@ -export * from './utils'; -export * from './Badge'; -export * from './Button'; export { Root as CheckboxRoot, Indicator as CheckboxIndicator } from './Checkbox'; -export * from './ClickAwayListener'; -export * from './composeClasses'; -export * from './Dropdown'; -export * from './FocusTrap'; -export * from './FormControl'; -export * from './Input'; -export * from './Menu'; -export * from './MenuButton'; -export * from './MenuItem'; -export * from './Modal'; -export { NoSsr } from './NoSsr'; export { Root as NumberFieldRoot, Group as NumberFieldGroup, @@ -22,44 +8,7 @@ export { ScrubArea as NumberFieldScrubArea, ScrubAreaCursor as NumberFieldScrubAreaCursor, } from './NumberField'; -export * from './OptionGroup'; -export * from './Option'; -export * from './Popper'; -export * from './Unstable_Popup'; -export * from './Portal'; -export * from './Select'; -export * from './Slider'; -export * from './Snackbar'; export { Root as SwitchRoot, Thumb as SwitchThumb } from './Switch'; -export * from './TablePagination'; -export * from './TabPanel'; -export * from './TabsList'; -export * from './Tabs'; -export * from './Tab'; -export * from './TextareaAutosize'; -export * from './Transitions'; -export * from './useAutocomplete'; -export * from './useBadge'; -export * from './useButton'; export * from './useCheckbox'; -export * from './useDropdown'; -export * from './useInput'; -export * from './useMenu'; -export * from './useMenuButton'; -export * from './useMenuItem'; export * from './useNumberField'; -export * from './useOption'; -export * from './useSelect'; -export * from './useSlider'; -export * from './useSnackbar'; export * from './useSwitch'; -export * from './useTab'; -export * from './useTabPanel'; -export * from './useTabs'; -export * from './useTabsList'; -export * from './unstable_useModal'; - -export { - generateUtilityClass as unstable_generateUtilityClass, - isGlobalState as unstable_isGlobalState, -} from './generateUtilityClass';