kotlin-mui-base/mui.base

Package-level declarations

Types

AutocompleteChangeDetails

external interface AutocompleteChangeDetails<Value>

AutocompleteChangeReason

sealed external interface AutocompleteChangeReason

AutocompleteCloseReason

sealed external interface AutocompleteCloseReason

AutocompleteGroupedOption

external interface AutocompleteGroupedOption

AutocompleteHighlightChangeReason

sealed external interface AutocompleteHighlightChangeReason

AutocompleteInputChangeReason

sealed external interface AutocompleteInputChangeReason

sealed external interface Axis

sealed external interface BadgeClasses

external interface BadgeOwnProps : PropsWithChildren

external interface BadgeProps : BadgeOwnProps, HTMLAttributes<HTMLSpanElement>

external interface BadgeSlots

sealed external interface BlurOnSelect

BrowserAutofillAction

external interface BrowserAutofillAction<OptionValue>

external interface ButtonActions

sealed external interface ButtonClasses

ButtonClickAction

external interface ButtonClickAction

external interface ButtonOwnProps : UseButtonParameters, PropsWithChildren, PropsWithClassName

external interface ButtonProps : ButtonOwnProps, ButtonHTMLAttributes<HTMLButtonElement>

external interface ButtonSlots

ClickAwayListenerMouseEvent

sealed external interface ClickAwayListenerMouseEvent

ClickAwayListenerProps

external interface ClickAwayListenerProps : PropsWithChildren

ClickAwayListenerTouchEvent

sealed external interface ClickAwayListenerTouchEvent

CreateFilterOptionsConfig

external interface CreateFilterOptionsConfig<Value>

CssAnimationProps

external interface CssAnimationProps : PropsWithChildren, PropsWithClassName

CssTransitionProps

external interface CssTransitionProps : PropsWithChildren, PropsWithClassName

external interface DropdownProps : PropsWithChildren

FilterOptionsState

external interface FilterOptionsState<Value>

FocusManagementType

sealed external interface FocusManagementType

external interface FocusTrapProps : PropsWithChildren

FormControlClasses

sealed external interface FormControlClasses

FormControlOwnProps

external interface FormControlOwnProps : PropsWithChildren, PropsWithClassName

FormControlProps

external interface FormControlProps : FormControlOwnProps, HTMLAttributes<HTMLDivElement>

FormControlSlots

external interface FormControlSlots

external interface InputBaseProps : Props

sealed external interface InputClasses

external interface InputOwnProps : PropsWithClassName, InputBaseProps

external interface InputProps : InputOwnProps, HTMLAttributes<HTMLInputElement>

external interface InputSlots

ItemAriaLabelType

sealed external interface ItemAriaLabelType

LabelDisplayedRowsArgs

external interface LabelDisplayedRowsArgs

external interface ListItemState

external interface ListState<ItemValue>

external interface Mark

sealed external interface MatchFrom

external interface MenuActions

MenuButtonClasses

sealed external interface MenuButtonClasses

MenuButtonProps

external interface MenuButtonProps : PropsWithChildren, PropsWithClassName

MenuButtonSlots

external interface MenuButtonSlots

sealed external interface MenuClasses

MenuItemClasses

sealed external interface MenuItemClasses

MenuItemMetadata

external interface MenuItemMetadata

MenuItemOwnProps

external interface MenuItemOwnProps : PropsWithChildren, PropsWithClassName, LiHTMLAttributes<HTMLLIElement>

external interface MenuItemProps : MenuItemOwnProps, LiHTMLAttributes<HTMLLIElement>

external interface MenuItemSlots

external interface MenuItemState

external interface MenuOwnProps : PropsWithChildren, PropsWithClassName

external interface MenuProps : MenuOwnProps, HTMLAttributes<HTMLDivElement>

external interface MenuSlots

ModalBackdropSlotProps

external interface ModalBackdropSlotProps : PropsWithChildren

sealed external interface ModalClasses

external interface ModalOwnProps : PropsWithChildren

external interface ModalProps : ModalOwnProps, HTMLAttributes<HTMLDivElement>

ModalRootSlotProps

external interface ModalRootSlotProps : PropsWithChildren, PropsWithClassName

external interface ModalSlots

NativeFormControlElement

typealias NativeFormControlElement = HTMLElement

external interface NoSsrProps : PropsWithChildren

sealed external interface OptionClasses

OptionGroupClasses

sealed external interface OptionGroupClasses

OptionGroupOwnProps

external interface OptionGroupOwnProps : PropsWithChildren, PropsWithClassName

OptionGroupProps

external interface OptionGroupProps : OptionGroupOwnProps, LiHTMLAttributes<HTMLLIElement>

OptionGroupSlots

external interface OptionGroupSlots

external interface OptionOwnProps<OptionValue> : PropsWithChildren, PropsWithClassName

external interface OptionProps<OptionValue> : OptionOwnProps<OptionValue>

external interface OptionSlots

sealed external interface Orientation

PopperChildrenProps

external interface PopperChildrenProps : Props

sealed external interface PopperClasses

PopperDirection

sealed external interface PopperDirection

external interface PopperOwnProps : Props

external interface PopperProps : PopperOwnProps, HTMLAttributes<HTMLDivElement>

PopperRootSlotProps

external interface PopperRootSlotProps : PropsWithClassName

external interface PopperSlots

PopperTransitionProps

external interface PopperTransitionProps : Props

external interface PortalProps : PropsWithChildren

sealed external interface SelectClasses

SelectInternalState

external interface SelectInternalState

sealed external interface SelectionMode

external interface SelectOption<Value>

SelectOptionDefinition

external interface SelectOptionDefinition<Value>

external interface SelectOwnProps<OptionValue> : PropsWithChildren, PropsWithClassName

external interface SelectProps<OptionValue> : SelectOwnProps<OptionValue>

external interface SelectSlots

sealed external interface SliderClasses

external interface SliderOwnProps : UseSliderParameters

external interface SliderProps : SliderOwnProps, HTMLAttributes<HTMLSpanElement>

external interface SliderSlots

SliderThumbSlotState

external interface SliderThumbSlotState

SnackbarClasses

sealed external interface SnackbarClasses

SnackbarClickAwayListenerSlotProps

external interface SnackbarClickAwayListenerSlotProps : Props

SnackbarCloseReason

sealed external interface SnackbarCloseReason

SnackbarOwnProps

external interface SnackbarOwnProps : UseSnackbarParameters, PropsWithChildren

external interface SnackbarProps : SnackbarOwnProps, HTMLAttributes<HTMLDivElement>

external interface SnackbarSlots

sealed external interface SwitchClasses

external interface SwitchOwnProps : PropsWithClassName

external interface SwitchProps : SwitchOwnProps, HTMLAttributes<HTMLSpanElement>

external interface SwitchSlots

sealed external interface TabClasses

TablePaginationClasses

sealed external interface TablePaginationClasses

TablePaginationOwnProps

external interface TablePaginationOwnProps : Props

TablePaginationProps

external interface TablePaginationProps : TablePaginationOwnProps, HTMLAttributes<HTMLTableCellElement>

TablePaginationSlots

external interface TablePaginationSlots

external interface TabMetadata

external interface TabOwnProps : ButtonOwnProps, ButtonHTMLAttributes<HTMLButtonElement>

TabPanelClasses

sealed external interface TabPanelClasses

TabPanelOwnProps

external interface TabPanelOwnProps : PropsWithChildren, PropsWithClassName

external interface TabPanelProps : TabPanelOwnProps, HTMLAttributes<HTMLDivElement>

external interface TabPanelSlots

external interface TabProps : TabOwnProps, ButtonHTMLAttributes<HTMLButtonElement>

sealed external interface TabsClasses

TabsListClasses

sealed external interface TabsListClasses

TabsListOwnProps

external interface TabsListOwnProps : PropsWithChildren, PropsWithClassName

external interface TabsListProps : TabsListOwnProps, HTMLAttributes<HTMLDivElement>

external interface TabsListSlots

external interface TabSlots

external interface TabsOwnProps : PropsWithChildren, PropsWithClassName

external interface TabsProps : TabsOwnProps, HTMLAttributes<HTMLDivElement>

external interface TabsSlots

TextareaAutosizeProps

external interface TextareaAutosizeProps : TextareaHTMLAttributes<HTMLTextAreaElement>

UseAutocompleteProps

external interface UseAutocompleteProps<Value> : Props

UseAutocompleteRenderedOption

external interface UseAutocompleteRenderedOption<Value>

UseAutocompleteReturnValue

external interface UseAutocompleteReturnValue<Value>

UseBadgeParameters

external interface UseBadgeParameters

UseBadgeReturnValue

external interface UseBadgeReturnValue

UseButtonParameters

external interface UseButtonParameters

UseButtonReturnValue

external interface UseButtonReturnValue

UseButtonRootSlotOwnProps

external interface UseButtonRootSlotOwnProps : Props

UseDropdownParameters

external interface UseDropdownParameters

UseDropdownReturnValue

external interface UseDropdownReturnValue

UseInputInputSlotOwnProps

external interface UseInputInputSlotOwnProps : Props

UseInputParameters

external interface UseInputParameters

UseInputReturnValue

external interface UseInputReturnValue

UseInputRootSlotOwnProps

external interface UseInputRootSlotOwnProps : Props

UseListParameters

external interface UseListParameters<ItemValue, State, CustomAction, CustomActionContext>

UseListReturnValue

external interface UseListReturnValue

UseMenuButtonParameters

external interface UseMenuButtonParameters

UseMenuButtonReturnValue

external interface UseMenuButtonReturnValue

UseMenuItemParameters

external interface UseMenuItemParameters

UseMenuItemReturnValue

external interface UseMenuItemReturnValue

UseMenuParameters

external interface UseMenuParameters

UseMenuReturnValue

external interface UseMenuReturnValue

UseOptionParameters

external interface UseOptionParameters<Value>

UseOptionReturnValue

external interface UseOptionReturnValue

UseSelectParameters

external interface UseSelectParameters<OptionValue, Multiple>

UseSelectReturnValue

external interface UseSelectReturnValue<Value, Multiple>

UseSliderParameters

external interface UseSliderParameters

UseSliderReturnValue

external interface UseSliderReturnValue

UseSnackbarParameters

external interface UseSnackbarParameters

UseSnackbarReturnValue

external interface UseSnackbarReturnValue

UseSnackbarRootSlotOwnProps

external interface UseSnackbarRootSlotOwnProps : Props

UseSwitchParameters

external interface UseSwitchParameters

UseSwitchReturnValue

external interface UseSwitchReturnValue

UseTabPanelParameters

external interface UseTabPanelParameters

UseTabPanelReturnValue

external interface UseTabPanelReturnValue

UseTabParameters

external interface UseTabParameters

UseTabReturnValue

external interface UseTabReturnValue

useTabsDirection

sealed external interface useTabsDirection

UseTabsListParameters

external interface UseTabsListParameters

UseTabsListReturnValue

external interface UseTabsListReturnValue

UseTabsParameters

external interface UseTabsParameters

UseTabsReturnValue

external interface UseTabsReturnValue

ValueChangeAction

external interface ValueChangeAction

Properties

external val Badge: FC<BadgeProps>

Demos:

external val badgeClasses: BadgeClasses

external val Button: FC<ButtonProps>

The foundation for building custom-styled buttons.

external val buttonClasses: ButtonClasses

ClickAwayListener

external val ClickAwayListener: FC<ClickAwayListenerProps>

Listen for click events that occur somewhere in the document, outside of the element itself. For instance, if you need to hide a menu when people click anywhere else on your page.

external val CssAnimation: FC<CssAnimationProps>

Demos:

external val CssTransition: FC<CssTransitionProps>

A utility component that hooks up to the Base UI transitions API and applies a CSS transition to its children when necessary.

external val Dropdown: FC<DropdownProps>

Demos:

external val FocusTrap: FC<FocusTrapProps>

Utility component that locks focus inside the component.

external val FormControl: FC<FormControlProps>

