Interface IRenderable

Interface for objects that can be rendered in the UI.

interface IRenderable {
    boundView: undefined | IHosannaView<ViewState>;
    div: undefined | HTMLDivElement;
    mount(): void;
    render(): void;
    showDebugBounds(show: boolean): void;
    unmount(): void;
}

Hierarchy (View Summary)

IRenderable
- ISGROSGNode

Index

Properties

boundView div

Methods

mount render showDebugBounds unmount

Properties

boundView

boundView: undefined | IHosannaView<ViewState>

The view instance bound to this renderable.

div

div: undefined | HTMLDivElement

The root HTML div element for this renderable, if any.

Methods

mount

mount(): void
Mounts the renderable to the DOM or parent node.

Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/renderer-api.ts:26

render

render(): void
Renders the current state of the renderable.

Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/renderer-api.ts:22

showDebugBounds

showDebugBounds(show: boolean): void
Shows or hides debug bounds for this renderable.
Parameters
- show: boolean
  Whether to show debug bounds.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/renderer-api.ts:18

unmount

unmount(): void
Unmounts the renderable from the DOM or parent node.

Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/renderer-api.ts:30

Interface IRenderable

Hierarchy (View Summary)

Index

Properties

Methods

Properties

boundView

div

Methods

mount

Returns void

render

Returns void

showDebugBounds

Parameters

Returns void

unmount

Returns void

Settings

On This Page