SearchFieldView.id
property · packages/mixins-ui/src/searchField.ts:91
readonly id: stringPrefixes the ids the field draws, unique on the page.
Mixins / foldkit-mixins-ui
interface · packages/mixins-ui/src/searchField.ts:89
interface SearchFieldView<Message> extends Adornments {
readonly id: string
readonly label: string
readonly value: string
readonly onInput: OnInput<NoInfer<Message>>
readonly clear?:
| {
readonly onClear: NoInfer<Message>
readonly content?: Html | undefined
}
| undefined
readonly busy?: boolean | undefined
readonly placeholder?: string | undefined
readonly invalid?: boolean | undefined
readonly disabled?: boolean | undefined
readonly words?: SearchFieldWords | undefined
readonly routes?: ReadonlyArray<Route<NoInfer<Message>>> | undefined
readonly style?: NamedStyle<typeof SearchFieldSlots> | undefined
readonly mixins?: MixinList<Message> | undefined
}SearchFieldView.idproperty · packages/mixins-ui/src/searchField.ts:91
readonly id: stringPrefixes the ids the field draws, unique on the page.
SearchFieldView.labelproperty · packages/mixins-ui/src/searchField.ts:93
readonly label: stringThe input's accessible name: a search field wears no visible label.
SearchFieldView.valueproperty · packages/mixins-ui/src/searchField.ts:94
readonly value: stringSearchFieldView.onInputproperty · packages/mixins-ui/src/searchField.ts:96
readonly onInput: OnInput<NoInfer<Message>>What typing sends; a resumable builder's OnInput attribute names it in the server's markup.
SearchFieldView.clearproperty · packages/mixins-ui/src/searchField.ts:102
readonly clear?:
| {
readonly onClear: NoInfer<Message>
readonly content?: Html | undefined
}
| undefinedThe clear button and Escape's clearing: with none, the field has neither.
onClear is sent by both on a field with text; answer it with Focus.
content is drawn in the button in place of the cross.
SearchFieldView.busyproperty · packages/mixins-ui/src/searchField.ts:106
readonly busy?: boolean | undefinedA search is running: aria-busy on the input and data-busy on the field. Compose a spinner into end.
SearchFieldView.placeholderproperty · packages/mixins-ui/src/searchField.ts:107
readonly placeholder?: string | undefinedSearchFieldView.invalidproperty · packages/mixins-ui/src/searchField.ts:108
readonly invalid?: boolean | undefinedSearchFieldView.disabledproperty · packages/mixins-ui/src/searchField.ts:110
readonly disabled?: boolean | undefinedA disabled field takes no text or keys and draws no clear button.
SearchFieldView.wordsproperty · packages/mixins-ui/src/searchField.ts:111
readonly words?: SearchFieldWords | undefinedSearchFieldView.routesproperty · packages/mixins-ui/src/searchField.ts:117
readonly routes?: ReadonlyArray<Route<NoInfer<Message>>> | undefinedKeys the application answers in the field, such as ArrowDown opening results. They share one keydown owner with Escape: a route on the same gesture as another is a diagnostic naming both.
SearchFieldView.styleproperty · packages/mixins-ui/src/searchField.ts:119
readonly style?: NamedStyle<typeof SearchFieldSlots> | undefinedA style of SearchFieldSlots, for the field's look.
SearchFieldView.mixinsproperty · packages/mixins-ui/src/searchField.ts:121
readonly mixins?: MixinList<Message> | undefinedMixins beside the style; an input-driven one reads the text.