TimePicker

TYPESCRIPT / BROWSER

Live TypeScript example

Try the component here, then use the source below in your application.

Component sizev0.9.0 · minified + gzip

JavaScript: 9.0 KiB
Component CSS: 2.0 KiB
Shared theme CSS: 3.8 KiBonce per application

How sizes are measured

The JavaScript figure includes this component’s required helpers. CSS includes its styling dependencies. Each entry is bundled separately for ES2022, minified, then compressed with gzip level 9. Your bundler may share helpers across components. Images, fonts, examples and application code are excluded.

Before compression: JavaScript 25.7 KiB; component CSS 8.0 KiB. These figures describe browser assets, not the complete package download.

View all component measurements →

Preview

Type a time or use the hour and minute controls. The interval and 12/24-hour display are configurable.

import '@blukavantui/web/theme.css'

import {createTimePicker} from '@blukavantui/web/time-picker';
import '@blukavantui/web/time-picker.css';
export function mount(host:HTMLElement){
  const output=document.createElement("p");output.setAttribute("role","status");host.append(output);
  const picker=createTimePicker(host,{
  "Value": "09:00",
  "Label": "Appointment time",
  "IsDisabled": false,
  "IsReadOnly": false,
  "IsRequired": false,
  "Placeholder": "",
  "ShowClear": true,
  "Min": "",
  "Max": "",
  "HourCycle": 12,
  "MinuteStep": 15,
  "ExtendedClass": ""
}, {
    Change:(value)=>{output.textContent=value||"Selection cleared";},
    ValidationChanged:(valid,message)=>{if(!valid)output.textContent=message;},
  });
  return {destroy(){picker.destroy();output.remove();}};
}

const instance = mount(document.getElementById('example')!)

// When this page or framework component is removed:
// instance.destroy()

Install the library and add the host element

npm install https://blukavantui.blutekmedia.com/downloads/blukavantui-web-0.9.0.tgz

<div id="example"></div>

Download .ts source ↓TypeScript interfaces →Web API reference →Installation guide →

Download TypeScript library · 2984.5 KiB ↓Download starter project · 5191.1 KiB ↓

Connect your application data

This example uses the downloadable @blukavantui/web package. Your application handles persistence and authentication through its typed callbacks. The starter ZIP includes this same example.

Build on your platform

Choose the reference that matches your application.

WEB · TYPESCRIPT

createTimePicker

Values use local HH:mm. HourCycle controls 12/24-hour presentation; 12-hour typing requires AM or PM. MinuteStep changes offered choices, and typed off-interval minutes remain valid. No timezone conversion occurs.

v0.9.0

import { createTimePicker } from '@blukavantui/web/time-picker';
import '@blukavantui/web/time-picker.css';

Load @blukavantui/web/theme.css once in your app shell.

createTimePicker(host: HTMLElement, options?: TimePickerOptions, events?: PickerEvents)

Reference for @blukavantui/web 0.9.0. Required and optional follow the shipped TypeScript declarations; optional does not imply a particular default. Pass typed arrays and objects directly where shown.

Options

Name	Type / requirement	Usage
`Value`	`string`Optional	YYYY-MM-DD for DatePicker, HH:mm for TimePicker, YYYY-MM-DDTHH:mm for DateTimePicker. Empty means no selection.
`Label`	`string`Optional	Visible input label and dialog name.
`IsDisabled`	`boolean`Optional	Disables editing and opening.
`IsReadOnly`	`boolean`Optional	Keeps values readable and selectable without editing.
`IsRequired`	`boolean`Optional	Rejects an empty value after interaction.
`Placeholder`	`string`Optional	Optional input placeholder; does not replace the label.
`ShowClear`	`boolean`Optional	Show an explicit Clear action.
`Min`	`string`Optional	Inclusive bounds, in the same stored format as Value.
`Max`	`string`Optional	Inclusive maximum ISO value.
`ExtendedClass`	`string`Optional	Additional classes on the component wrapper.
`HourCycle`	`12 \| 24`Optional	12 or 24-hour display. Values always use HH:mm.
`MinuteStep`	`number`Optional	1–60. Controls offered minute choices; typed off-interval values are preserved.

Callbacks

Name	Type / requirement	Usage
`Change`	`(value: string) => void \| Promise<void>`Optional	Reports Updated ISO value; empty when cleared.
`ValidationChanged`	`(isValid: boolean, message: string) => void \| Promise<void>`Optional	Reports Whether the current entered value is valid., Associated validation guidance.
`OpenChanged`	`(isOpen: boolean) => void \| Promise<void>`Optional	Reports Whether the selection dialog is open.
`Error`	`(message: string) => void \| Promise<void>`Optional	Reports Configuration or runtime error.

Instance methods & properties

Name	Signature / type	Usage
`element`	`HTMLElement`	Root owned by this instance. Dispose before removing its host.
`update`	`(patch: Partial<TimePickerOptions>) => void`	Apply a partial options update to this instance.
`destroy`	`() => void`	Dispose the instance and its listeners when the view is removed.

Related data types

Expand a type for its fields and allowed values.

Callback

type Callback<T extends unknown[] = []> = (...args: T) => void | Promise<void>;

ClockOptions

interface ClockOptions {
    HourCycle?: 12 | 24;
    /** 1–60. Controls offered minute choices; typed off-interval values are preserved. */
    MinuteStep?: number;
}

CommonOptions

interface CommonOptions {
    ExtendedClass?: string;
}

PickerOptions

interface PickerOptions extends CommonOptions {
    Label?: string;
    IsDisabled?: boolean;
    IsReadOnly?: boolean;
    IsRequired?: boolean;
    Placeholder?: string;
    ShowClear?: boolean;
    /** Inclusive bounds, in the same stored format as Value. */
    Min?: string;
    Max?: string;
}

Events0No events yet.View events

Interact with an example to see its events.

Live TypeScript example

createTimePicker

Options

Callbacks

Instance methods & properties

Related data types

Purpose and use

Keyboard design guidance

In your application

Search BluKavantUI