nylas-time-window-picker

Overview

The nylas-time-window-picker component is a time picker that can be used to select a time.

Version1.3.6
Install (React)npm install @nylas/react
Import (React)import { NylasTimeWindowPicker } from '@nylas/react';
Import (CDN)You do not need to individually import the component, just import the parent component either nylas-scheduling or nylas-scheduler-editor.

Example


Properties

PropertyAttributeDescriptionTypeDefault
hasErrorThis sets the error state of the input.booleanfalse
languageThe language of the input.LANGUAGE_CODE.de | LANGUAGE_CODE.en | LANGUAGE_CODE.es | LANGUAGE_CODE.fr | LANGUAGE_CODE.ja | LANGUAGE_CODE.ko | LANGUAGE_CODE.nl | LANGUAGE_CODE.sv | LANGUAGE_CODE.zhLANGUAGE_CODE.en
minimumStartTimeThis is the start time value if one is set by the parent component. It is useful if this component is used to render an end time which should not be before the start time, defining the earliest selectable time.null | stringnull
name _(required)_The name of the input.stringundefined
placeholderThe placeholder text for the input.string'hh:mmam/pm'
time _(required)_The time to display in the input. This is passed by the parent componentstringundefined

Events

EventDescriptionType
timeChangeThis event is fired when the time is changed.CustomEvent<{ key: string; value: string; }>
timeWindowFormErrorThis event is fired when the form has an error. The parent component can listen for this event and display an error message or set form validity.CustomEvent<{ key: string; message: string; }>

Shadow Parts

PartDescription
"time-input"The time input
"time-picker"The time picker container
"times"The list of times

Graph


Built with StencilJS