static-time-picker.json

{
  "props": {
    "ampm": { "type": { "name": "bool" }, "default": "utils.is12HourCycleInCurrentLocale()" },
    "ampmInClock": { "type": { "name": "bool" }, "default": "true on desktop, false on mobile" },
    "autoFocus": { "type": { "name": "bool" } },
    "defaultValue": { "type": { "name": "object" } },
    "disabled": { "type": { "name": "bool" }, "default": "false" },
    "disableFuture": { "type": { "name": "bool" }, "default": "false" },
    "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" }, "default": "false" },
    "disablePast": { "type": { "name": "bool" }, "default": "false" },
    "displayStaticWrapperAs": {
      "type": { "name": "enum", "description": "'desktop'<br>&#124;&nbsp;'mobile'" },
      "default": "\"mobile\""
    },
    "localeText": { "type": { "name": "object" } },
    "maxTime": { "type": { "name": "object" } },
    "minTime": { "type": { "name": "object" } },
    "minutesStep": { "type": { "name": "number" }, "default": "1" },
    "onAccept": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(value: TValue, context: FieldChangeHandlerContext<TError>) => void",
        "describedArgs": ["value", "context"]
      }
    },
    "onChange": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(value: TValue, context: FieldChangeHandlerContext<TError>) => void",
        "describedArgs": ["value", "context"]
      }
    },
    "onClose": {
      "type": { "name": "func" },
      "deprecated": true,
      "deprecationInfo": "Please avoid using as it will be removed in next major version."
    },
    "onError": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(error: TError, value: TValue) => void",
        "describedArgs": ["error", "value"]
      }
    },
    "onViewChange": {
      "type": { "name": "func" },
      "signature": { "type": "function(view: TView) => void", "describedArgs": ["view"] }
    },
    "openTo": {
      "type": {
        "name": "enum",
        "description": "'hours'<br>&#124;&nbsp;'minutes'<br>&#124;&nbsp;'seconds'"
      }
    },
    "orientation": {
      "type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
    },
    "readOnly": { "type": { "name": "bool" }, "default": "false" },
    "reduceAnimations": {
      "type": { "name": "bool" },
      "default": "`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13"
    },
    "referenceDate": {
      "type": { "name": "object" },
      "default": "The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`."
    },
    "shouldDisableTime": {
      "type": { "name": "func" },
      "signature": {
        "type": "function(value: PickerValidDate, view: TimeView) => boolean",
        "describedArgs": ["value", "view"],
        "returned": "boolean"
      }
    },
    "slotProps": { "type": { "name": "object" }, "default": "{}" },
    "slots": {
      "type": { "name": "object" },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "sx": {
      "type": {
        "name": "union",
        "description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
      },
      "additionalInfo": { "sx": true }
    },
    "timezone": {
      "type": { "name": "string" },
      "default": "The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.",
      "seeMoreLink": {
        "url": "https://mui.com/x/react-date-pickers/timezone/",
        "text": "timezones documentation"
      }
    },
    "value": { "type": { "name": "object" } },
    "view": {
      "type": {
        "name": "enum",
        "description": "'hours'<br>&#124;&nbsp;'minutes'<br>&#124;&nbsp;'seconds'"
      }
    },
    "viewRenderers": {
      "type": { "name": "shape", "description": "{ hours?: func, minutes?: func, seconds?: func }" }
    },
    "views": {
      "type": {
        "name": "arrayOf",
        "description": "Array&lt;'hours'<br>&#124;&nbsp;'minutes'<br>&#124;&nbsp;'seconds'&gt;"
      }
    }
  },
  "name": "StaticTimePicker",
  "imports": [
    "import { StaticTimePicker } from '@mui/x-date-pickers/StaticTimePicker';",
    "import { StaticTimePicker } from '@mui/x-date-pickers';",
    "import { StaticTimePicker } from '@mui/x-date-pickers-pro';"
  ],
  "slots": [
    {
      "name": "actionBar",
      "description": "Custom component for the action bar, it is placed below the picker views.",
      "default": "PickersActionBar",
      "class": null
    },
    {
      "name": "layout",
      "description": "Custom component for wrapping the layout.\nIt wraps the toolbar, views, action bar, and shortcuts.",
      "class": null
    },
    {
      "name": "leftArrowIcon",
      "description": "Icon displayed in the left view switch button.",
      "default": "ArrowLeft",
      "class": null
    },
    {
      "name": "nextIconButton",
      "description": "Button allowing to switch to the right view.",
      "default": "IconButton",
      "class": null
    },
    {
      "name": "previousIconButton",
      "description": "Button allowing to switch to the left view.",
      "default": "IconButton",
      "class": null
    },
    {
      "name": "rightArrowIcon",
      "description": "Icon displayed in the right view switch button.",
      "default": "ArrowRight",
      "class": null
    },
    {
      "name": "shortcuts",
      "description": "Custom component for the shortcuts.",
      "default": "PickersShortcuts",
      "class": null
    },
    {
      "name": "toolbar",
      "description": "Custom component for the toolbar rendered above the views.",
      "default": "TimePickerToolbar",
      "class": null
    }
  ],
  "classes": [],
  "spread": false,
  "themeDefaultProps": false,
  "muiName": "MuiStaticTimePicker",
  "forwardsRefTo": "HTMLDivElement",
  "filename": "/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/x/react-date-pickers/time-picker/\">Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
  "cssComponent": false
}