Variable: muiEnUsComponentsDescriptions
muiEnUsComponentsDescriptions:
object
Type Declaration
categories
categories:
object
categories.dataDisplay
dataDisplay:
object
categories.dataDisplay.name
name:
string="Data display"
categories.feedback
feedback:
object
categories.feedback.name
name:
string="Feedback"
categories.form
form:
object
categories.form.name
name:
string="Form"
categories.inputs
inputs:
object
categories.inputs.name
name:
string="Inputs"
categories.layout
layout:
object
categories.layout.name
name:
string="Layout"
categories.navigation
navigation:
object
categories.navigation.name
name:
string="Navigation"
categories.surfaces
surfaces:
object
categories.surfaces.name
name:
string="Surfaces"
commonProperties
commonProperties:
object
commonProperties.checked
checked:
object
commonProperties.checked.description
description:
string="If true, the component is checked"
commonProperties.checked.name
name:
string="Checked"
commonProperties.children
children:
object
commonProperties.children.description
description:
string="The content of the component"
commonProperties.children.name
name:
string="Children"
commonProperties.color
color:
object
commonProperties.color.description
description:
string="The color of the component"
commonProperties.color.name
name:
string="Color"
commonProperties.defaultValue
defaultValue:
object
commonProperties.defaultValue.description
description:
string="The default value. Use when the component is not controlled"
commonProperties.defaultValue.name
name:
string="Default value"
commonProperties.dense
dense:
object
commonProperties.dense.description
description:
string="If true, reduces vertical padding"
commonProperties.dense.name
name:
string="Dense"
commonProperties.disabled
disabled:
object
commonProperties.disabled.description
description:
string="If true, the component is disabled"
commonProperties.disabled.name
name:
string="Disabled"
commonProperties.disableGutters
disableGutters:
object
commonProperties.disableGutters.description
description:
string="If true, disables the left and right padding"
commonProperties.disableGutters.name
name:
string="Disable gutters"
commonProperties.disablePadding
disablePadding:
object
commonProperties.disablePadding.description
description:
string="If true, disables the default padding"
commonProperties.disablePadding.name
name:
string="Disable padding"
commonProperties.error
error:
object
commonProperties.error.description
description:
string="If true, the component is displayed in an error state"
commonProperties.error.name
name:
string="Error"
commonProperties.fullWidth
fullWidth:
object
commonProperties.fullWidth.description
description:
string="If true, the component takes up the full width of its container"
commonProperties.fullWidth.name
name:
string="Full width"
commonProperties.gutterBottom
gutterBottom:
object
commonProperties.gutterBottom.description
description:
string="If true, the text will have a bottom margin"
commonProperties.gutterBottom.name
name:
string="Gutter bottom"
commonProperties.helperText
helperText:
object
commonProperties.helperText.description
description:
string="The helper text content"
commonProperties.helperText.name
name:
string="Helper text"
commonProperties.margin
margin:
object
commonProperties.margin.description
description:
string="Defines the margin applied to the component"
commonProperties.margin.name
name:
string="Margin"
commonProperties.noWrap
noWrap:
object
commonProperties.noWrap.description
description:
string="If true, the text will not wrap, but instead will truncate with a text overflow ellipsis"
commonProperties.noWrap.name
name:
string="No wrap"
commonProperties.onChange
onChange:
object
commonProperties.onChange.description
description:
string="Callback fired when the value is changed"
commonProperties.onChange.name
name:
string="onChange"
commonProperties.onClick
onClick:
object
commonProperties.onClick.description
description:
string="Callback fired when the component is clicked"
commonProperties.onClick.name
name:
string="onClick"
commonProperties.required
required:
object
commonProperties.required.description
description:
string="If true, the input element is required"
commonProperties.required.name
name:
string="Required"
commonProperties.size
size:
object
commonProperties.size.description
description:
string="The size of the component"
commonProperties.size.name
name:
string="Size"
commonProperties.sx
sx:
object
commonProperties.sx.description
description:
string="The system prop that allows defining system overrides as well as additional CSS styles"
commonProperties.sx.name
name:
string="Sx"
commonProperties.textAlign
textAlign:
object
commonProperties.textAlign.description
description:
string="Text alignment"
commonProperties.textAlign.name
name:
string="Alignment"
commonProperties.value
value:
object
commonProperties.value.description
description:
string="The value of the component"
commonProperties.value.name
name:
string="Value"
commonProperties.variant
variant:
object
commonProperties.variant.description
description:
string="The variant to use"
commonProperties.variant.name
name:
string="Variant"
components
components:
object
components.MuiBox
MuiBox:
object
components.MuiBox.description
description:
string="Generic layout container with system styling support"
components.MuiBox.name
name:
string="Box"
components.MuiBreadcrumbs
MuiBreadcrumbs:
object
components.MuiBreadcrumbs.description
description:
string="Shows the current page location within a hierarchy"
components.MuiBreadcrumbs.name
name:
string="Breadcrumbs"
components.MuiBreadcrumbs.props
props:
object
components.MuiBreadcrumbs.props.items
items:
object
components.MuiBreadcrumbs.props.items.description
description:
string="Breadcrumb items to display"
components.MuiBreadcrumbs.props.items.name
name:
string="Items"
components.MuiBreadcrumbs.props.itemsAfterCollapse
itemsAfterCollapse:
object
components.MuiBreadcrumbs.props.itemsAfterCollapse.description
description:
string="If max items is exceeded, the number of items to show after the ellipsis"
components.MuiBreadcrumbs.props.itemsAfterCollapse.name
name:
string="Items after collapse"
components.MuiBreadcrumbs.props.itemsBeforeCollapse
itemsBeforeCollapse:
object
components.MuiBreadcrumbs.props.itemsBeforeCollapse.description
description:
string="If max items is exceeded, the number of items to show before the ellipsis"
components.MuiBreadcrumbs.props.itemsBeforeCollapse.name
name:
string="Items before collapse"
components.MuiBreadcrumbs.props.maxItems
maxItems:
object
components.MuiBreadcrumbs.props.maxItems.description
description:
string="Specifies the maximum number of breadcrumbs to display"
components.MuiBreadcrumbs.props.maxItems.name
name:
string="Max items"
components.MuiBreadcrumbs.props.separator
separator:
object
components.MuiBreadcrumbs.props.separator.description
description:
string="Element used to separate breadcrumb items"
components.MuiBreadcrumbs.props.separator.name
name:
string="Separator"
components.MuiButton
MuiButton:
object
components.MuiButton.description
description:
string="A button component used to trigger actions or events"
components.MuiButton.name
name:
string="Button"
components.MuiButton.props
props:
object
components.MuiButton.props.children
children:
object
components.MuiButton.props.children.description
description:
string="The caption"
components.MuiButton.props.children.name
name:
string="Content"
components.MuiButton.props.disableElevation
disableElevation:
object
components.MuiButton.props.disableElevation.description
description:
string="Removes the button shadow when set to true"
components.MuiButton.props.disableElevation.name
name:
string="Disable elevation"
components.MuiButton.props.loading
loading:
object
components.MuiButton.props.loading.description
description:
string="Displays a loading indicator and disables interaction"
components.MuiButton.props.loading.name
name:
string="Loading"
components.MuiButtonGroup
MuiButtonGroup:
object
components.MuiButtonGroup.description
description:
string="Groups related buttons together"
components.MuiButtonGroup.name
name:
string="Button group"
components.MuiButtonGroup.props
props:
object
components.MuiButtonGroup.props.fullWidth
fullWidth:
object
components.MuiButtonGroup.props.fullWidth.description
description:
string="Makes the button group span the full container width"
components.MuiButtonGroup.props.fullWidth.name
name:
string="Full width"
components.MuiButtonGroup.props.orientation
orientation:
object
components.MuiButtonGroup.props.orientation.description
description:
string="Sets the layout direction of the buttons"
components.MuiButtonGroup.props.orientation.name
name:
string="Orientation"
components.MuiCard
MuiCard:
object
components.MuiCard.description
description:
string="Surface component for grouping related content"
components.MuiCard.name
name:
string="Card"
components.MuiCard.props
props:
object
components.MuiCard.props.actions
actions:
object
components.MuiCard.props.actions.description
description:
string="Action buttons or controls for the card"
components.MuiCard.props.actions.name
name:
string="Actions"
components.MuiCard.props.header
header:
object
components.MuiCard.props.header.description
description:
string="Content rendered in the card header"
components.MuiCard.props.header.name
name:
string="Header"
components.MuiCard.props.headerAction
headerAction:
object
components.MuiCard.props.headerAction.description
description:
string="Action element displayed in the header"
components.MuiCard.props.headerAction.name
name:
string="Header action"
components.MuiCard.props.headerAvatar
headerAvatar:
object
components.MuiCard.props.headerAvatar.description
description:
string="Avatar element displayed in the header"
components.MuiCard.props.headerAvatar.name
name:
string="Header avatar"
components.MuiCard.props.media
media:
object
components.MuiCard.props.media.description
description:
string="Media content such as an image or video"
components.MuiCard.props.media.name
name:
string="Media"
components.MuiCard.props.onSelect
onSelect:
object
components.MuiCard.props.onSelect.description
description:
string="Callback triggered when the card is selected"
components.MuiCard.props.onSelect.name
name:
string="onSelect"
components.MuiCard.props.subHeader
subHeader:
object
components.MuiCard.props.subHeader.description
description:
string="Secondary text displayed below the header"
components.MuiCard.props.subHeader.name
name:
string="Sub header"
components.MuiCard.props.useActions
useActions:
object
components.MuiCard.props.useActions.description
description:
string="Displays an actions section at the bottom"
components.MuiCard.props.useActions.name
name:
string="Use actions"
components.MuiCard.props.useCardActionArea
useCardActionArea:
object
components.MuiCard.props.useCardActionArea.description
description:
string="Wraps content with a clickable action area"
components.MuiCard.props.useCardActionArea.name
name:
string="Use card action area"
components.MuiCard.props.useHeader
useHeader:
object
components.MuiCard.props.useHeader.description
description:
string="Enables the card header section"
components.MuiCard.props.useHeader.name
name:
string="Use header"
components.MuiCard.props.useHeaderAction
useHeaderAction:
object
components.MuiCard.props.useHeaderAction.description
description:
string="Enables an action area inside the header"
components.MuiCard.props.useHeaderAction.name
name:
string="Use header action"
components.MuiCard.props.useHeaderAvatar
useHeaderAvatar:
object
components.MuiCard.props.useHeaderAvatar.description
description:
string="Displays an avatar inside the header"
components.MuiCard.props.useHeaderAvatar.name
name:
string="Use header avatar"
components.MuiCard.props.useMedia
useMedia:
object
components.MuiCard.props.useMedia.description
description:
string="Enables a media section inside the card"
components.MuiCard.props.useMedia.name
name:
string="Use media"
components.MuiCard.props.useSubheader
useSubheader:
object
components.MuiCard.props.useSubheader.description
description:
string="Displays a subheader below the main header"
components.MuiCard.props.useSubheader.name
name:
string="Use subheader"
components.MuiCheckbox
MuiCheckbox:
object
components.MuiCheckbox.description
description:
string="Allows selecting one or more options"
components.MuiCheckbox.name
name:
string="Checkbox"
components.MuiCheckbox.props
props:
object
components.MuiCheckbox.props.defaultChecked
defaultChecked:
object
components.MuiCheckbox.props.defaultChecked.description
description:
string="Initial checked state when uncontrolled"
components.MuiCheckbox.props.defaultChecked.name
name:
string="Default checked"
components.MuiCircularProgress
MuiCircularProgress:
object
components.MuiCircularProgress.description
description:
string="Indicates loading or progress in a circular form"
components.MuiCircularProgress.name
name:
string="Circular progress"
components.MuiCircularProgress.props
props:
object
components.MuiCircularProgress.props.disableShrink
disableShrink:
object
components.MuiCircularProgress.props.disableShrink.description
description:
string="Disables the shrink animation"
components.MuiCircularProgress.props.disableShrink.name
name:
string="Disable shrink"
components.MuiCircularProgress.props.thickness
thickness:
object
components.MuiCircularProgress.props.thickness.description
description:
string="Controls the stroke width of the circle"
components.MuiCircularProgress.props.thickness.name
name:
string="Thickness"
components.MuiContainer
MuiContainer:
object
components.MuiContainer.description
description:
string="Centers and constrains content horizontally"
components.MuiContainer.name
name:
string="Container"
components.MuiContainer.props
props:
object
components.MuiContainer.props.fixed
fixed:
object
components.MuiContainer.props.fixed.description
description:
string="Sets a fixed max width instead of a fluid one"
components.MuiContainer.props.fixed.name
name:
string="Fixed"
components.MuiContainer.props.maxWidth
maxWidth:
object
components.MuiContainer.props.maxWidth.description
description:
string="Defines the maximum width of the container"
components.MuiContainer.props.maxWidth.name
name:
string="Max width"
components.MuiDatePicker
MuiDatePicker:
object
components.MuiDatePicker.description
description:
string="Component for selecting a date"
components.MuiDatePicker.name
name:
string="Date picker"
components.MuiDatePicker.props
props:
object
components.MuiDatePicker.props.autoFocus
autoFocus:
object
components.MuiDatePicker.props.autoFocus.description
description:
string="If true, automatically focuses the date picker when the component mounts"
components.MuiDatePicker.props.autoFocus.name
name:
string="Auto focus"
components.MuiDatePicker.props.closeOnSelect
closeOnSelect:
object
components.MuiDatePicker.props.closeOnSelect.description
description:
string="Closes the date picker dialog automatically after a date is selected"
components.MuiDatePicker.props.closeOnSelect.name
name:
string="Close on select"
components.MuiDatePicker.props.desktopModeMediaQuery
desktopModeMediaQuery:
object
components.MuiDatePicker.props.desktopModeMediaQuery.description
description:
string="CSS media query string that determines when to switch to desktop mode layout"
components.MuiDatePicker.props.desktopModeMediaQuery.name
name:
string="Desktop mode media query"
components.MuiDatePicker.props.disableFuture
disableFuture:
object
components.MuiDatePicker.props.disableFuture.description
description:
string="If true, prevents selection of dates after the current date"
components.MuiDatePicker.props.disableFuture.name
name:
string="Disable future"
components.MuiDatePicker.props.disableHighlightToday
disableHighlightToday:
object
components.MuiDatePicker.props.disableHighlightToday.description
description:
string="If true, disables the visual highlighting of the current date in the calendar"
components.MuiDatePicker.props.disableHighlightToday.name
name:
string="Disable highlight today"
components.MuiDatePicker.props.disableOpenPicker
disableOpenPicker:
object
components.MuiDatePicker.props.disableOpenPicker.description
description:
string="If true, prevents opening the picker dialog (useful for read-only display)"
components.MuiDatePicker.props.disableOpenPicker.name
name:
string="Disable open picker"
components.MuiDatePicker.props.disablePast
disablePast:
object
components.MuiDatePicker.props.disablePast.description
description:
string="If true, prevents selection of dates before the current date"
components.MuiDatePicker.props.disablePast.name
name:
string="Disable past"
components.MuiDatePicker.props.displayWeekNumber
displayWeekNumber:
object
components.MuiDatePicker.props.displayWeekNumber.description
description:
string="Shows week numbers in the calendar view"
components.MuiDatePicker.props.displayWeekNumber.name
name:
string="Display week number"
components.MuiDatePicker.props.fixedWeekNumber
fixedWeekNumber:
object
components.MuiDatePicker.props.fixedWeekNumber.description
description:
string="Fixed number of weeks to display (forces consistent calendar height)"
components.MuiDatePicker.props.fixedWeekNumber.name
name:
string="Fixed week number"
components.MuiDatePicker.props.format
format:
object
components.MuiDatePicker.props.format.description
description:
string="Date format string used for display and parsing (e.g., 'yyyy-MM-dd', 'MM/dd/yyyy')"
components.MuiDatePicker.props.format.name
name:
string="Format"
components.MuiDatePicker.props.formatDensity
formatDensity:
object
components.MuiDatePicker.props.formatDensity.description
description:
string="Controls spacing in date formatting: dense (compact) or spacious (more spacing)"
components.MuiDatePicker.props.formatDensity.name
name:
string="Format density"
components.MuiDatePicker.props.loading
loading:
object
components.MuiDatePicker.props.loading.description
description:
string="If true, displays a loading spinner indicating data is being loaded"
components.MuiDatePicker.props.loading.name
name:
string="Loading"
components.MuiDatePicker.props.maxDate
maxDate:
object
components.MuiDatePicker.props.maxDate.description
description:
string="Latest date that can be selected (inclusive)"
components.MuiDatePicker.props.maxDate.name
name:
string="Max date"
components.MuiDatePicker.props.minDate
minDate:
object
components.MuiDatePicker.props.minDate.description
description:
string="Earliest date that can be selected (inclusive)"
components.MuiDatePicker.props.minDate.name
name:
string="Min date"
components.MuiDatePicker.props.monthsPerRow
monthsPerRow:
object
components.MuiDatePicker.props.monthsPerRow.description
description:
string="Number of month calendars to display per row in month/year views"
components.MuiDatePicker.props.monthsPerRow.name
name:
string="Months per row"
components.MuiDatePicker.props.name
name:
object
components.MuiDatePicker.props.name.description
description:
string="The name attribute for the form field, used when submitting forms"
components.MuiDatePicker.props.name.name
name:
string="Name"
components.MuiDatePicker.props.onAccept
onAccept:
object
components.MuiDatePicker.props.onAccept.description
description:
string="Callback fired when the value is accepted"
components.MuiDatePicker.props.onAccept.name
name:
string="onAccept"
components.MuiDatePicker.props.onClose
onClose:
object
components.MuiDatePicker.props.onClose.description
description:
string="Callback fired when the popup requests to be closed"
components.MuiDatePicker.props.onClose.name
name:
string="onClose"
components.MuiDatePicker.props.onError
onError:
object
components.MuiDatePicker.props.onError.description
description:
string="Callback fired when the error associated with the current value changes"
components.MuiDatePicker.props.onError.name
name:
string="onError"
components.MuiDatePicker.props.onMonthChange
onMonthChange:
object
components.MuiDatePicker.props.onMonthChange.description
description:
string="Callback fired on month change"
components.MuiDatePicker.props.onMonthChange.name
name:
string="onMonthChange"
components.MuiDatePicker.props.onOpen
onOpen:
object
components.MuiDatePicker.props.onOpen.description
description:
string="Callback fired when the popup requests to be opened"
components.MuiDatePicker.props.onOpen.name
name:
string="onOpen"
components.MuiDatePicker.props.onSelectedSectionsChange
onSelectedSectionsChange:
object
components.MuiDatePicker.props.onSelectedSectionsChange.description
description:
string="Callback fired when the selected sections change"
components.MuiDatePicker.props.onSelectedSectionsChange.name
name:
string="onSelectedSectionsChange"
components.MuiDatePicker.props.onViewChange
onViewChange:
object
components.MuiDatePicker.props.onViewChange.description
description:
string="Callback fired on view change"
components.MuiDatePicker.props.onViewChange.name
name:
string="onViewChange"
components.MuiDatePicker.props.onYearChange
onYearChange:
object
components.MuiDatePicker.props.onYearChange.description
description:
string="Callback fired on year change"
components.MuiDatePicker.props.onYearChange.name
name:
string="onYearChange"
components.MuiDatePicker.props.open
open:
object
components.MuiDatePicker.props.open.description
description:
string="If true, the date picker dialog is open; can be used for controlled state management"
components.MuiDatePicker.props.open.name
name:
string="Open"
components.MuiDatePicker.props.openTo
openTo:
object
components.MuiDatePicker.props.openTo.description
description:
string="The view to open when the picker is activated"
components.MuiDatePicker.props.openTo.name
name:
string="Open to"
components.MuiDatePicker.props.referenceDate
referenceDate:
object
components.MuiDatePicker.props.referenceDate.description
description:
string="Date used to generate the initial calendar view when no value is selected"
components.MuiDatePicker.props.referenceDate.name
name:
string="Reference date"
components.MuiDatePicker.props.showDaysOutsideCurrentMonth
showDaysOutsideCurrentMonth:
object
components.MuiDatePicker.props.showDaysOutsideCurrentMonth.description
description:
string="Displays days from the previous and next months in the current month view"
components.MuiDatePicker.props.showDaysOutsideCurrentMonth.name
name:
string="Show days outside current month"
components.MuiDatePicker.props.view
view:
object
components.MuiDatePicker.props.view.description
description:
string="The initial view to display (day, month, or year calendar)"
components.MuiDatePicker.props.view.name
name:
string="View"
components.MuiDatePicker.props.views
views:
object
components.MuiDatePicker.props.views.description
description:
string="The available views (day, month, and year calendar)"
components.MuiDatePicker.props.views.name
name:
string="Views"
components.MuiDatePicker.props.yearsOrder
yearsOrder:
object
components.MuiDatePicker.props.yearsOrder.description
description:
string="Sorting order of years: ascending (oldest first) or descending (newest first)"
components.MuiDatePicker.props.yearsOrder.name
name:
string="Years order"
components.MuiDatePicker.props.yearsPerRow
yearsPerRow:
object
components.MuiDatePicker.props.yearsPerRow.description
description:
string="Number of year items to display per row in year view"
components.MuiDatePicker.props.yearsPerRow.name
name:
string="Years per row"
components.MuiDialog
MuiDialog:
object
components.MuiDialog.description
description:
string="A modal dialog component that displays content in an overlay"
components.MuiDialog.name
name:
string="Dialog"
components.MuiDialog.props
props:
object
components.MuiDialog.props.disableEscapeKeyDown
disableEscapeKeyDown:
object
components.MuiDialog.props.disableEscapeKeyDown.description
description:
string="If true, pressing the escape key will not close the dialog"
components.MuiDialog.props.disableEscapeKeyDown.name
name:
string="Disable escape key down"
components.MuiDialog.props.fullScreen
fullScreen:
object
components.MuiDialog.props.fullScreen.description
description:
string="If true, the dialog will be full screen"
components.MuiDialog.props.fullScreen.name
name:
string="Full screen"
components.MuiDialog.props.fullWidth
fullWidth:
object
components.MuiDialog.props.fullWidth.description
description:
string="If true, the dialog stretches to maxWidth"
components.MuiDialog.props.fullWidth.name
name:
string="Full width"
components.MuiDialog.props.maxWidth
maxWidth:
object
components.MuiDialog.props.maxWidth.description
description:
string="Maximum width of the dialog (xs, sm, md, lg, xl)"
components.MuiDialog.props.maxWidth.name
name:
string="Max width"
components.MuiDialog.props.onClose
onClose:
object
components.MuiDialog.props.onClose.description
description:
string="Callback fired when the dialog is closing"
components.MuiDialog.props.onClose.name
name:
string="onClose"
components.MuiDialog.props.open
open:
object
components.MuiDialog.props.open.description
description:
string="If true, the dialog is open"
components.MuiDialog.props.open.name
name:
string="Open"
components.MuiDialog.props.scroll
scroll:
object
components.MuiDialog.props.scroll.description
description:
string="Determines the container for scrolling the dialog (paper or body)"
components.MuiDialog.props.scroll.name
name:
string="Scroll"
components.MuiDialogActions
MuiDialogActions:
object
components.MuiDialogActions.description
description:
string="Container for dialog action buttons"
components.MuiDialogActions.name
name:
string="Dialog actions"
components.MuiDialogActions.props
props:
object
components.MuiDialogActions.props.children
children:
object
components.MuiDialogActions.props.children.description
description:
string="The content of the component"
components.MuiDialogActions.props.children.name
name:
string="Children"
components.MuiDialogActions.props.disableSpacing
disableSpacing:
object
components.MuiDialogActions.props.disableSpacing.description
description:
string="If true, the actions do not have additional margin"
components.MuiDialogActions.props.disableSpacing.name
name:
string="Disable spacing"
components.MuiDialogContent
MuiDialogContent:
object
components.MuiDialogContent.description
description:
string="Main content area of a dialog"
components.MuiDialogContent.name
name:
string="Dialog content"
components.MuiDialogContent.props
props:
object
components.MuiDialogContent.props.children
children:
object
components.MuiDialogContent.props.children.description
description:
string="The content of the component"
components.MuiDialogContent.props.children.name
name:
string="Children"
components.MuiDialogContent.props.dividers
dividers:
object
components.MuiDialogContent.props.dividers.description
description:
string="If true, borders are added to the top and bottom of the dialog content"
components.MuiDialogContent.props.dividers.name
name:
string="Dividers"
components.MuiDialogContentText
MuiDialogContentText:
object
components.MuiDialogContentText.description
description:
string="Text content inside a dialog"
components.MuiDialogContentText.name
name:
string="Dialog content text"
components.MuiDialogContentText.props
props:
object
components.MuiDialogContentText.props.children
children:
object
components.MuiDialogContentText.props.children.description
description:
string="The text content"
components.MuiDialogContentText.props.children.name
name:
string="Content"
components.MuiDialogLayout
MuiDialogLayout:
object
components.MuiDialogLayout.description
description:
string="A preset dialog layout with title, content, and action buttons"
components.MuiDialogLayout.name
name:
string="Dialog layout"
components.MuiDialogTitle
MuiDialogTitle:
object
components.MuiDialogTitle.description
description:
string="Title of a dialog"
components.MuiDialogTitle.name
name:
string="Dialog title"
components.MuiDialogTitle.props
props:
object
components.MuiDialogTitle.props.children
children:
object
components.MuiDialogTitle.props.children.description
description:
string="The title text"
components.MuiDialogTitle.props.children.name
name:
string="Content"
components.MuiErrorWrapper
MuiErrorWrapper:
object
components.MuiErrorWrapper.description
description:
string="Wraps content and displays an error state or message"
components.MuiErrorWrapper.name
name:
string="Error wrapper"
components.MuiFormControlLabel
MuiFormControlLabel:
object
components.MuiFormControlLabel.description
description:
string="Associates a label with a form control"
components.MuiFormControlLabel.name
name:
string="Form control label"
components.MuiFormControlLabel.props
props:
object
components.MuiFormControlLabel.props.control
control:
object
components.MuiFormControlLabel.props.control.description
description:
string="Form control element (checkbox, radio, switch)"
components.MuiFormControlLabel.props.control.name
name:
string="Control"
components.MuiFormControlLabel.props.labelPlacement
labelPlacement:
object
components.MuiFormControlLabel.props.labelPlacement.description
description:
string="Position of the label relative to the control"
components.MuiFormControlLabel.props.labelPlacement.name
name:
string="Label placement"
components.MuiFormLabel
MuiFormLabel:
object
components.MuiFormLabel.description
description:
string="Label for grouping or describing form fields"
components.MuiFormLabel.name
name:
string="Form label"
components.MuiFormLabel.props
props:
object
components.MuiFormLabel.props.filled
filled:
object
components.MuiFormLabel.props.filled.description
description:
string="Applies the filled state styling"
components.MuiFormLabel.props.filled.name
name:
string="Filled"
components.MuiLinearProgress
MuiLinearProgress:
object
components.MuiLinearProgress.description
description:
string="Indicates loading or progress in a linear bar"
components.MuiLinearProgress.name
name:
string="Linear progress"
components.MuiLinearProgress.props
props:
object
components.MuiLinearProgress.props.valueBuffer
valueBuffer:
object
components.MuiLinearProgress.props.valueBuffer.description
description:
string="Secondary buffer value for buffered progress mode"
components.MuiLinearProgress.props.valueBuffer.name
name:
string="Value buffer"
components.MuiLink
MuiLink:
object
components.MuiLink.description
description:
string="Clickable element for navigation or actions"
components.MuiLink.name
name:
string="Link"
components.MuiLink.props
props:
object
components.MuiLink.props.href
href:
object
components.MuiLink.props.href.description
description:
string="Destination URL"
components.MuiLink.props.href.name
name:
string="Href"
components.MuiList
MuiList:
object
components.MuiList.description
description:
string="Displays a vertical list of items"
components.MuiList.name
name:
string="List"
components.MuiListItem
MuiListItem:
object
components.MuiListItem.description
description:
string="Represents a single item inside a list"
components.MuiListItem.name
name:
string="List item"
components.MuiListItem.props
props:
object
components.MuiListItem.props.divider
divider:
object
components.MuiListItem.props.divider.description
description:
string="Displays a divider below the list item"
components.MuiListItem.props.divider.name
name:
string="Divider"
components.MuiRadioGroup
MuiRadioGroup:
object
components.MuiRadioGroup.description
description:
string="Allows selecting a single option from a set"
components.MuiRadioGroup.name
name:
string="Radio group"
components.MuiRadioGroup.props
props:
object
components.MuiRadioGroup.props.name
name:
object
components.MuiRadioGroup.props.name.description
description:
string="Name attribute used to group radio buttons"
components.MuiRadioGroup.props.name.name
name:
string="Name"
components.MuiRadioGroup.props.row
row:
object
components.MuiRadioGroup.props.row.description
description:
string="Displays radio buttons horizontally"
components.MuiRadioGroup.props.row.name
name:
string="Row"
components.MuiRadioItem
MuiRadioItem:
object
components.MuiRadioItem.description
description:
string="A single radio button used within a radio group"
components.MuiRadioItem.name
name:
string="Radio item"
components.MuiSelect
MuiSelect:
object
components.MuiSelect.description
description:
string="Dropdown component for selecting options"
components.MuiSelect.name
name:
string="Select"
components.MuiSelect.props
props:
object
components.MuiSelect.props.autoFocus
autoFocus:
object
components.MuiSelect.props.autoFocus.description
description:
string="Automatically focuses the field on mount"
components.MuiSelect.props.autoFocus.name
name:
string="Auto focus"
components.MuiSelect.props.multiple
multiple:
object
components.MuiSelect.props.multiple.description
description:
string="Allows selecting multiple options"
components.MuiSelect.props.multiple.name
name:
string="Multiple"
components.MuiStack
MuiStack:
object
components.MuiStack.description
description:
string="Layouts children in a one-dimensional stack"
components.MuiStack.name
name:
string="Stack"
components.MuiStack.props
props:
object
components.MuiStack.props.alignItems
alignItems:
object
components.MuiStack.props.alignItems.description
description:
string="Controls cross-axis alignment"
components.MuiStack.props.alignItems.name
name:
string="Align items"
components.MuiStack.props.direction
direction:
object
components.MuiStack.props.direction.description
description:
string="Defines whether items are stacked in a row or column"
components.MuiStack.props.direction.name
name:
string="Direction"
components.MuiStack.props.flexWrap
flexWrap:
object
components.MuiStack.props.flexWrap.description
description:
string="Controls whether items wrap onto multiple lines"
components.MuiStack.props.flexWrap.name
name:
string="Flex wrap"
components.MuiStack.props.justifyContent
justifyContent:
object
components.MuiStack.props.justifyContent.description
description:
string="Controls main-axis alignment"
components.MuiStack.props.justifyContent.name
name:
string="Justify content"
components.MuiStack.props.spacing
spacing:
object
components.MuiStack.props.spacing.description
description:
string="Spacing between stacked items"
components.MuiStack.props.spacing.name
name:
string="Spacing"
components.MuiStack.props.useFlexGap
useFlexGap:
object
components.MuiStack.props.useFlexGap.description
description:
string="Uses CSS gap instead of margins for spacing"
components.MuiStack.props.useFlexGap.name
name:
string="Use flex gap"
components.MuiSwitch
MuiSwitch:
object
components.MuiSwitch.description
description:
string="Toggle control for switching between two states"
components.MuiSwitch.name
name:
string="Switch"
components.MuiSwitch.props
props:
object
components.MuiSwitch.props.defaultChecked
defaultChecked:
object
components.MuiSwitch.props.defaultChecked.description
description:
string="Initial toggle state when uncontrolled"
components.MuiSwitch.props.defaultChecked.name
name:
string="Default checked"
components.MuiTextField
MuiTextField:
object
components.MuiTextField.description
description:
string="Input field for text and form data"
components.MuiTextField.name
name:
string="Text field"
components.MuiTextField.props
props:
object
components.MuiTextField.props.autoFocus
autoFocus:
object
components.MuiTextField.props.autoFocus.description
description:
string="Automatically focuses the field on mount"
components.MuiTextField.props.autoFocus.name
name:
string="Auto focus"
components.MuiTextField.props.maxRows
maxRows:
object
components.MuiTextField.props.maxRows.description
description:
string="Maximum number of visible rows for multiline input"
components.MuiTextField.props.maxRows.name
name:
string="Max rows"
components.MuiTextField.props.multiline
multiline:
object
components.MuiTextField.props.multiline.description
description:
string="Renders a textarea instead of a single-line input"
components.MuiTextField.props.multiline.name
name:
string="Multiline"
components.MuiTextField.props.type
type:
object
components.MuiTextField.props.type.description
description:
string="HTML input type (text, password, email, etc.)"
components.MuiTextField.props.type.name
name:
string="Type"
components.MuiTooltip
MuiTooltip:
object
components.MuiTooltip.description
description:
string="Displays contextual information on hover, focus, or touch"
components.MuiTooltip.name
name:
string="Tooltip"
components.MuiTooltip.props
props:
object
components.MuiTooltip.props.arrow
arrow:
object
components.MuiTooltip.props.arrow.description
description:
string="Displays an arrow pointing to the target element"
components.MuiTooltip.props.arrow.name
name:
string="Arrow"
components.MuiTooltip.props.disableFocusListener
disableFocusListener:
object
components.MuiTooltip.props.disableFocusListener.description
description:
string="Prevents the tooltip from appearing on focus"
components.MuiTooltip.props.disableFocusListener.name
name:
string="Disable focus listener"
components.MuiTooltip.props.disableHoverListener
disableHoverListener:
object
components.MuiTooltip.props.disableHoverListener.description
description:
string="Prevents the tooltip from appearing on hover"
components.MuiTooltip.props.disableHoverListener.name
name:
string="Disable hover listener"
components.MuiTooltip.props.disableInteractive
disableInteractive:
object
components.MuiTooltip.props.disableInteractive.description
description:
string="Disables interaction with the tooltip content"
components.MuiTooltip.props.disableInteractive.name
name:
string="Disable interactive"
components.MuiTooltip.props.disableTouchListener
disableTouchListener:
object
components.MuiTooltip.props.disableTouchListener.description
description:
string="Prevents the tooltip from appearing on touch"
components.MuiTooltip.props.disableTouchListener.name
name:
string="Disable touch listener"
components.MuiTooltip.props.enterDelay
enterDelay:
object
components.MuiTooltip.props.enterDelay.description
description:
string="Delay in milliseconds before showing the tooltip"
components.MuiTooltip.props.enterDelay.name
name:
string="Enter delay"
components.MuiTooltip.props.followCursor
followCursor:
object
components.MuiTooltip.props.followCursor.description
description:
string="Makes the tooltip follow the cursor position"
components.MuiTooltip.props.followCursor.name
name:
string="Follow cursor"
components.MuiTooltip.props.leaveDelay
leaveDelay:
object
components.MuiTooltip.props.leaveDelay.description
description:
string="Delay in milliseconds before hiding the tooltip"
components.MuiTooltip.props.leaveDelay.name
name:
string="Leave delay"
components.MuiTooltip.props.title
title:
object
components.MuiTooltip.props.title.description
description:
string="Text content displayed inside the tooltip"
components.MuiTooltip.props.title.name
name:
string="Title"
components.MuiTypography
MuiTypography:
object
components.MuiTypography.description
description:
string="Displays text with predefined typography styles"
components.MuiTypography.name
name:
string="Typography"
components.MuiTypography.props
props:
object
components.MuiTypography.props.children
children:
object
components.MuiTypography.props.children.description
description:
string="The text content"
components.MuiTypography.props.children.name
name:
string="Content"
components.MuiUploader
MuiUploader:
object
components.MuiUploader.description
description:
string="Component for uploading one or more files"
components.MuiUploader.name
name:
string="Uploader"
components.MuiUploader.props
props:
object
components.MuiUploader.props.accept
accept:
object
components.MuiUploader.props.accept.description
description:
string= "Allowed file types (e.g. ".jpg,.png")"
components.MuiUploader.props.accept.name
name:
string="Accept"
components.MuiUploader.props.multiple
multiple:
object
components.MuiUploader.props.multiple.description
description:
string="Allows selecting multiple files"
components.MuiUploader.props.multiple.name
name:
string="Multiple"