Props
| Name | Type | Default | Description |
|---|---|---|---|
activator | ElementOrComponentRef | undefined | - | External activator element or component ref. When provided, the |
activeSegment | BbTimePickerSegment | undefined | - | Which end the columns edit in range mode ( |
adaptive | boolean | undefined | `config.adaptive` (`true`) | On mobile, open in a bottom off-canvas sheet instead of a floating popover.
When unset, falls back to the global |
ampm | boolean | undefined | false | 12-hour display with an AM/PM column; emitted values stay 24-hour. |
anchor | ElementOrComponentRef | undefined | - | Element or component ref the popover positions itself relative to. Defaults to the activator when omitted (anchor to a larger row while a smaller element stays the click target). |
boundary | ElementOrComponentRefOrSelector | undefined | - | Constrains the popover within a bounding element or CSS selector. |
disabled | boolean | undefined | false | Disables the activator and the columns. |
disableFlip | boolean | undefined | false | Disable the automatic flip to the opposite side on overflow. |
eager | boolean | undefined | false | Render popover content before it is first shown. |
label | string | undefined | - | Accessible label applied to the activator via |
max | string | undefined | - | Maximum selectable time in |
min | string | undefined | - | Minimum selectable time in |
modelValuerequired | string | string[] | null | - | v-model value: |
offCanvasProps | Partial<BbOffCanvasProps> | undefined | - | Props for the phone sheet. A |
offset | number | undefined | 4 | Space the popover keeps from the activator. |
padding | number | undefined | - | Minimum empty space to keep from the edge of the page. |
placement | Placement | undefined | - | Position of the popover relative to the activator/anchor. |
pt | PtMap<BbTimePickerPtPart, BbTimePickerPtState> | undefined | - | Passthrough, object form: the same keys as the |
pt:item | PtValue | undefined | - | |
pt:item:open | PtValue | undefined | - | |
pt:item:selected | PtValue | undefined | - | |
pt:panel | PtValue | undefined | - | |
pt:panel:open | PtValue | undefined | - | |
pt:panel:selected | PtValue | undefined | - | |
pt:root | PtValue | undefined | - | |
pt:root:open | PtValue | undefined | - | |
pt:root:selected | PtValue | undefined | - | |
pt:sheet | PtValue | undefined | - | |
pt:sheet:open | PtValue | undefined | - | |
pt:sheet:selected | PtValue | undefined | - | |
range | boolean | undefined | false | Range selection: the value is a two-element |
readonly | boolean | undefined | false | Prevents opening while keeping the activator visible. |
seconds | boolean | undefined | false | Adds the seconds column. |
step | number | undefined | 1 | Minute-column granularity and arrow stepping. |
transitionDuration | number | undefined | 250 | Popover/sheet transition duration in milliseconds. |
v-model
Values kept in sync through v-model.
| Name | Type | Description |
|---|---|---|
activeSegment | BbTimePickerSegment | undefined | |
modelValue | string | string[] | null |
Events
| Name | Type | Description |
|---|---|---|
error | (event: "error", error: TimePickerInputError): void | |
hidden | (event: "hidden"): void | |
hide | (event: "hide"): void | |
show | (event: "show"): void | |
shown | (event: "shown"): void | |
time-pick | (event: "time-pick", payload: { unit: TimeUnit; value: string; }): void | |
update:activeSegment | (event: "update:activeSegment", value: BbTimePickerSegment): void | |
update:modelValue | (event: "update:modelValue", value: string | string[] | null): void |
Slots
The listed properties are the ones exposed to the slot scope.
| Name | Type | Description |
|---|---|---|
activator | BbTimePickerActivatorSlotProps | Custom activator element. Apply |