Class BaseWidget<P>`Abstract`

Optional parity with Angular BaseWidget for class-based widget components. For functional components, prefer useWidgetSerializer instead.

Type Parameters

P extends Record<string, unknown> = Record<string, unknown>

Hierarchy

Component<P>
- BaseWidget

Index

Constructors

Methods

serialize deserialize render

Properties

Constructors

constructor

new BaseWidget<P extends Record<string, unknown> = Record<string, unknown>>(
props: P,
): BaseWidget<P>
Type Parameters
- P extends Record<string, unknown> = Record<string, unknown>
Parameters
- props: P
Returns BaseWidget<P>
Inherited from Component<P>.constructor
- Defined in react/node_modules/@types/react/ts5.0/index.d.ts:1003
new BaseWidget<P extends Record<string, unknown> = Record<string, unknown>>(
props: P,
context: any,
): BaseWidget<P>
Type Parameters
- P extends Record<string, unknown> = Record<string, unknown>
Parameters
- props: P
- context: any
Returns BaseWidget<P>
Deprecated
See
React Docs
Inherited from Component<P>.constructor
- Defined in react/node_modules/@types/react/ts5.0/index.d.ts:1008

Methods

serialize

serialize(): undefined | Record<string, unknown>
Returns undefined | Record<string, unknown>
- Defined in react/projects/lib/src/base-widget.tsx:14

deserialize

deserialize(_: GridStackWidget): void
Optional override — restore widget-specific state from saved layout.
Parameters
- _: GridStackWidget
Returns void
- Defined in react/projects/lib/src/base-widget.tsx:20

render

render(): ReactNode
Returns ReactNode
Overrides Component.render
- Defined in react/projects/lib/src/base-widget.tsx:24

Properties

`Optional`widgetItem

widgetItem?: GridStackWidget

Populated by the grid when restoring from saved layout (subclasses may read in lifecycle).