Skip to contentSkip to navigationSkip to topbar
Paste
FigmaStar

Time Picker

Peer review pending

A Time Picker is a form element used to select a time.

Version 6.1.1
Github
Storybook

Installation

Installation page anchor
yarn add @twilio-paste/time-picker - or - yarn add @twilio-paste/core

Usage

Usage page anchor
import {TimePicker, formatReturnTime} from '@twilio-paste/core/time-picker';
import {Label} from '@twilio-paste/core/label';
import {HelpText} from '@twilio-paste/core/helptext';

const TimePickerExample = () => {
  return (
    <>
      <Label htmlFor="foo" required>
        Start time
      </Label>
      <TimePicker
        aria-describedby="foo_text"
        id="foo"
        name="foo"
        onChange={(evt) => formatReturnTime(evt.target.value, 'hh:mm aa')}
        required
      />
      <HelpText id="foo_text">Select a time.</HelpText>
    </>
  );
};

Props

Props page anchor

TimePicker

TimePicker page anchor

cursor

Type
| Cursor | (Cursor | null | undefined)[] | { [x: string]: Cursor | undefined; [x: number]: Cursor | undefined }

disabled

Disables the input.

Type
boolean

element

Overrides the default element name to apply unique styles with the Customization Provider.

Type
string
Default
TIMEPICKER

hasError

Sets the input to an error state.

Type
boolean

height

Type
never

i18nStepDownLabel

Provides an accessible label for the decrement button on inputs of type "number" when using non-English languages.

Type
string

i18nStepUpLabel

Provides an accessible label for the increment button on inputs of type "number" when using non-English languages.

Type
string

id

Sets the id of the input. Should match the htmlFor of Label.

Type
string

name

Sets the name of the input.

Type
string

padding

Type
"space0"

paddingRight

Type
"space0" | "space10" | "space20" | "space30" | "space40" | "space50" | "space60" | "space70" | "space80" | "space90" | "space100" | "space110" | "space120" | "space130" | "space140" | ... 27 more ... | { ...; }

placeholder

Sets the placeholder of the input.

Type
string

readOnly

Sets the input to readonly.

Type
boolean

required

Sets the input as required.

Type
boolean

size

Type
never

style

Type
never

value

Sets the value of the input.

Type
string

variant

Type
InputVariants

width

Type
never