Provides context such as filled/focused/error/required for form inputs. Relying on the context provides high flexibility and ensures that the state always stays consistent across the children of the FormControl. This context is used by the following components:

formControlClasses

external val formControlClasses: FormControlClasses

external val Input: FC<InputProps>

Demos:

external val inputClasses: InputClasses

external val Menu: FC<MenuProps>

Demos:

external val MenuButton: FC<MenuButtonProps>

Demos:

menuButtonClasses

external val menuButtonClasses: MenuButtonClasses

external val menuClasses: MenuClasses

external val MenuItem: FC<MenuItemProps>

An unstyled menu item to be used within a Menu.

menuItemClasses

external val menuItemClasses: MenuItemClasses

external val Modal: FC<ModalProps>

Modal is a lower-level construct that is leveraged by the following components:

external val modalClasses: ModalClasses

external val NoSsr: FC<NoSsrProps>

NoSsr purposely removes components from the subject of Server Side Rendering (SSR).

external val Option: FC<OptionProps<*>>

An unstyled option to be used within a Select.

external val optionClasses: OptionClasses

external val OptionGroup: FC<OptionGroupProps>

An unstyled option group to be used within a Select.

optionGroupClasses

external val optionGroupClasses: OptionGroupClasses

external val Popper: FC<PopperProps>

Poppers rely on the 3rd party library Popper.js for positioning.

external val popperClasses: PopperClasses

external val Portal: FC<PortalProps>

Portals provide a first-class way to render children into a DOM node that exists outside the DOM hierarchy of the parent component.

external val Select: FC<SelectProps<*>>

The foundation for building custom-styled select components.

external val selectClasses: SelectClasses

external val Slider: FC<SliderProps>

Demos:

external val sliderClasses: SliderClasses

external val Snackbar: FC<SnackbarProps>

Demos:

snackbarClasses

external val snackbarClasses: SnackbarClasses

external val Switch: FC<SwitchProps>

The foundation for building custom-styled switches.

external val switchClasses: SwitchClasses

external val Tab: FC<TabProps>

Demos:

external val tabClasses: TabClasses

TablePagination

external val TablePagination: FC<TablePaginationProps>

A pagination for tables.

tablePaginationClasses

external val tablePaginationClasses: TablePaginationClasses

external val TabPanel: FC<TabPanelProps>

Demos:

tabPanelClasses

external val tabPanelClasses: TabPanelClasses

external val Tabs: FC<TabsProps>

Demos:

external val tabsClasses: TabsClasses

external val TabsList: FC<TabsListProps>

Demos:

tabsListClasses

external val tabsListClasses: TabsListClasses

TextareaAutosize

external val TextareaAutosize: FC<TextareaAutosizeProps>

Demos:

Functions

external fun useBadge(parameters: UseBadgeParameters): UseBadgeReturnValue

external fun useButton(parameters: UseButtonParameters? = definedExternally): UseButtonReturnValue

external fun useInput(parameters: UseInputParameters? = definedExternally): UseInputReturnValue

external fun useMenu(parameters: UseMenuParameters? = definedExternally): UseMenuReturnValue

external fun useMenuButton(parameters: UseMenuButtonParameters? = definedExternally): UseMenuButtonReturnValue

external fun useMenuItem(params: UseMenuItemParameters): UseMenuItemReturnValue

external fun <Value> useOption(params: UseOptionParameters<Value>): UseOptionReturnValue

external fun <OptionValue, Multiple> useSelect(props: UseSelectParameters<OptionValue, Multiple>): UseSelectReturnValue<OptionValue, Multiple>

external fun useSlider(parameters: UseSliderParameters): UseSliderReturnValue

external fun useSnackbar(parameters: UseSnackbarParameters? = definedExternally): UseSnackbarReturnValue

external fun useSwitch(props: UseSwitchParameters): UseSwitchReturnValue

external fun useTab(parameters: UseTabParameters): UseTabReturnValue

external fun useTabPanel(parameters: UseTabPanelParameters): UseTabPanelReturnValue

external fun useTabsList(parameters: UseTabsListParameters): UseTabsListReturnValue