Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInterfaceSystem

UserInterfaceSystem can register and manage additional JSX

Note: Using UserInterfaceSystem is not recommended to use directly because it is using very low-level API. Consider using higher-level API like ToolbarSystem, NotificationSystem, etc. Note: UserInterfaceSystem is for JSX (HTML) vs. StyleSystem is for CSS styles

collboard-system

Hierarchy

  • AbstractSystem
    • UserInterfaceSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns UserInterfaceSystem

Properties

Private getPlaceStorage

getPlaceStorage: any

Private places

places: any

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Protected Readonly systems

systems: ISystemsExtended

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns UserInterfaceSystem

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

registerElement

  • registerElement(__namedParameters: Simplify<Except<IElementOptions, "order"> & Partial<Pick<IElementOptions, "order">>>): Registration

  • Register element that will be included in UI

    Note: Consider using higher-level API

    Parameters

    • __namedParameters: Simplify<Except<IElementOptions, "order"> & Partial<Pick<IElementOptions, "order">>>

    Returns Registration

render

  • Parameters

    Returns Element

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable