@serenity-is/corelib / Widget

Class: Widget<P>

Type parameters

Name	Type
P

Hierarchy

• Widget

  ↳ EditorWidget

  ↳ Toolbar

  ↳ TemplatedWidget

  ↳ PropertyGrid

  ↳ ComboboxEditor

  ↳ QuickFilterBar

  ↳ QuickSearchInput

  ↳ SlickPager

  ↳ DataGrid

Table of contents

Constructors

• constructor

Properties

• domNode
• idPrefix
• options
• uniqueName
• typeInfo

Accessors

• element
• props

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getCustomAttribute
• getFieldElement
• getGridField
• init
• internalInit
• internalRenderContents
• render
• renderContents
• syncOrAsyncThen
• useIdPrefix
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

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

Type parameters

Name	Type
P

Parameters

Name	Type
props	WidgetProps<P>

Returns

Widget<P>

Defined in

src/ui/widgets/widget.ts:20

Properties

domNode

• Readonly domNode: HTMLElement

Defined in

src/ui/widgets/widget.ts:18

---

idPrefix

• Readonly idPrefix: string

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<P>

Defined in

src/ui/widgets/widget.ts:15

---

uniqueName

• Protected Readonly uniqueName: string

Defined in

src/ui/widgets/widget.ts:16

---

typeInfo

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

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Defined in

src/ui/widgets/widget.ts:182

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:71

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

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

Returns

void

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

Defined in

src/ui/widgets/widget.ts:100

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:49

---

getCssClass

▸ getCssClass(): string

Returns

string

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

Defined in

src/ui/widgets/widget.ts:138

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Defined in

src/ui/widgets/widget.ts:110

---

init

▸ init(): this

Returns

this

Defined in

src/ui/widgets/widget.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:169

---

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

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

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

Defined in

src/ui/widgets/widget.ts:186

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Defined in

src/ui/widgets/widget.ts:193

---

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

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Defined in

src/ui/widgets/widget.ts:95