@serenity-is/corelib / QuickSearchInput

Class: QuickSearchInput<P>

Defined in: src/ui/datagrid/quicksearchinput.tsx:18

Extends

Widget<P>

Type Parameters

P

P extends QuickSearchInputOptions = QuickSearchInputOptions

Constructors

Constructor

new QuickSearchInput<P>(props): QuickSearchInput<P>

Defined in: src/ui/datagrid/quicksearchinput.tsx:30

Parameters

props

WidgetProps<P>

Returns

QuickSearchInput<P>

Overrides

Widget.constructor

Properties

domNode

readonly domNode: HTMLInputElement

Defined in: src/ui/datagrid/quicksearchinput.tsx:22

Overrides

Widget.domNode

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

Widget.idPrefix

options

protected readonly options: WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

Widget.options

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

Widget.uniqueName

[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/datagrid/quicksearchinput.tsx:19

Overrides

Widget.[typeInfo]

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

Widget.isComponent

Accessors

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

Widget.element

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

Widget.props

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

Widget.addCssClass

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

Widget.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

Widget.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

Widget.afterRender

byId()

protected byId<TElement>(id): Fluent<TElement>

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

Widget.byId

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.changeSelect2

checkIfValueChanged()

protected checkIfValueChanged(): void

Defined in: src/ui/datagrid/quicksearchinput.tsx:69

Returns

void

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

Widget.deferRender

destroy()

destroy(): void

Defined in: src/ui/widgets/widget.ts:42

Returns

void

Inherited from

Widget.destroy

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

Widget.findById

get_field()

get_field(): QuickSearchField

Defined in: src/ui/datagrid/quicksearchinput.tsx:98

Returns

QuickSearchField

get_value()

get_value(): string

Defined in: src/ui/datagrid/quicksearchinput.tsx:94

Returns

string

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

Widget.getCssClass

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

Widget.getCustomAttribute

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

Widget.getGridField

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

Widget.init

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

Widget.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

Widget.legacyTemplateRender

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

Widget.render

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

Widget.renderContents

restoreState()

restoreState(value, field): void

Defined in: src/ui/datagrid/quicksearchinput.tsx:115

Parameters

value

string

field

QuickSearchField

Returns

void

searchNow()

protected searchNow(value): void

Defined in: src/ui/datagrid/quicksearchinput.tsx:128

Parameters

value

string

Returns

void

set_field()

set_field(value): void

Defined in: src/ui/datagrid/quicksearchinput.tsx:102

Parameters

value

QuickSearchField

Returns

void

syncOrAsyncThen()

protected syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

Widget.syncOrAsyncThen

updateInputPlaceHolder()

protected updateInputPlaceHolder(): void

Defined in: src/ui/datagrid/quicksearchinput.tsx:111

Returns

void

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

create()

static create<TWidget, P>(params): TWidget

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

Widget.create

createDefaultElement()

static createDefaultElement(): HTMLInputElement

Defined in: src/ui/datagrid/quicksearchinput.tsx:21

Returns

HTMLInputElement

Overrides

Widget.createDefaultElement

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

Widget.getWidgetName

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

Widget.registerEditor