OGE logoOGE

Inputs API

Complete API reference for @oge-ui/inputs. The three editors share one field chrome and one base class — shared members are listed once per editor as "Common" groups, editor-specific members first. Live examples are on the demo pages.

Properties Methods Events Types

OgeTextBox

oge-text-box

Properties 43

OgeTextBox

Name Type DefaultDescription
valuemodel<string>''Editor value — two-way.
modeOgeTextBoxMode'text'Native input type. password auto-enables the reveal toggle.
maxLengthnumber | undefined—Counter denominator; enforced natively while counterMode is 'limit'.
minLengthnumber | undefined—Native minlength attribute.
showCounterbooleanfalseRenders the grapheme-accurate character counter in the subscript end slot.
counterModeOgeInputCounterMode'limit'Enforce maxLength natively, or allow typing past it and color the counter.
revealablebooleantruePassword reveal toggle; on by default for mode="password". Preserves caret/selection when toggling.
showCopyButtonbooleanfalseCopy-to-clipboard rail button (API keys, tokens…); copies the live text.
autocompletestring | undefined—Native autocomplete attribute.
inputModestring | undefined—Native inputmode attribute.
enterKeyHintstring | undefined—Native enterkeyhint attribute.
autocapitalizestring | undefined—Native autocapitalize attribute.
spellcheckboolean | undefined—undefined omits the attribute (browser default).

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord<string, string>{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial<OgeInputsMessages> | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 8

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent<T>Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeTextArea

oge-text-area

Properties 41

OgeTextArea

Name Type DefaultDescription
valuemodel<string>''Editor value — two-way.
rowsnumber3Visible rows when autoResize is off; the floor when it is on.
autoResizebooleanfalseGrow/shrink with content between minRows and maxRows.
minRowsnumber | undefined—Defaults to rows.
maxRowsnumber | undefined—undefined = unbounded growth.
maxLengthnumber | undefined—Counter denominator / native cap.
minLengthnumber | undefined—Native minlength attribute.
showCounterbooleanfalseGrapheme-accurate character counter.
counterModeOgeInputCounterMode'limit'Enforce maxLength natively, or soft-cap.
spellcheckbooleantrueNon-optional here, unlike the text box.
autocapitalizestring | undefined—Native autocapitalize attribute.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord<string, string>{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial<OgeInputsMessages> | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 8

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent<T>Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeNumberBox

oge-number-box

Properties 38

OgeNumberBox

Name Type DefaultDescription
valuemodel<number | null>nullnull is the empty state — never 0.
minnumber | undefined—Lower bound — values clamp on commit (typing is never blocked).
maxnumber | undefined—Upper bound — clamped on commit.
stepnumber1Spin/arrow-key increment. Spinning commits immediately.
showSpinButtonsbooleanfalseUp/down spin buttons with hold-to-repeat.
formatIntl.NumberFormatOptions | undefined—Display formatting applied while unfocused; focus shows the raw number. style: 'percent' formats display only — the model value is not rescaled.
localestring | undefined—Overrides the application locale (LOCALE_ID).
modeOgeNumberBoxMode'text'Native type attribute; inputmode is always decimal.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord<string, string>{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial<OgeInputsMessages> | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 8

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent<T>Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeSelectBox

oge-select-box

Properties 58

OgeSelectBox

Name Type DefaultDescription
valuemodel<unknown>nullCommitted value (the valueExpr of the selected item); two-way.
itemsreadonly TItem[] | OgeSelectBoxItemsFn[]The selectable items: an array, or a function invoked lazily on first open (sync or promise; loading/error rows render while pending). The selected item is resolved from this full set, never the filtered one.
displayExprstring | ((item) => string)—Item → display text. Omitted, the item itself is stringified.
valueExprstring | ((item) => unknown)—Item → committed value. Omitted, the whole item is the value.
disabledExprstring | ((item) => boolean)—Marks individual items as non-selectable.
searchEnabledbooleanfalseEnables typing into the field to filter the list.
searchMode'contains' | 'startswith''contains'How typed search text matches an item.
searchExprstring | string[] | ((item) => string)—Which text the filter matches; defaults to the display text.
minSearchLengthnumber0Characters required before the filter narrows the list.
showDataBeforeSearchbooleanfalseBelow minSearchLength: show the full list (true) or nothing (false).
searchTimeoutnumber | undefined—Debounce before typed text filters the list; undefined = config default (250ms). The displayed text is never debounced.
acceptCustomValuebooleanfalseLets typed text that matches no item become the value (committed on Enter/blur) — see customItemCreating.
groupBystring | ((item) => string)—Groups flat items under headers; items are re-ordered by first-seen group.
imageExprstring | ((item) => string)—Item → image URL rendered before the option text (avatars, flags…). For inline SVG icons use itemTemplate.
showDropDownButtonbooleantrueRenders the chevron toggle in the field rail.
openOnFieldClickbooleantrueClicking the field opens the popup (select-only mode toggles it).
loadingbooleanfalseShows a loading row instead of items — server-side filtering escape hatch.
dropdownPlacementOgePopupPlacement'bottom-start'Preferred popup side/alignment (flips when cramped).
dropdownWidthnumber | 'anchor''anchor'Popup width: fixed pixels or 'anchor' to match the field box.
dropdownMaxHeightnumber | undefined—Scrollable list height cap; undefined = the CSS default (320px).
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-width bottom sheet (with a search field at the top when searchEnabled) on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
wrapItemTextbooleanfalseWraps long option text instead of ellipsizing it.
useItemTextAsTitlebooleanfalseMirrors each option's display text into its title attribute.
itemTemplateTemplateRef<OgeSelectItemTemplateContext>—Custom option row rendering; context: $implicit, index, selected, active.
virtualScrollboolean | OgeVirtualScrollOptionsfalseWindowed rendering for large lists ({ itemHeight, overscan }). Rows get a fixed size-matched height; groupBy and wrapItemText are ignored while active.
openedmodel<boolean>falsePopup visibility — two-way.
selectedItemSignal<TItem | null>—Read-only: the item whose valueExpr matches value.
displayTextSignal<string>—Read-only: display text of the selected item.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord<string, string>{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial<OgeInputsMessages> | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 7

OgeSelectBox methods

Name Type Description
open()voidOpens the popup (no-op while disabled/readonly).
close()voidCloses the popup.
toggle()voidToggles the popup.

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 13

OgeSelectBox events

Name Type Description
selectionChangedOgeSelectBoxSelectionChangedEventThe resolved selected item changed (user or programmatic) — { item, previousItem }.
itemClickOgeSelectBoxItemClickEventAn option row was activated — { item, index, event }; index is within the visible (filtered) list.
dropDownOpened / dropDownClosedvoidPopup visibility changes, from any trigger.
searchChangedOgeSelectBoxSearchChangedEventRaw search text on every keystroke — drive server-side filtering from here.
customItemCreatingOgeSelectBoxCustomItemEventMutable payload (as in the references): assign customItem — an item, a promise of one, or null to reject the text. Left unset, the raw text becomes the item.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent<T>Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

Types 3

Select box types

Name Type Description
OgeSelectBoxDisplayExpr / ValueExpr / DisabledExprstring | fnField-name string or function expressions for display text, committed value and per-item disabling.
OgeSelectBoxSearchMode'contains' | 'startswith'Filter match mode.
OgeSelectItemTemplateContextinterface{ $implicit: TItem; index: number; selected: boolean; active: boolean }.

OgeTreeSelect

oge-tree-select

Properties 19

Value & data

Name Type DefaultDescription
valueRowKey | readonly RowKey[] | nullnullCommitted value — two-way. The selected node's key in single mode, an array of keys in multiple.
itemsreadonly TItem[] | undefined—Nodes to display — a flat parent-referencing list or nested children.
keyExpr / parentIdExpr / itemsExprstring | ((row: TItem) => …)—Identity and structure accessors, forwarded to the popup tree. itemsExpr switches to hierarchical data.
displayExprstring | ((row: TItem) => unknown)'text'Node label, used both in the tree and for the text shown in the closed field.
disabledExpr / hasItemsExpr / iconExpr / rootValue / dataStructuresee OgeTreeView—Forwarded verbatim to the popup tree.

Selection

Name Type DefaultDescription
selectionMode'single' | 'multiple''single'multiple makes value an array and keeps the popup open while picking.
showCheckBoxes'none' | 'normal' | 'selectAll''none'Checkbox column inside the popup.
selectNodesRecursivebooleantrueCascades selection down to descendants and up to fully-selected parents.
selectedKeysMode'all' | 'leavesOnly' | 'excludeRecursive''all'Projection applied to the committed keys — leavesOnly is usually what you want to store from a cascade.
displayMode'text' | 'count''text'Closed-field rendering for a multiple selection: the joined labels, or just how many are picked.

Popup

Name Type DefaultDescription
openedbooleanfalseWhether the popup is open — two-way.
expandedKeysreadonly RowKey[][]Expanded nodes — two-way, so the shape survives close and reopen.
expandEvent'click' | 'dblclick''dblclick'Which gesture expands inside the popup. Unlike the bare tree this defaults to dblclick — in a picker a single click should choose, and the chevron expands either way.
searchEnabled / searchMode / filterModesee OgeTreeView—Puts the tree's own search box inside the popup.
loadChildren(parent: TItem, key: RowKey) => Promise<readonly TItem[]>—Lazy children, fetched on first expand.
virtualScrollboolean | { itemHeight: number }falseWindowed rendering inside the popup for very large trees.
dropdownPlacement / dropdownWidth / dropdownMaxHeightOgePopupPlacement | number | 'anchor'—Popup geometry. Width defaults to 'anchor' (matches the field), max height to 320px.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-width bottom sheet (a Done action in 'multiple' mode) on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
openOnFieldClickbooleantrueOpens on a click anywhere in the field, not only on the chevron.

Methods 2

Name Type Description
open() / close() / toggle()() => voidImperative popup control.
focus() / blur() / reset() / clear()() => voidInherited field-chrome control methods. `clear()` empties the value, commits immediately and keeps focus in the field.

Events 3

Name Type Description
selectionChangedOgeTreeSelectSelectionChangedEventEmitted after the committed selection changed, with keys and previousKeys (always arrays, even in single mode).
dropDownOpened / dropDownClosedvoidPopup lifecycle.
valueCommittedOgeInputValueCommittedEventInherited commit event carrying the previous value.

Types 3

Name Type Description
OgeTreeSelectSelectionMode'single' | 'multiple'How many nodes may be committed.
OgeTreeSelectDisplayMode'text' | 'count'Closed-field rendering of a multiple selection.
OgeTreeSelectSelectionChangedEvent{ keys, previousKeys }Payload of selectionChanged.

OgeTagBox

oge-tag-box

Properties 39

OgeTagBox

Name Type DefaultDescription
valuemodel<readonly unknown[]>[]Committed values — the valueExpr of every selected item; two-way.
items / displayExpr / valueExpr / disabledExpr / imageExprshared with OgeSelectBox—The tag box reuses the select box expression vocabulary verbatim.
searchEnabled / searchMode / searchExprshared with OgeSelectBox—Client-side filtering of the option list.
showSelectionControlsbooleantrueRenders checkboxes in front of the options.
hideSelectedItemsbooleanfalseHides already-selected items from the popup list.
maxDisplayedTagsnumber | undefined—Caps the rendered chips; the rest collapse into a +N chip.
opened / dropdownPlacement / dropdownWidth / dropdownMaxHeight / showDropDownButton / openOnFieldClickshared with OgeSelectBox—Popup configuration and two-way visibility.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-width bottom sheet (search field when searchEnabled, picks keep it open, a Done action closes it) on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
virtualScrollboolean | OgeVirtualScrollOptionsfalseWindowed rendering for large lists — same contract as the select box.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord<string, string>{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial<OgeInputsMessages> | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeTagBox methods

Name Type Description
open() / close() / toggle()voidPopup control (no-ops while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 11

OgeTagBox events

Name Type Description
selectionChangedOgeTagBoxSelectionChangedEventPer-commit delta — { addedItems, removedItems }.
itemClickOgeTagBoxItemClickEventAn option row was toggled — { item, index, event }.
dropDownOpened / dropDownClosedvoidPopup visibility changes, from any trigger.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent<T>Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeAutocomplete

oge-autocomplete

Properties 45

OgeAutocomplete

Name Type DefaultDescription
valuemodel<string>''The typed text — the committed value is the string itself, not an item value; two-way.
itemsreadonly TItem[] | OgeSelectBoxItemsFn[]The suggestion items: an array, or a function invoked lazily on first open (sync or promise; loading/error rows render while pending).
displayExpr / disabledExpr / imageExpr / searchExpr / searchMode / groupBy / itemTemplateshared with OgeSelectBox—The autocomplete reuses the select box expression vocabulary and list rendering verbatim (no valueExpr — the value is text).
minSearchLengthnumber1Characters required before suggestions open while typing; deleting below the threshold closes the list.
maxItemCountnumber10Caps the rendered suggestion list.
searchTimeoutnumber | undefined—Debounce before typed text filters the list; undefined = config default (250ms). The displayed text is never debounced.
forceSelectionbooleanfalseReverts non-matching text to the last committed value on blur; an exact display match resolves to the item with its canonical casing.
searchHighlightbooleantrueMarks the matched part of each suggestion (<mark>).
showDropDownButtonbooleanfalseRenders the chevron toggle in the field rail (off by default — reference parity).
openOnFieldClickbooleanfalseClicking the field opens the suggestion list.
loading / dropdownPlacement / dropdownWidth / dropdownMaxHeight / wrapItemText / useItemTextAsTitleshared with OgeSelectBox—Popup configuration and list rendering.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-width bottom sheet with its own text field at the top on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
virtualScrollboolean | OgeVirtualScrollOptionsfalseWindowed rendering for large lists — same contract as the select box.
openedmodel&lt;boolean&gt;falsePopup visibility — two-way.
selectedItemSignal&lt;TItem | null&gt;—Read-only: the last picked suggestion; null once the text diverges from it.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord&lt;string, string&gt;{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial&lt;OgeInputsMessages&gt; | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeAutocomplete methods

Name Type Description
open() / close() / toggle()voidPopup control (no-ops while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 12

OgeAutocomplete events

Name Type Description
selectionChangedOgeAutocompleteSelectionChangedEventA suggestion was picked or the selection was canceled — { item: TItem | null, event? }.
itemClickOgeAutocompleteItemClickEventA suggestion row was activated — { item, index, event }.
dropDownOpened / dropDownClosedvoidPopup visibility changes, from any trigger.
searchChangedOgeSelectBoxSearchChangedEventRaw search text on every keystroke — drive server-side filtering from here.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

Types 2

Autocomplete types

Name Type Description
OgeAutocompleteSelectionChangedEventinterface{ item: TItem | null; event?: Event } — null means the selection was canceled.
OgeVirtualScrollOptionsinterface{ itemHeight?: number; overscan?: number }; default heights come from OGE_SELECT_OPTION_HEIGHT (28/34/40px for sm/md/lg).

OgeCheckBox

oge-check-box

Properties 18

OgeCheckBox

Name Type DefaultDescription
labelstring''Text rendered beside the control.
valuemodel&lt;boolean | null&gt;falsetrue/false, or null for the indeterminate (dash) state — two-way. null renders regardless of threeState.
threeStatebooleanfalseLets users cycle into the indeterminate state: null → true → false → null (the reference cycle).
textstring''Label text; the default <ng-content> slot renders when unset.
size'sm' | 'md' | 'lg''md'Glyph/font size preset.
tooltipstring | undefined—Native title on the label element.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeCheckBox methods

Name Type Description
toggle(): voidvoidAdvances the state exactly like a user click (respects threeState, no-op while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 8

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeSlider

oge-slider

Properties 25

OgeSlider

Name Type DefaultDescription
valuemodel&lt;number&gt;0The slider value — two-way. Programmatic writes clamp and snap to the step grid.
min / maxnumber | undefined0 / 100Scale bounds. Typed number | undefined because the Signal Forms contract reserves these member names — undefined falls back to 0/100.
stepnumber1Arrow-key and drag increment; thumbs always sit on this grid, with float-error correction (0.1-style steps never drift).
largeStepnumber | undefined—PageUp/PageDown increment; undefined means step × 10.
orientation'horizontal' | 'vertical''horizontal'A vertical slider announces aria-orientation="vertical"; Up still increases (APG).
showRangebooleantrueFills the selected portion of the track.
showTicks / tickStepboolean / number | undefinedfalseTick marks on the tickStep grid — falling back to largeStep, then step; capped at 200 marks.
showTickLabelsbooleanfalseFormatted labels under each tick (Kendo's tick title callback, fed by formatValue).
showLabelsbooleanfalseFormatted min/max labels at the track ends.
valueIndicator'none' | 'active' | 'always''none'The inline value bubble: 'active' while focused, dragged or hovered (Material's discrete plus DevExtreme's showMode: 'onHover'), 'always' permanent.
formatValue(value: number) =&gt; string | undefined—Formats the bubble, the end labels and aria-valuetext — display and announcement never diverge.
showButtonsbooleanfalseKendo-style increment/decrement buttons with press-and-hold repeat — the number box's spin timing config.
ariaLabelstring | undefined—Accessible name of the thumb; the localized sliderHandle message is the fallback.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 10

OgeSlider events

Name Type Description
dragStartedOgeSliderDragStartedEventA drag gesture began on the thumb or the track.
slideEndedOgeSliderSlideEndedEvent&lt;number&gt;Fires once per gesture at release — DevExtreme's onHandleRelease timing without a mode switch (live changes stream through valueCommitted, throttled by debounce). Not emitted when Escape cancels the gesture.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

Types 3

Name Type Description
OgeSliderOrientation'horizontal' | 'vertical'Axis the track lays along.
OgeSliderValueIndicator'none' | 'active' | 'always'When the inline value bubble shows.
OgeSliderDragStartedEvent / OgeSliderSlideEndedEvent&lt;T&gt;{ event } / { value; event }The drag gesture pair.

OgeRangeSlider

oge-range-slider

Properties 17

OgeRangeSlider

Name Type DefaultDescription
valuemodel&lt;readonly [number, number]&gt;[0, 0]The [start, end] pair — two-way. Programmatic writes clamp, snap and sort.
minRangenumber0Minimum distance kept between the thumbs — reflected in each thumb’s dynamic aria-valuemin/aria-valuemax (the APG multi-thumb constraint).
startAriaLabel / endAriaLabelstring | undefined—Accessible names of the thumbs; the localized sliderStartHandle/sliderEndHandle messages are the fallbacks.
startName / endNamestring''Hidden-input names for plain HTML form posts — DevExtreme's startName/endName contract (the single slider uses the inherited name).

Shared with OgeSlider

Name Type DefaultDescription
min / max / step / largeStep / orientation / showRange / showTicks / tickStep / showLabels / valueIndicator / formatValue——The full scale/appearance surface of OgeSlider, identical semantics. showButtons is single-slider only (the Kendo split). Clicking the track moves the nearest thumb.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 9

OgeRangeSlider events

Name Type Description
dragStarted / slideEndedOgeSliderSlideEndedEvent&lt;readonly [number, number]&gt;The drag gesture pair; an unchanged pair never re-emits valueCommitted.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeSwitch

oge-switch

Properties 16

OgeSwitch

Name Type DefaultDescription
valuemodel&lt;boolean&gt;falseThe on/off state — two-way.
labelstring''Accessible name (aria-label).
onText / offTextstring | undefined—Track texts; undefined falls back to the localized switchOn/switchOff messages ('ON'/'OFF'), empty strings hide the text.
size'sm' | 'md' | 'lg''md'Track size preset.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeSwitch methods

Name Type Description
toggle(): voidvoidFlips the state (no-op while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 8

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeRadioGroup

oge-radio-group

Properties 19

OgeRadioGroup

Name Type DefaultDescription
valuemodel&lt;unknown&gt;nullThe selected item's valueExpr result; two-way.
itemsreadonly TItem[][]The selectable items.
displayExpr / valueExpr / disabledExprshared with OgeSelectBox—Field-name string or function expressions — the select box vocabulary.
layout'vertical' | 'horizontal''vertical'Column or row arrangement.
labelstring''Accessible name of the group (aria-label).
itemTemplateTemplateRef&lt;OgeSelectItemTemplateContext&gt;—Custom item rendering next to the radio dot; context: $implicit, index, selected, active.
size'sm' | 'md' | 'lg''md'Dot/font size preset.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 9

OgeRadioGroup events

Name Type Description
itemClickOgeRadioGroupItemClickEventA radio item was activated by click or keyboard — { item, index, event }.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeCalendar

oge-calendar

Properties 29

Slot & locale helper

Name Type DefaultDescription
*ogeCalendarCellTemplateOgeCalendarCellTemplate—Replaces the default day-cell rendering — badges, prices, availability dots. Also usable on oge-date-box and oge-date-range-box, which project into the same calendar.
datePartOrder(locale, kind)(locale: string | undefined, kind: 'date' | 'datetime' | 'time') =&gt; string[]—The order a locale writes date parts in, derived from Intl. Drives locale-aware typed parsing; exported so consumers can build their own date editors on the same rules.

OgeCalendar

Name Type DefaultDescription
labelstring''Accessible name of the grid (aria-label); the messages supply a default.
valuemodel&lt;Date | null&gt;nullThe selected day (single mode) — two-way, local Date.
valuesmodel&lt;readonly Date[]&gt;[]Selected days for selectionMode: 'multiple' — two-way.
selectionMode'single' | 'multiple' | 'range''single'Range mode picks a start–end pair with a live hover preview.
rangemodel&lt;[Date | null, Date | null]&gt;[null, null]The selected tuple for selectionMode: 'range' — two-way; either end may stay open.
viewsCount1 | 21Side-by-side month views (2 is the range layout).
zoomLevel / minZoomLevel / maxZoomLevel'month' | 'year' | 'decade''month' / 'decade' / 'month'Drill level (two-way) and its reachable bounds; dx's 'century' is deliberately dropped.
min / maxDate | undefined—Day bounds; undefined = unbounded (no dx 1000–3000 defaults).
disabledDatesDate[] | ((d: Date) =&gt; boolean)—Individual unselectable days.
firstDayOfWeeknumber | undefined—0–6 (Sunday-first); undefined resolves from the locale's Intl week info.
showWeekNumbersboolean | { rule: 'firstDay' | 'firstFourDays' | 'fullWeek' }falseWeek-number column; true = the ISO rule.
showTodayButtonbooleanfalseRenders the localized today shortcut.
focusedDatemodel&lt;Date | null&gt;—The keyboard-focused day — two-way (controlled navigation).
localestring | undefined—BCP 47 locale for all texts (Intl).
cellTemplateTemplateRef&lt;OgeCalendarCellTemplateContext&gt;—Custom cell rendering — also available as the projected [ogeCalendarCellTemplate] slot.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 4

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 9

OgeCalendar events

Name Type Description
cellClickOgeCalendarCellClickEventA day/month/year cell was activated — { date, view, event }.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

OgeDateBox

oge-date-box

Properties 49

OgeDateBox

Name Type DefaultDescription
dropdownPlacementOgePopupPlacement'bottom-start'Preferred popup side/alignment; flips when it would clip.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-screen dialog with 44px day cells on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
showDropDownButtonbooleantrueRenders the rail button that toggles the picker; the field click and the keyboard still open it when hidden.
valuemodel&lt;Date | null&gt;nullAlways a local Date — serialization is the app's concern (no dateSerializationFormat). CVA writes accept ISO-like strings and epoch numbers leniently.
type'date' | 'time' | 'datetime''date'Picker: calendar, interval time list, or both (no dx pickerType). The rail icon follows the type.
displayFormatIntl.DateTimeFormatOptions | ((d: Date) =&gt; string)—Display text; undefined = per-type Intl defaults. No format strings, no date library.
min / max / disabledDatesas OgeCalendar—Out-of-range typed text marks the field invalid — it is never clamped (unlike the number box).
intervalnumber30Time list step in minutes.
timeView'list' | 'columns''list'Time picker layout: one interval list, or hour + minute columns.
applyValueMode'instantly' | 'useButtons''instantly'OK/Cancel footer collects picker changes in a draft when useButtons.
acceptCustomValuebooleantruefalse makes the text read-only (picker input only).
openOnFieldClickbooleantrueClicking the field opens the picker.
firstDayOfWeek / showWeekNumbers / zoomLevel / calendarCellTemplate / localecalendar passthroughs—Exposed individually — no calendarOptions kitchen-sink object.
openedmodel&lt;boolean&gt;falsePicker visibility — two-way.

OgeDateRangeBox

Name Type DefaultDescription
valuemodel&lt;[Date | null, Date | null]&gt;[null, null]Start–end tuple on one field: two parsed inputs + a two-view range calendar popup. A reversed pair reorders on commit; either end may stay open.
type'date' | 'datetime''date''datetime' adds start/end time lists to the picker: day and time picks collect in a draft and commit together on OK; both sides parse and render times.
intervalnumber30Time list step in minutes (type: 'datetime').
min / max / disabledDates / firstDayOfWeek / showWeekNumbers / locale / displayFormat / openOnFieldClick / acceptCustomValueas OgeDateBox—Shared configuration surface.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-screen dialog showing one month, where picking both ends waits for an explicit Done that applies the range on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord&lt;string, string&gt;{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial&lt;OgeInputsMessages&gt; | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeDateBox methods

Name Type Description
open() / close() / toggle()voidPicker control (no-ops while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 9

OgeDateBox events

Name Type Description
dropDownOpened / dropDownClosedvoidPicker visibility changes, from any trigger.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

Types 2

Date types

Name Type Description
parseDateText(text, locale, kind, reference?)functionExported: locale-aware text → local Date | null via Intl part order — never Date.parse.
OgeDateBoxType / OgeDateBoxApplyValueMode / OgeDateBoxDisplayFormat / OgeDateBoxTimeViewtypesThe string unions and the display-format shape.

OgeColorBox

oge-color-box

Properties 46

OgeColorBox

Name Type DefaultDescription
dropdownPlacementOgePopupPlacement'bottom-start'Preferred popup side/alignment; flips when it would clip.
adaptiveMode / adaptiveBreakpoint'auto' | 'none' / numberconfig: 'none' / 600'auto' presents the popup as a full-width bottom sheet on viewports narrower than adaptiveBreakpoint px — a titled role="dialog" surface with a close button, scroll lock, inert background, a Tab trap, focus restore, safe-area insets and 16px / 44px touch sizing; Escape, a backdrop tap or a swipe down the handle dismiss it. 'none' keeps the anchored drop-down. App-wide defaults come from provideOgeInputsConfig().
showDropDownButtonbooleantrueRenders the rail button that toggles the picker; the field click and the keyboard still open it when hidden.
valuemodel&lt;string | null&gt;nullThe committed color as a CSS string, normalized to format on user commits. Programmatic writes keep any parseable CSS color verbatim (never reformatted); unparseable writes land as null.
format'hex' | 'rgb' | 'rgba' | 'hsl''hex'Committed string shape (hex — the DevExtreme default; Kendo defaults to rgba). Translucent colors widen to carry alpha: #rrggbbaa / rgba() / hsla().
view'gradient' | 'palette' | 'both''gradient'Popup surfaces: the saturation/brightness gradient with sliders and inputs, the swatch palette, or both stacked — no view switcher (Kendo's activeView is deliberately skipped).
editAlphaChannelbooleanfalseAdds the alpha slider + percent input and lets the output carry alpha. Without it, alpha is coerced to 1 on commit — rgba() text still parses.
applyValueMode'instantly' | 'useButtons''instantly'OK/Cancel footer collects panel interactions in a draft when useButtons; the default commits live (dragging streams through valueCommitted, throttled by debounce).
acceptCustomValuebooleantruefalse makes the text read-only (picker input only). Typed text parses any CSS color incl. the 148 named colors; unparseable text reverts on blur.
keyStepnumber5Arrow-key increment of the panel parts in value units — hue degrees, alpha percent, surface saturation/brightness percent. PageUp/PageDown move by 5× (value-space, not Kendo’s pixel steps — zoom-independent).
palettereadonly string[] | undefined—Palette swatches as CSS color strings; undefined renders the exported OGE_DEFAULT_COLOR_PALETTE. Unparseable entries are dropped.
paletteColumnsnumber10Swatch columns of the palette grid.
openOnFieldClickbooleantrueClicking the field opens the picker.
showDropDownButtonbooleantruefalse hides the rail chevron — field click and ArrowDown still open.
showEyedropperbooleantrueThe eyedropper button (pick a color from anywhere on screen) — rendered only in browsers shipping the EyeDropper API; progressive enhancement, no polyfill. The picked color keeps the working alpha.
openedmodel&lt;boolean&gt;falsePicker visibility — two-way.

Common — field chrome (all editors)

Name Type DefaultDescription
labelstring''Field label; placement follows labelMode.
labelModeOgeInputLabelMode'static'Label placement: static / floating / hidden (aria-only) / outside.
stylingModeOgeInputStylingMode'outlined'Container fill style.
sizeOgeInputSize'md'Container height preset — 28/34/42px, the button scale.
placeholderstring''Native placeholder text.
hintstring | undefined—Helper text in the subscript region (hidden while an error shows).
tooltipstring | undefined—Native title attribute of the input element.
subscriptSizingOgeInputSubscriptSizing'fixed'Whether the hint/error line reserves height, collapses, or is removed.
fluidbooleanfalseStretches the field to 100% width (default 240px via --oge-input-width).
widthnumber | string | undefined—This field’s width — a number is px, a string any CSS length. Sets --oge-input-width on this host only; fluid still wins.
showClearButtonbooleanfalseRenders the clear (✕) button while the field has a value.
showSuccessIconOgeInputShowSuccessIconfalseSuccess icon when valid: false / on touch / always.
idstring | undefined—Base for the generated element ids (input/label/hint/error/counter).
tabIndexnumber0Tab order of the native input.
autofocusbooleanfalseFocuses the editor after its first render.
selectOnFocusbooleanfalseSelects the whole text when the input receives focus.
inputAttrRecord&lt;string, string&gt;{}Escape hatch: extra attributes rendered onto the native input (template-owned attributes are ignored).
messagesPartial&lt;OgeInputsMessages&gt; | undefined—Per-instance overrides of user-facing strings.

Common — state & forms (all editors)

Name Type DefaultDescription
disabledbooleanfalseDisables the editor.
readonlybooleanfalseFocusable but not editable. (Contract name — not readOnly.)
requiredbooleanfalseMarks the field required (label asterisk + validation).
namestring''Native name attribute.
invalidbooleanfalseExternal invalid override — combined with forms state.
pendingbooleanfalseAsync-validation indicator; a spinner shows in the rail while true.
touchedbooleanfalseExternal touched override (Signal Forms contract).
dirtybooleanfalseExternal dirty override (Signal Forms contract).
errorsreadonly OgeFieldError[][]Signal Forms validation errors (auto-bound by [formField]).
errorTextstring | undefined—Explicit error message — always wins over resolved messages.
errorDisplayOgeInputErrorDisplay'touched'When resolved errors become visible.
debouncenumber | undefined—Commit delay in ms for value/forms updates; blur and Enter flush immediately.

Methods 5

OgeColorBox methods

Name Type Description
open() / close() / toggle()voidPicker control (no-ops while disabled/readonly).

Common (all editors)

Name Type Description
focus(): voidvoidMoves keyboard focus to the native input.
blur(): voidvoidBlurs the native input.
clear(): voidvoidClears the value (commits immediately), keeps focus in the field; no-op when disabled/readonly.
reset(value?: T): voidvoidReturns the field to pristine: sets value (default: empty), clears touched/dirty/parse errors, cancels pending commits. On a reactive-forms-bound editor resets the control itself.

Events 9

OgeColorBox events

Name Type Description
dropDownOpened / dropDownClosedvoidPicker visibility changes, from any trigger.

Common (all editors)

Name Type Description
valueCommittedOgeInputValueCommittedEvent&lt;T&gt;Every committed change with previousValue + originating DOM event (undefined for programmatic writes) — the reference onValueChanged shape.
inputChangeOgeInputRawEventRaw text on every keystroke, regardless of commit policy.
clearedvoidValue cleared via the clear button / clear().
enterKeyOgeInputKeyEventEnter pressed inside the editor (pending debounce is flushed first).
focusedOgeInputFocusEventThe editor received focus.
blurredOgeInputFocusEventThe editor lost focus.
touchvoidSignal Forms FormValueControl contract — emitted once per blur.
valueChangeTImplicit output of the value model.

Types 4

Color types

Name Type Description
OgeColorBoxView / OgeColorBoxApplyValueModetypesThe string unions of view and applyValueMode.
OGE_DEFAULT_COLOR_PALETTEreadonly string[]The built-in 50-swatch palette used when palette is not set.
Color messagesOgeInputsMessages keysAll popup strings localize through the family config: colorPickerLabel, hueSliderLabel/hueValueText, alphaSliderLabel/alphaValueText, colorSurfaceLabel/colorSurfaceRoleDescription/surfaceValueText, paletteLabel, the hex/R/G/B/A input labels, eyedropperButton and invalidColorError.
parseColor / formatColor / normalizeColor / rgbaToHsva / hsvaToRgba / relativeLuminance / contrastForeground / colorsEqual@oge-ui/coreThe DOM-free color kernel (OgeRgba / OgeHsva / OgeColorFormat): CSS color-text parsing, HSV↔RGB conversion, canonical formatting and the WCAG swatch-contrast decision — unit-tested without a DOM, the slider-math precedent.

Shared input types

Types 23

Unions & contracts

Name Type Description
OgeInputLabelMode'static' | 'floating' | 'hidden' | 'outside'hidden renders the label as aria-label only.
OgeInputStylingMode'outlined' | 'filled' | 'underlined'Container fill style.
OgeInputSize'sm' | 'md' | 'lg'28 / 34 / 42px heights.
OgeInputSubscriptSizing'fixed' | 'dynamic' | 'none'fixed reserves one line so errors never shift layout.
OgeInputErrorDisplay'touched' | 'dirty' | 'always'When resolved errors become visible.
OgeInputCounterMode'limit' | 'soft'soft allows typing past maxLength and colors the counter danger.
OgeInputShowSuccessIconfalse | 'touched' | 'always'Success-icon visibility policy.
OgeTextBoxMode'text' | 'email' | 'password' | 'search' | 'tel' | 'url'Native input type of the text box.
OgeNumberBoxMode'text' | 'tel'Native input type of the number box.
OgeFieldError{ kind: string; message?: string }Structural mirror of Signal Forms' ValidationError.

Event payloads

Name Type Description
OgeInputValueCommittedEvent&lt;T&gt;{ value: T; previousValue: T; event: Event | undefined }event === undefined means a programmatic change.
OgeInputRawEvent{ text: string; event: Event }Raw keystroke payload.
OgeInputKeyEvent{ event: KeyboardEvent }Enter-key payload.
OgeInputFocusEvent{ event: FocusEvent }Focus/blur payload.

Slots & helpers

Name Type Description
OgeInputPrefixdirective — [ogeInputPrefix]Leading adornment inside the field.
OgeInputSuffixdirective — [ogeInputSuffix]Trailing adornment; renders after the built-in rail buttons.
resolveErrorMessage(sfErrors, cvaErrors, messages)string | nullThe single message a field displays. Signal Forms errors win over reactive-forms errors, and an explicit message wins over the kind→message map. Exported so a form-level error summary reads exactly like the inline text.
formatPattern(pattern, values)stringInterpolates {token} placeholders in a message — the same contract the grid uses for its message patterns.
OgeInputCounterState{ count: number; max: number | undefined; over: boolean }Counter state rendered in the subscript end slot.
OgeInputRevealApi{ visible; active; toggle() }Password-reveal API (text box only).
OgeInputCopyApi{ visible; copied; trigger() }Copy-to-clipboard API (text box only).
OgeInputSpinApi{ visible; canUp; canDown; press(dir, event); release() }Spin-button API (number box only).
measureTextAreaHeight(el, minRows, maxRows?)numberFallback auto-resize measurement for browsers without CSS field-sizing: content.

Inputs configuration

Methods 1

Name Type Description
provideOgeInputsConfig(config: OgeInputsConfigInput): ProviderProviderApplication- or component-scoped defaults; deep-merges messages over the defaults.

Types 20

OgeInputsConfig

Name Type DefaultDescription
spinRepeatDelayMsnumber400Delay before spin buttons start repeating.
spinRepeatIntervalMsnumber80Interval between spin repeats.
copiedResetMsnumber2000How long the copy button shows "copied".
adaptiveMode'auto' | 'none''none'Default adaptiveMode of every popup editor (select box, tag box, autocomplete, tree select, date / date range / color box). 'none' keeps existing apps' anchored drop-downs; switch the whole family with 'auto'.
adaptiveBreakpointnumber600Viewport width (px) below which 'auto' presents popups as bottom sheets / full-screen dialogs.
messagesOgeInputsMessages—User-facing strings (see below).

OgeInputsMessages

Name Type DefaultDescription
clearButtonstring'Clear'Aria label of the clear (✕) button.
showPassword / hidePasswordstring'Show password' / 'Hide password'Reveal toggle aria labels.
copyButton / copiedstring'Copy to clipboard' / 'Copied'Copy button aria label and transient confirmation.
spinIncrement / spinDecrementstring'Increase value' / 'Decrease value'Aria labels of the spin buttons.
pending / validstring'Validating' / 'Valid'Screen-reader text next to the pending spinner / success icon.
counter / counterNoMaxstring'{count}/{max}' / '{count}'Visual counter patterns.
counterAria / counterAriaNoMaxstring'{count} of {max} characters used' / '{count} characters entered'Counter aria labels.
requiredErrorstring'This field is required'Resolved message for the required error kind.
emailErrorstring'Enter a valid email address'Resolved message for the email error kind.
minError / maxErrorstring'Value must be at least {min}' / '…at most {max}'Numeric bound errors.
minLengthError / maxLengthErrorstring'Enter at least {requiredLength} characters' / 'Enter no more than…'Length errors.
patternErrorstring'The value has an invalid format'Pattern mismatch.
invalidNumberErrorstring'Enter a valid number'Number box parse failure (reverts on blur).
invalidErrorstring'Invalid value'Fallback for unknown validation error kinds.

Notes

  • All editors implement both classic ControlValueAccessor and Signal Forms' FormValueControl — the readonly/errors/touch names are fixed by that contract.
  • (valueCommitted) is the reference onValueChanged equivalent; native keydown/paste/cut bubble from the inner input and can be bound on the host element directly.
  • The suffix rail order is a contract: prefix · input · pending⊻success · copy · reveal · clear · spin · suffix.