Lilact
    Preparing search index...

    Class RootComponent

    RootComponent

    // Accept an element reference
    const root = document.getElementById('app')
    const app = new RootComponent(root, { children: [...] })

    // Or accept a selector string
    const app2 = new RootComponent('#app', { children: [...] })

    Root HTML element (or a selector string resolved via document.querySelector).

    Root props used to configure how children are provided and attached (typically includes props.children).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    displayName

    Accessors

    context key props ref state type

    Methods

    forceUpdate render setState

    Constructors

    Properties

    displayName: string = "Root"

    The displayed name for the component. It is overridable. It can also be set for function components.

    Accessors

    • get context(): any
      Protected

      Component context.

      Returns any

    • set context(v: any): void

      Parameters

      • v: any

      Returns void

    • get key(): string | number

      A unique identifier for the component instance. The key is immutable and can only be set when the component is declared.

      Returns string | number

    • set key(v: string | number): void

      Parameters

      • v: string | number

      Returns void

    • get props(): any

      Props passed into the component instance. Use it as read-only input when rendering.

      Returns any

    • set props(v: any): void

      Parameters

      • v: any

      Returns void

    • get ref(): any

      A reference associated with the component to be used with useRef. Can be used to expose the component instance or an underlying DOM node.

      Returns any

    • set ref(v: any): void

      Parameters

      • v: any

      Returns void

    • get state(): object

      Component state used to drive rendering. Update it with setState() to trigger a re-render.

      Returns object

    • set state(v: object): void

      Parameters

      • v: object

      Returns void

    • get type(): any

      Component context value. Use it to access shared data provided by an outer component/system.

      Returns any

    • set type(v: any): void

      Parameters

      • v: any

      Returns void

    Methods

    • Force the component to re-render even if no state/props change. Useful for imperative updates.

      Parameters

      • callback: any

      Returns void

    • Update component state. Accepts a partial state (or a function returning partial state) and schedules a re-render.

      Parameters

      • next_state: any
      • callback: any

        to called after updates.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods