Skip to content

TimePickerToolbar API

API reference docs for the React TimePickerToolbar component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

    Import

    import TimePickerToolbar from '/packages/x-date-pickers/src/TimePicker/TimePickerToolbar.tsx/TimePickerToolbar';
    // or
    import { TimePickerToolbar } from '/packages/x-date-pickers/src/TimePicker/TimePickerToolbar.tsx';
    Learn about the difference by reading this guide on minimizing bundle size.

    Props

    onViewChangeRequired

    Callback called when a toolbar is clicked

    Type:

    func

    Signature:

    function(view: TView) => void
    • view The view to open

    viewRequired

    Currently visible picker view.

    Type:

    'hours' | 'meridiem' | 'minutes' | 'seconds'

    className

    className applied to the root component.

    Type:

    string

    hidden

    If true, show the toolbar even in desktop mode.

    Type:

    bool

    Default:

    `true` for Desktop, `false` for Mobile.

    toolbarFormat

    Toolbar date format.

    Type:

    string

    toolbarPlaceholder

    Toolbar value placeholder—it is displayed when the value is empty.

    Type:

    node

    Default:

    "––"

    The component cannot hold a ref.

    CSS

    The following class names are useful for styling with CSS (the state classes are marked).
    To learn more, visit the component customization page.


    .MuiTimePickerToolbar-rootroot


    .MuiTimePickerToolbar-separatorseparator


    .MuiTimePickerToolbar-hourMinuteLabelhourMinuteLabel


    .MuiTimePickerToolbar-hourMinuteLabelLandscapehourMinuteLabelLandscape


    .MuiTimePickerToolbar-hourMinuteLabelReversehourMinuteLabelReverse


    .MuiTimePickerToolbar-ampmSelectionampmSelection


    .MuiTimePickerToolbar-ampmLandscapeampmLandscape


    .MuiTimePickerToolbar-ampmLabelampmLabel


    You can override the style of the component using one of these customization options: