@serenity-is/corelib / QuickFilterBar

Class: QuickFilterBar<P>

Type parameters

Name	Type
P	extends QuickFilterBarOptions = QuickFilterBarOptions

Hierarchy

• Widget<P>

  ↳ QuickFilterBar

Table of contents

Constructors

• constructor

Properties

• domNode
• idPrefix
• onChange
• options
• uniqueName
• typeInfo

Accessors

• element
• props

Methods

• add
• addBoolean
• addCssClass
• addDateRange
• addDateTimeRange
• addSeparator
• addValidationRule
• add_submitHandlers
• change
• changeSelect2
• clear_submitHandlers
• destroy
• find
• getCssClass
• getCustomAttribute
• getFieldElement
• getGridField
• init
• internalInit
• internalRenderContents
• onSubmit
• remove_submitHandlers
• render
• renderContents
• syncOrAsyncThen
• tryFind
• useIdPrefix
• boolean
• create
• createDefaultElement
• dateRange
• dateTimeRange
• getWidgetName

Constructors

constructor

• new QuickFilterBar<P>(props): QuickFilterBar<P>

Type parameters

Name	Type
P	extends QuickFilterBarOptions = QuickFilterBarOptions

Parameters

Name	Type
props	WidgetProps<P>

Returns

QuickFilterBar<P>

Overrides

Widget.constructor

Defined in

src/ui/datagrid/quickfilterbar.ts:22

Properties

domNode

• Readonly domNode: HTMLElement

Inherited from

Widget.domNode

Defined in

src/ui/widgets/widget.ts:18

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

onChange

• onChange: (e: Event) => void

Type declaration

▸ (e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:338

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:15

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

Widget.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

Widget.props

Defined in

src/ui/widgets/widget.ts:182

Methods

add

▸ add<TWidget, TOptions>(opt): TWidget

Type parameters

Name	Type
TWidget	extends Widget<any>
TOptions	TOptions

Parameters

Name	Type
opt	QuickFilter<TWidget, TOptions>

Returns

TWidget

Defined in

src/ui/datagrid/quickfilterbar.ts:40

---

addBoolean

▸ addBoolean(field, title?, yes?, no?): SelectEditor<SelectEditorOptions>

Parameters

Name	Type
field	string
title?	string
yes?	string
no?	string

Returns

SelectEditor<SelectEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:303

---

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addDateRange

▸ addDateRange(field, title?): DateEditor<DateEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

DateEditor<DateEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:143

---

addDateTimeRange

▸ addDateTimeRange(field, title?): DateTimeEditor<DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

DateTimeEditor<DateTimeEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:220

---

addSeparator

▸ addSeparator(): void

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:36

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

add_submitHandlers

▸ add_submitHandlers(action): void

Parameters

Name	Type
action	(request: ListRequest) => void

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:351

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

clear_submitHandlers

▸ clear_submitHandlers(): void

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:359

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/datagrid/quickfilterbar.ts:342

---

find

▸ find<TWidget>(type, field): TWidget

Type parameters

Name
TWidget

Parameters

Name	Type
type	(...args: any[]) => TWidget
field	string

Returns

TWidget

Defined in

src/ui/datagrid/quickfilterbar.ts:362

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

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

Widget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

init

▸ init(): this

Returns

this

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

Widget.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

Widget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

onSubmit

▸ onSubmit(request): void

Parameters

Name	Type
request	ListRequest

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:347

---

remove_submitHandlers

▸ remove_submitHandlers(action): void

Parameters

Name	Type
action	(request: ListRequest) => void

Returns

void

Defined in

src/ui/datagrid/quickfilterbar.ts:355

---

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

Widget.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

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

Widget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

tryFind

▸ tryFind<TWidget>(type, field): TWidget

Type parameters

Name
TWidget

Parameters

Name	Type
type	(...args: any[]) => TWidget
field	string

Returns

TWidget

Defined in

src/ui/datagrid/quickfilterbar.ts:366

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

boolean

▸ boolean(field, title?, yes?, no?): QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Parameters

Name	Type
field	string
title?	string
yes?	string
no?	string

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:307

---

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

Widget.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

dateRange

▸ dateRange(field, title?): QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:147

---

dateTimeRange

▸ dateTimeRange(field, title?, useUtc?): QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string
useUtc?	boolean

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Defined in

src/ui/datagrid/quickfilterbar.ts:224

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95