Skip to content

WidgetDuration ​

Overview ​

A duration input widget that renders separate numeric spinners for days, hours, minutes, and seconds. Each time unit can be shown or hidden independently via props. The value is DRF's duration string ([D ]HH:MM:SS), as a Django DurationField sends and reads it, or with seconds a number of seconds, as DurationSecondsField sends and reads it. The shown units split the value between them, so a duration of two days reads as 48 hours when days are hidden. Clearing a unit while the rest of the value is zero sets the value to null. Entering 0 keeps a zero duration. A negative value, such as Django's -1 23:00:00 for minus one hour, shows a "Negative" segment with a minus sign before the spinners. The spinners show the duration's size, and editing them keeps the value negative.

Theme entry: WidgetDuration

Props ​

NameTypeRequiredDefaultDescription
nameStringundefinedThe widget name; falls back to the field context value when omitted.
labelStringundefinedThe label displayed next to the widget; falls back to the field context value when omitted.
helpStringundefinedHelp text displayed alongside the widget; falls back to the field context value when omitted.
readOnlyBooleanfalseWhether the widget is read-only; falls back to the field context value when omitted.
requiredBooleanundefined, // let the default from field context take overWhether the widget is required; falls back to the field context value when undefined.
modelValueString|Number|Boolean|Array|ObjectundefinedThe widget's bound value (v-model); used only in contextless mode.
fieldToWidgetObject|FunctionnullAdapter that converts the form model value into a value suitable for the widget UI.
widgetToFieldObject|FunctionnullAdapter that converts the widget UI value back into a form model value for validation and submission.
invalidBooleanundefinedManually set the invalid state when not in a field context.
warningBooleanundefinedManually set the warning state when not in a field context.
disabledBooleanfalseWhether the widget is disabled.
disabledFnFunctionnullA function that returns whether the widget should be disabled; takes precedence over the disabled prop.
contextlessBooleanfalseWhen true, the widget ignores any surrounding field or form context and manages its own state.
displayDependenciesArray() => []Field paths whose values the widget needs for display logic; registered with the field context.
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
showDaysbooleanfalseWhen true, renders the days spinner.
showHoursbooleanfalseWhen true, renders the hours spinner.
showMinutesbooleantrueWhen true, renders the minutes spinner.
showSecondsbooleanfalseWhen true, renders the seconds spinner.
secondsbooleanfalseWhen true, the value is a number of seconds instead of a duration string.

Events ​

NameDescription
update:modelValueEmitted when the widget value changes.

Full event reference

Source ​

client/lib/widgets/WidgetDuration.vue