@serenity-is/corelib / QuickSearchInput
Class: QuickSearchInput<P>
Type parameters
Name | Type |
---|---|
P |
extends QuickSearchInputOptions = QuickSearchInputOptions |
Hierarchy
Widget
<P
>↳
QuickSearchInput
Table of contents
Constructors
Properties
Accessors
Methods
- addCssClass
- addValidationRule
- change
- changeSelect2
- checkIfValueChanged
- destroy
- getCssClass
- getCustomAttribute
- getFieldElement
- getGridField
- get_field
- get_value
- init
- internalInit
- internalRenderContents
- render
- renderContents
- restoreState
- searchNow
- set_field
- syncOrAsyncThen
- updateInputPlaceHolder
- useIdPrefix
- create
- createDefaultElement
- getWidgetName
Constructors
constructor
• new QuickSearchInput<P
>(props
): QuickSearchInput
<P
>
Type parameters
Name | Type |
---|---|
P |
extends QuickSearchInputOptions = QuickSearchInputOptions |
Parameters
Name | Type |
---|---|
props |
WidgetProps <P > |
Returns
Overrides
Defined in
src/ui/datagrid/quicksearchinput.ts:29
Properties
domNode
• Readonly
domNode: HTMLInputElement
Overrides
Defined in
src/ui/datagrid/quicksearchinput.ts:21
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
options
• Protected
Readonly
options: WidgetProps
<P
>
Inherited from
Defined in
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.Widget"
>
Inherited from
Defined in
Accessors
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Inherited from
Widget.element
Defined in
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
Widget.props
Defined in
Methods
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addValidationRule
▸ addValidationRule(rule
, uniqueName?
): void
Parameters
Name | Type |
---|---|
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
uniqueName? |
string |
Returns
void
Inherited from
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
Defined in
change
▸ change(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
checkIfValueChanged
▸ checkIfValueChanged(): void
Returns
void
Defined in
src/ui/datagrid/quicksearchinput.ts:84
destroy
▸ destroy(): void
Returns
void
Inherited from
Defined in
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
getCustomAttribute
▸ getCustomAttribute<TAttr
>(attrType
, inherit?
): TAttr
Type parameters
Name |
---|
TAttr |
Parameters
Name | Type | Default value |
---|---|---|
attrType |
(...args : any []) => TAttr |
undefined |
inherit |
boolean |
true |
Returns
TAttr
Inherited from
Defined in
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
get_field
▸ get_field(): QuickSearchField
Returns
Defined in
src/ui/datagrid/quicksearchinput.ts:113
get_value
▸ get_value(): string
Returns
string
Defined in
src/ui/datagrid/quicksearchinput.ts:109
init
▸ init(): this
Returns
this
Inherited from
Defined in
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
Defined in
render
▸ render(): any
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
Defined in
renderContents
▸ renderContents(): any
Returns
any
Inherited from
Defined in
restoreState
▸ restoreState(value
, field
): void
Parameters
Name | Type |
---|---|
value |
string |
field |
QuickSearchField |
Returns
void
Defined in
src/ui/datagrid/quicksearchinput.ts:130
searchNow
▸ searchNow(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/datagrid/quicksearchinput.ts:143
set_field
▸ set_field(value
): void
Parameters
Name | Type |
---|---|
value |
QuickSearchField |
Returns
void
Defined in
src/ui/datagrid/quicksearchinput.ts:117
syncOrAsyncThen
▸ syncOrAsyncThen<T
>(syncMethod
, asyncMethod
, then
): void
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
syncMethod |
() => T |
asyncMethod |
() => PromiseLike <T > |
then |
(v : T ) => void |
Returns
void
Inherited from
Defined in
updateInputPlaceHolder
▸ updateInputPlaceHolder(): void
Returns
void
Defined in
src/ui/datagrid/quicksearchinput.ts:126
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
create
▸ create<TWidget
, P
>(params
): TWidget
Type parameters
Name | Type |
---|---|
TWidget |
extends Widget <P > |
P |
P |
Parameters
Name | Type |
---|---|
params |
CreateWidgetParams <TWidget , P > |
Returns
TWidget
Inherited from
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLInputElement
Returns
HTMLInputElement
Overrides
Defined in
src/ui/datagrid/quicksearchinput.ts:20
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string