Elements
TimeField
A time field edits a time of day, a segment at a time: the hour, the minute, with precision="second" the second,
and with hourCycle="h12" AM or PM. A reminder’s time, a meeting’s start, the hours a shop opens. It is the time
under DatePicker’s calendar with timePrecision, on its own in the page.
import { type JSX, mount, signal, Text, token, View } from "nsh";
import { type CalendarItemState, DatePicker, type DatePickerValue, type DateRangePreset, type HourCycle, type OpenChangeReason, type TimeFieldSegmentState } from "nsh/base";
import { button, desktop, Log, Panel, Segmented, size, Split, tint, ui, wide } from "./palette";
// Three date pickers in a card: a due date (weekends disabled, presets
// beside the calendar, a clear button), a stay picked as a range over two
// months in a wide window, and a meeting's date and time with the hours
// on the clock the inspector picks. The trigger is the shared button look
// with the value and a chevron that turns while the calendar is open; the
// calendar is a popup at the trigger, a sheet on a touch screen. Every
// item is drawn by `renderItem` (month names, weekday initials, today on a
// quiet fill, the selected days filled, a range's band) and every segment
// of the time by `renderSegment`; the time's label starts its row and the
// field, a well as the number inputs', ends it.
const MONTHS = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
const WEEKDAYS = ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"];
/** A day's ISO date (`"2026-10-28"`), in local time as the calendar's days are. */
const iso = (d: Date) => `${d.getFullYear()}-${String(d.getMonth() + 1).padStart(2, "0")}-${String(d.getDate()).padStart(2, "0")}`;
const addDays = (d: Date, days: number) => new Date(d.getFullYear(), d.getMonth(), d.getDate() + days);
/** An ISO date's month and day: `Oct 28`. */
const monthDay = (value: string) => `${MONTHS[Number(value.slice(5, 7)) - 1].slice(0, 3)} ${Number(value.slice(8, 10))}`;
/** A time `"HH:MM"` on the picked clock: `14:30`, or `2:30 PM`. */
function clock(time: string, cycle: HourCycle) {
if (cycle === "h23") return time;
const hour = Number(time.slice(0, 2));
return `${hour % 12 === 0 ? 12 : hour % 12}:${time.slice(3, 5)} ${hour < 12 ? "AM" : "PM"}`;
}
/** The text of a control: 13 with a pointer, the touch label size otherwise. */
const controlText = desktop ? 13 : size.label;
/** A day's cell: seven across the popup with a pointer, across a phone's sheet otherwise. */
const cell = desktop ? 32 : 42;
/** The gap between the months of a calendar of two. */
const monthGap = 16;
/** A popup at the trigger with a pointer, a sheet at the bottom on a touch screen. */
const surface = () =>
desktop
? { ...ui().card, borderRadius: 12, padding: 8 }
: { ...ui().card, borderTopLeftRadius: 20, borderTopRightRadius: 20, paddingHorizontal: 10, paddingTop: 14, paddingBottom: 30 };
const backdrop = { backgroundColor: "rgba(0,0,0,0.45)" };
/** The popup's layout: presets in a column beside the calendar with a pointer, a row of chips above it on a phone. */
const content = desktop ? { flexDirection: "row" as const, gap: 10 } : { gap: 12 };
const presets = () =>
desktop
? { gap: 2, minWidth: 104, paddingRight: 10, borderRightWidth: 1, borderColor: ui().border }
: { flexDirection: "row" as const, flexWrap: "wrap" as const, gap: 6 };
const preset = () =>
desktop
? { height: 28, paddingHorizontal: 8, borderRadius: 6, justifyContent: "center" as const, fontSize: 13, color: ui().text }
: { height: 34, paddingHorizontal: 12, borderRadius: 17, borderWidth: 1, borderColor: ui().border, justifyContent: "center" as const, fontSize: 14, color: ui().text };
const calendar = desktop ? { padding: 2 } : { alignSelf: "center" as const };
/** The time's row under a hairline, its label at the start and the field at the end, on the calendar's edges. */
const time = () => ({
gap: 10,
marginTop: 8,
paddingTop: 8,
borderTopWidth: 1,
borderColor: ui().border,
...(desktop ? { paddingHorizontal: 2 } : { alignSelf: "center" as const, width: 7 * cell }),
});
/** The time's field: a recessed well as the number inputs', with their hover and the keyboard's ring while it edits. */
const timeField = [
desktop ? "h-8 rounded-lg px-2" : "h-11 rounded-xl px-3",
"items-center border border-input bg-field",
"enabled:hover:border-faint focus-within:outline-2 focus-within:outline-info",
].join(" ");
/** The trigger: the shared button's look, the value at the start and a chevron in a lane as wide as it. */
function Trigger(props: { title?: string; placeholder: string; open: boolean; clearable?: boolean }) {
const look = button("secondary", {
style: () => ({
flexDirection: "row",
justifyContent: "space-between",
gap: 8,
...(desktop ? { width: 260 } : {}),
...(props.open ? { borderColor: ui().faint } : {}),
}),
});
return (
<View {...look}>
<Text style={{ numberOfLines: 1, flex: 1, fontSize: controlText, color: props.title ? ui().text : ui().faint }}>
{props.title ?? props.placeholder}
</Text>
{/* With a clear button over the end (`cleanable`), an empty lane as wide as the button in place of the chevron. */}
<View
class="transition-transform duration-150 motion-reduce:transition-none"
style={{
width: props.clearable ? 20 : 10,
height: 20,
alignItems: "center",
justifyContent: "center",
opacity: props.clearable ? 0 : 1,
transform: [{ rotate: props.open ? "270deg" : "90deg" }],
}}
>
<Text style={{ fontSize: 18, color: ui().muted }}>›</Text>
</View>
</View>
);
}
/**
* An item of the calendar: Previous and Next as arrows, the month and year toggles (or each month's
* title) by name, the weekdays' initials, and the days: today on the theme's quiet `accent` fill
* (gpui-component's), the selected ones filled,
* the days of a complete range on a band from end to end (`range` says where it starts and ends), the
* other months' days and the disabled ones faint.
*/
function Item(props: { item: CalendarItemState; range?: DatePickerValue }) {
const kind = props.item.kind;
if (kind === "previous" || kind === "next") {
return (
<View style={{ width: cell, height: cell, alignItems: "center", justifyContent: "center", opacity: props.item.disabled ? 0.3 : 1 }}>
<Text style={{ fontSize: 20, color: ui().muted }}>{kind === "previous" ? "‹" : "›"}</Text>
</View>
);
}
if (kind === "monthToggle" || kind === "yearToggle") {
// A month's title in a calendar of several takes no press: the month and its year, over the month.
const title = kind === "monthToggle" && props.item.disabled;
return (
<Text
style={{
width: title ? 6 * cell + monthGap / 2 : kind === "monthToggle" ? 3 * cell : 2 * cell,
paddingHorizontal: 3,
textAlign: title ? "center" : kind === "monthToggle" ? "right" : "left",
fontSize: size.label,
fontWeight: "600",
color: props.item.active ? ui().accent : ui().text,
}}
>
{title ? `${MONTHS[props.item.value - 1]} ${props.item.year}` : kind === "monthToggle" ? MONTHS[props.item.value - 1] : String(props.item.value)}
</Text>
);
}
if (kind === "weekday") {
return <Text style={{ width: cell, paddingVertical: 4, textAlign: "center", fontSize: 11, color: ui().faint }}>{WEEKDAYS[props.item.value]}</Text>;
}
if (kind === "month" || kind === "year") {
// The month view's months (rows of 3) and the year view's years (rows of 5), as wide as a month.
return (
<View
style={{
width: (7 * cell) / (kind === "month" ? 3 : 5),
height: cell + 6,
alignItems: "center",
justifyContent: "center",
borderRadius: 8,
backgroundColor: props.item.active ? ui().accentFill.backgroundColor : "transparent",
}}
>
<Text style={{ fontSize: controlText, color: props.item.active ? ui().onAccent : ui().text }}>
{kind === "month" ? MONTHS[props.item.value - 1].slice(0, 3) : String(props.item.value)}
</Text>
</View>
);
}
// A day. The band reaches from the start's middle to the end's.
const band = () => {
const r = props.range;
if (!props.item.inRange || !Array.isArray(r) || r[0] === r[1]) return null;
return { left: props.item.date === r[0] ? cell / 2 : 0, right: props.item.date === r[1] ? cell / 2 : 0 };
};
return (
<View style={{ width: cell, height: cell, alignItems: "center", justifyContent: "center" }}>
<View style={{ position: "absolute", top: 2, bottom: 2, left: band()?.left ?? 0, right: band()?.right ?? 0, backgroundColor: band() ? tint(ui().accent, 0.14) : "transparent" }} />
<View
style={{
width: cell - 4,
height: cell - 4,
borderRadius: (cell - 4) / 2,
alignItems: "center",
justifyContent: "center",
borderWidth: 1.5,
// The keyboard's day ringed.
borderColor: props.item.focused ? ui().info : "transparent",
backgroundColor: props.item.active ? ui().accentFill.backgroundColor : props.item.today ? token("accent") : "transparent",
}}
>
<Text
style={{
fontSize: controlText,
fontVariant: ["tabular-nums"],
fontWeight: props.item.active || props.item.today ? "600" : "400",
color: props.item.active ? ui().onAccent : props.item.muted ? ui().faint : ui().text,
opacity: props.item.disabled ? 0.5 : 1,
}}
>
{String(props.item.value)}
</Text>
</View>
</View>
);
}
/** A segment of the time: its digits, or AM / PM, filled while it has the keys. */
function Segment(props: { segment: TimeFieldSegmentState }) {
return (
<Text
style={{
paddingHorizontal: 3,
borderRadius: 4,
fontSize: controlText,
fontVariant: ["tabular-nums"],
color: props.segment.selected ? ui().onAccent : ui().text,
backgroundColor: props.segment.selected ? ui().accentFill.backgroundColor : "transparent",
}}
>
{props.segment.label}
</Text>
);
}
/** A label over its control, a quieter line under the label. */
function Field(props: { label: string; detail: string; children: JSX.Element }) {
return (
<View style={{ gap: 8 }}>
<View style={{ gap: 2 }}>
<Text style={{ fontSize: size.label, fontWeight: "500", color: ui().text }}>{props.label}</Text>
<Text style={{ fontSize: size.detail, color: ui().muted }}>{props.detail}</Text>
</View>
{props.children}
</View>
);
}
function App() {
const due = signal<string | null>(null);
const stay = signal<DatePickerValue>(null);
const meeting = signal<string | null>(null);
const cycle = signal<HourCycle>("h12");
const dueOpen = signal(false);
const stayOpen = signal(false);
const meetingOpen = signal(false);
const events = signal<string[]>([]);
const log = (line: string) => events.set([line, ...events()].slice(0, 8));
const opened = (open: (next: boolean) => void) => ({ open: next }: { open: boolean; reason: OpenChangeReason }) => open(next);
// The presets from today.
const today = new Date();
const monday = addDays(today, ((8 - today.getDay()) % 7) || 7);
const dues: DateRangePreset[] = [
{ label: "Today", value: iso(today) },
{ label: "Tomorrow", value: iso(addDays(today, 1)) },
{ label: "Next Monday", value: iso(monday) },
];
const stays: DateRangePreset[] = [
{ label: "This week", value: [iso(today), iso(addDays(today, (7 - today.getDay()) % 7))] },
{ label: "Next 7 nights", value: [iso(today), iso(addDays(today, 7))] },
];
const stayTitle = () => {
const r = stay();
return Array.isArray(r) && r[0] && r[1] ? `${monthDay(r[0])} – ${monthDay(r[1])}, ${r[1].slice(0, 4)}` : undefined;
};
const meetingTitle = () => {
const v = meeting();
return v ? `${monthDay(v)}, ${v.slice(0, 4)} · ${clock(v.slice(11, 16), cycle())}` : undefined;
};
return (
<View style={{ flex: 1, backgroundColor: ui().page, padding: 20, paddingTop: 24, gap: 14 }}>
<Text style={{ fontSize: 22, fontWeight: "700", color: ui().text }}>date-picker</Text>
<Text style={{ color: ui().muted }}>
{desktop ? "Arrows move between days, Return picks; the trigger takes Delete to clear" : "Tap a day; the meeting's time takes digits"}
</Text>
<Split
gap={14}
inspector={
<>
<Panel title="value">
<Text style={{ fontSize: 13, color: ui().text }}>{`due ${JSON.stringify(due())}`}</Text>
<Text style={{ fontSize: 13, color: ui().text }}>{`stay ${JSON.stringify(stay())}`}</Text>
<Text style={{ fontSize: 13, color: ui().text }}>{`meeting ${JSON.stringify(meeting())}`}</Text>
</Panel>
<Segmented label="hourCycle" options={["h12", "h23"] as const} value={cycle()} onChange={(v) => cycle.set(v)} />
<Log title="onChange" lines={events()} minHeight={120} />
</>
}
>
<View style={{ ...ui().card, borderRadius: 16, padding: 16, gap: 20 }}>
<Field label="Due" detail="Weekdays only, presets beside the calendar, a clear button">
<DatePicker
value={due()}
onChange={({ value }) => {
due.set(typeof value === "string" ? value : null);
log(`Due → ${JSON.stringify(value)}`);
}}
onOpenChange={opened((next) => dueOpen.set(next))}
accessibilityLabel="Due"
disabledMatcher={[0, 6]}
presets={dues}
offset={4}
margin={8}
popupStyle={surface()}
backdropStyle={backdrop}
contentStyle={content}
presetsStyle={presets()}
presetStyle={preset()}
presetClass="active:opacity-70"
calendarStyle={calendar}
headerStyle={{ marginBottom: 4 }}
itemClass="active:opacity-70"
renderItem={(item) => <Item item={item} />}
style={desktop ? { width: 260 } : undefined}
cleanable
clearButtonAccessibilityLabel="Clear the due date"
clearButtonClass="absolute items-center justify-center rounded-full enabled:hover:opacity-70"
clearButtonStyle={{ top: (size.control - 20) / 2, right: 10, width: 20, height: 20 }}
clearButton={<Text style={{ fontSize: 12, color: ui().muted }}>✕</Text>}
trigger={<Trigger title={due() ? `${monthDay(due()!)}, ${due()!.slice(0, 4)}` : undefined} placeholder="No due date" open={dueOpen()} clearable={due() !== null} />}
/>
</Field>
<Field label="Stay" detail={wide() ? "A range over two months: the first press starts it" : "A range: the first press starts it, the second ends it"}>
<DatePicker
range
value={stay()}
onChange={({ value }) => {
stay.set(value);
log(`Stay → ${JSON.stringify(value)}`);
}}
onOpenChange={opened((next) => stayOpen.set(next))}
accessibilityLabel="Stay"
numberOfMonths={wide() ? 2 : 1}
firstDayOfWeek={1}
presets={stays}
offset={4}
margin={8}
popupStyle={surface()}
backdropStyle={backdrop}
contentStyle={content}
presetsStyle={presets()}
presetStyle={preset()}
presetClass="active:opacity-70"
calendarStyle={calendar}
headerStyle={{ marginBottom: 4 }}
bodyStyle={{ gap: monthGap }}
itemClass="active:opacity-70"
renderItem={(item) => <Item item={item} range={stay()} />}
trigger={<Trigger title={stayTitle()} placeholder="Check-in – check-out" open={stayOpen()} />}
/>
</Field>
<Field label="Meeting" detail="A day, then its time; the day again closes the calendar">
<DatePicker
value={meeting()}
onChange={({ value }) => {
meeting.set(typeof value === "string" ? value : null);
log(`Meeting → ${JSON.stringify(value)}`);
}}
onOpenChange={opened((next) => meetingOpen.set(next))}
accessibilityLabel="Meeting"
timePrecision="minute"
hourCycle={cycle()}
defaultTime="09:00"
offset={4}
margin={8}
popupStyle={surface()}
backdropStyle={backdrop}
calendarStyle={calendar}
headerStyle={{ marginBottom: 4 }}
itemClass="active:opacity-70"
renderItem={(item) => <Item item={item} />}
timeStyle={time()}
timeLabel={<Text style={{ fontSize: controlText, color: ui().muted }}>Time</Text>}
timeAccessibilityLabel="Meeting time"
timeFieldClass={timeField}
segmentClass="rounded active:opacity-70"
separatorStyle={{ fontSize: controlText, color: ui().faint }}
renderSegment={(segment) => <Segment segment={segment} />}
trigger={<Trigger title={meetingTitle()} placeholder="Not scheduled" open={meetingOpen()} />}
/>
</Field>
</View>
</Split>
</View>
);
}
mount(App);The field owns the behavior: the time (the app’s, or its own), which segment the keys edit, typing and stepping
digits, and what screen readers hear. The look is the app’s: it styles the segments and the : between them, or
draws the segments itself.
use chrono::NaiveTime;
use nsh_base::{HourCycle, TimeFieldSegmentState, TimeOfDay, time_field, theme};
use nsh_core::prelude::*;
fn reminder_time() -> impl IntoElement {
let at = signal(TimeOfDay(NaiveTime::from_hms_opt(9, 30, 0).unwrap()));
time_field()
.value(move || Some(at.get()))
.on_change(move |next: &TimeOfDay| at.set(*next))
.hour_cycle(HourCycle::H12)
.accessibility_label("Reminder time")
.render_segment(|segment: &TimeFieldSegmentState| {
view()
.px_1()
.rounded_sm()
.when(segment.selected, |v| v.bg(move || theme().accent))
.child(text(segment.label.clone()))
})
}import { mount, signal } from "nsh";
import { TimeField } from "nsh/base";
function App() {
const at = signal("09:30");
return (
<TimeField
value={at()}
onChange={({ value }) => at.set(value)}
hourCycle="h12"
accessibilityLabel="Reminder time"
class="h-9 w-32 flex-row items-center rounded-md border border-input px-2"
segmentClass="rounded-sm px-0.5 text-sm tabular-nums focus:bg-accent focus:text-accent-foreground"
separatorClass="text-sm text-muted-foreground"
/>
);
}
mount(App);TimeField comes from nsh/base, the nsh-base crate in Rust. In Rust, time_field()
makes one with a setter per prop (.value(..), .precision(..), .hour_cycle(..)) and a listener per event
(.on_change(..)). Its time is a TimeOfDay, a chrono::NaiveTime.
#Value
The value is a time of day on a 24-hour clock, as an HTML <input type="time">’s: "HH:MM", or "HH:MM:SS" with
precision="second", whatever hourCycle the field shows. With value, the app owns it: the field shows it and
reports each edit with onChange({ value }); the app sets value to follow it. Left out, the field keeps its own
time, from defaultValue at first (default 00:00).
precision is the smallest unit the field edits, "minute" (the default) or "second". hourCycle is how it counts
the hours: "h23" (the default) from 00 to 23, "h12" from 12 to 11 with an AM/PM segment after the numbers.
#Editing
One segment is selected; the keys edit it, as gpui-base’s time field:
- Up and Down step the segment by one and wrap around (59 to 00) without carrying into the next segment.
- Digits type into it, two at a time: a digit that cannot start a longer value (a
7in the hour) completes the segment and moves to the next. aandpset AM and PM.- Backspace and Delete reset the segment.
A press on a segment selects it. A press on the selected AM/PM segment switches it, since phones have no a and p
keys. The keys go to one native text field behind the segments, transparent, as an OtpInput’s: on
phones and tablets it brings up the number pad.
#Props
| Prop | Rust | Type | Default | Description |
|---|---|---|---|---|
value | .value(..) | string | none | The time, owned by the app. |
defaultValue | .default_value(..) | string | "00:00" | The time at first, without value. |
precision | .precision(..) | "minute" | "second" | "minute" | The smallest unit it edits. |
hourCycle | .hour_cycle(..) | "h23" | "h12" | "h23" | How it counts the hours; "h12" adds an AM/PM segment. |
disabled | .disabled(..) | boolean | false | No focus and no editing; disabled: styles apply to the field and its segments. |
accessibilityLabel | .accessibility_label(..) | string | none | What screen readers call the field. |
segmentClass, segmentStyle | .segment_class(..), .segment_style(..) | string, StyleProp<TextStyle> | none | Each segment: focus: on the selected one while the field has the focus, disabled: with the field. |
separatorClass, separatorStyle | .separator_class(..), .separator_style(..) | string, StyleProp<TextStyle> | none | Each : between the numbers. |
renderSegment | .render_segment(..) | (segment: TimeFieldSegmentState) => JSX.Element | none | A segment’s content, drawn by the app; its label otherwise. |
class, style | style methods | string, StyleProp<ViewStyle> | none | The field, around its segments (a row). |
renderSegment gets a TimeFieldSegmentState: segment ("hour", "minute", "second" or "period"), value
(the hour on the field’s clock, the minute or the second; 0 for AM and 1 for PM), label (two digits, or AM /
PM), selected (the keys edit it) and disabled.
#Events
| Event | Rust | Description |
|---|---|---|
onChange | .on_change(|value| ..) | The user changed the time: { value }. Set value to follow it. A value the app passes is never reported. |
#Parts
| Part | Where | Styled with |
|---|---|---|
| The field | the root, a row | class, style |
| A segment | the field: hour, minute, second, AM/PM | segmentClass, segmentStyle, renderSegment |
| A separator | the field, between two numbers | separatorClass, separatorStyle |
#Keyboard
Tab reaches the field with its selected segment. Then:
| Key | Action |
|---|---|
| Left / Right | The segment before or after. |
| Tab / Shift+Tab | The segment after or before; Tab from the last one and Shift+Tab from the first leave the field. |
| Up / Down | Steps the segment by one, wrapping around. |
| 0 to 9 | Types into the segment. |
| A / P | AM or PM. |
| Backspace, Delete | Resets the segment. |
#Accessibility
- The field is a text field named by
accessibilityLabel; screen readers read the time it shows.disableddims it. - Phones and tablets show the number pad.
See Accessibility for labels, roles and announcements in general.