@serenity-is/corelib / Widget

Class: Widget<P>

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

Extended by

• DataGrid
• QuickFilterBar
• QuickSearchInput
• SlickPager
• BaseDialog
• EditorWidget
• FilterWidgetBase
• BasePanel
• PropertyGrid
• Toolbar

Type Parameters

P

P = { }

Constructors

Constructor

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

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

Parameters

props

WidgetProps<P>

Returns

Widget<P>

Properties

domNode

readonly domNode: HTMLElement

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

---

idPrefix

readonly idPrefix: string

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

---

options

protected readonly options: WidgetProps<P>

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

---

uniqueName

readonly uniqueName: string

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

---

[typeInfo]

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

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

---

isComponent

readonly static isComponent: true = true

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

Accessors

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

---

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Methods

addCssClass()

protected addCssClass(): void

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

Returns

void

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

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

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Call Signature

addValidationRule(uniqueName, rule): void

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

Parameters

uniqueName

string

rule

(input) => string

Returns

void

---

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

---

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>

---

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

---

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

---

deferRender()

protected deferRender(): boolean

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

Returns

boolean

---

destroy()

destroy(): void

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

Returns

void

---

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

---

getCssClass()

protected getCssClass(): string

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

Returns

string

---

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

---

getGridField()

getGridField(): Fluent

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

Returns

Fluent

---

init()

init(): this

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

Returns

this

---

internalRenderContents()

internalRenderContents(): void

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

Returns

void

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

---

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

---

renderContents()

protected renderContents(): any

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

Returns

any

---

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

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

---

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

---

createDefaultElement()

static createDefaultElement(): HTMLElement

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

Returns

HTMLElement

---

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

---

registerClass()

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

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

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

---

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>