@serenity-is/corelib / Widget
Class: Widget<P>
Type parameters
Name | Type |
---|---|
P |
Hierarchy
Table of contents
Constructors
Properties
Accessors
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
Properties
domNode
• Readonly
domNode: HTMLElement
Defined in
idPrefix
• Readonly
idPrefix: string
Defined in
options
• Protected
Readonly
options: WidgetProps
<P
>
Defined in
uniqueName
• Protected
Readonly
uniqueName: string
Defined in
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.Widget"
>
Defined in
Accessors
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Defined in
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Defined in
Methods
addCssClass
▸ addCssClass(): void
Returns
void
Defined in
addValidationRule
▸ addValidationRule(rule
, uniqueName?
): void
Parameters
Name | Type |
---|---|
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
uniqueName? |
string |
Returns
void
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Defined in
change
▸ change(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Defined in
changeSelect2
▸ changeSelect2(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Defined in
destroy
▸ destroy(): void
Returns
void
Defined in
getCssClass
▸ getCssClass(): string
Returns
string
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
Defined in
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Defined in
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Defined in
init
▸ init(): this
Returns
this
Defined in
internalInit
▸ internalInit(): void
Returns
void
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
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
Defined in
renderContents
▸ renderContents(): any
Returns
any
Defined in
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
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
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
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLElement
Returns
HTMLElement
Defined in
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string