Skip to content
Edit this page

Custom components

The date picker lets users select a date from a menu.

Overriding components

You can override the internal elements of the component (known as "slots") using the components prop.

Use the componentsProps prop if you need to pass additional props to a component slot.

As an example, you could override the ActionBar and pass additional props to the custom component as shown below:

<DatePicker
  {...otherProps}
  components={{
    // Override default <ActionBar /> with a custom one
    ActionBar: CustomActionBar,
  }}
  componentsProps={{
    // pass props `actions={['clear']}` to the actionBar slot
    actionBar: { actions: ['clear'] },
  }}
/>

Action bar

Component props

The action bar is available on all picker components. It is located at the bottom of the picker's views. By default, it contains no action on desktop, and the actions Cancel and Accept on mobile.

You can override the action displayed by passing the actions prop to the actionBar within componentsProps, as shown here:

<DatePicker
  componentsProps={{
    actionBar: {
      // The actions will be the same between desktop and mobile
      actions: ['clear'],

      // The actions will be different between desktop and mobile
      actions: (variant) => (variant === 'desktop' ? [] : ['clear']),
    },
  }}
/>

In the example below, the action bar contains only one button, which resets the selection to today's date:

Select date

Tue, Feb 1

SMTWTFS
<LocalizationProvider dateAdapter={AdapterDayjs}>
  <StaticDatePicker
    onChange={(newValue) => setValue(newValue)}
    value={value}
    renderInput={(params) => <TextField {...params} />}
    componentsProps={{
      actionBar: {
        actions: ['today'],
      },
    }}
  />
</LocalizationProvider>

Available actions

The built-in ActionBar component supports four different actions:

Action Behavior
accept Accept the current value and close the picker view
cancel Reset to the last accepted date and close the picker view
clear Reset to the empty value and close the picker view
today Reset to today's date (and time if relevant) and close the picker view

Component

If you need to customize the date picker beyond the options described above, you can provide a custom component. This can be used in combination with componentsProps.

In the example below, the actions are the same as in the section above, but they are rendered inside a menu:

Select date

Tue, Feb 1

SMTWTFS
<LocalizationProvider dateAdapter={AdapterDayjs}>
  <StaticDatePicker
    onChange={(newValue) => setValue(newValue)}
    value={value}
    renderInput={(params) => <TextField {...params} />}
    components={{
      ActionBar: CustomActionBar,
    }}
    componentsProps={{
      actionBar: {
        actions: ['today'],
      },
    }}
  />
</LocalizationProvider>

Paper content

The paper content is available on all desktop picker components. It adds a flexible way to extend what is rendered in the picker paper.

You can provide any custom component to this slot as long as it passes children down maintaining original picker behavior. In the examples below we provide ways of implementing date range shortcuts using this slot.

to
Date range shortcuts
October 2022
SMTWTFS
November 2022
SMTWTFS

Tabs

The tabs are available on all date time picker components. By default, it is hidden on desktop, and visible on mobile. This behavior can be overridden by setting hideTabs prop.

Component props

You can override the icons displayed by passing props to the tabs within componentsProps, as shown here:

<DateTimePicker
  componentsProps={{
    tabs: {
      dateRangeIcon: <LightModeIcon />,
      timeIcon: <AcUnitIcon />,
    },
  }}
/>

Component

If you need to customize the date time picker beyond the options described above, you can provide a custom component. This can be used in combination with componentsProps.

In the example below, the tabs are using different icons and have an additional component:

Arrow switcher

The following slots let you customize how to render the buttons and icons for an arrow switcher component—the component to navigate to the "Previous" and "Next" steps of the picker: PreviousIconButton, NextIconButton, LeftArrowIcon, RightArrowIcon.

Component props

You can pass props to the icons and buttons as shown below:

SMTWTFS

Component

You can pass custom components—to replace the icons, for example—as shown below:

SMTWTFS