Class ComponentBuilder

constructor

• new ComponentBuilder(spec?: ComponentInput): ComponentBuilder

  Parameters

  • Optionalspec: ComponentInput

  Returns ComponentBuilder

Readonly[serializableMarker]

canHandleIntent

• canHandleIntent(canHandleIntent: IntentChecker): ComponentBuilder

  Parameters

  • canHandleIntent: IntentChecker

  Returns ComponentBuilder

child

• child(child: Child): ComponentBuilder

  Set Component child

  Parameters

  • child: Child

    child component

  Returns ComponentBuilder

  component builder based on child component provided

clone

• clone(withSpec?: BuildableComponent): ComponentBuilder

  Clone component builder (allows for options overriding)

  Parameters

  • OptionalwithSpec: BuildableComponent

    component builder options

  Returns ComponentBuilder

  cloned builder

component

• component(component: UserComponent): ComponentBuilder

  Set component

  Parameters

  • component: UserComponent

    user built component

  Returns ComponentBuilder

  component builder based on component provided

currentMaxWidth

• currentMaxWidth(currentMaxWidth: number): ComponentBuilder

  Set the maximum width of the component pane before it is manually resized

  Parameters

  • currentMaxWidth: number

    Maximum width in pixels before manual resizing

  Returns ComponentBuilder

  component builder with the current maximum width applied

getChild

• getChild(): Child

  Get Component child

  Returns Child

  child component

getComponent

• getComponent(): UserComponent

  Get Component

  Returns UserComponent

  component

getCurrentMaxWidth

• getCurrentMaxWidth(): number

  Get the maximum width of the component pane before it is manually resized

  Returns number

  current maximum width in pixels

getI18n

• getI18n(): I18nTextRecord<"title">

  Get i18n key and namespace used to populate the localized title

  Returns I18nTextRecord<"title">

  the i18n key and namespace used to populate the localized title

getId

• getId(): string

  Get ID

  Returns string

  ID

getMaxWidth

• getMaxWidth(): number

  Get the maximum width of the component pane

  Returns number

  maximum width in pixels

getMenuItemGroups

• getMenuItemGroups(): (MenuItemGroup | MenuItemGroupBuilder)[]

  Get Component menu item groups

  Returns (MenuItemGroup | MenuItemGroupBuilder)[]

  menu item groups

getMenuItems

• getMenuItems(): (MenuItem | MenuItemBuilder)[]

  Get Component menu items

  Returns (MenuItem | MenuItemBuilder)[]

  menu items

getMinWidth

• getMinWidth(): number

  Get the minimum width of the component pane

  Returns number

  minimum width in pixels

getOptions

• getOptions(): { [key: string]: unknown }

  Get Component options

  Returns { [key: string]: unknown }

  component options

getTitle

• getTitle(): string

  Get Component title

  Returns string

  title

i18n

• i18n(i18n: I18nTextRecord<"title">): ComponentBuilder

  Set the i18n key and namespace used to populate the localized title.

  Parameters

  • i18n: I18nTextRecord<"title">

    the key and namespaced used to populate the localized title.

  Returns ComponentBuilder

  component builder based on i18n key and ns provided

id

• id(id: string): ComponentBuilder

  Set Component ID

  Parameters

  • id: string

    component ID

  Returns ComponentBuilder

  component builder based on ID provided

maxWidth

• maxWidth(maxWidth: number): ComponentBuilder

  Set the maximum width of the component pane

  Parameters

  • maxWidth: number

    Maximum width in pixels

  Returns ComponentBuilder

  component builder with the maximum width applied

menuItemGroups

• menuItemGroups(
      menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[],
  ): ComponentBuilder

  Set Component menu item groups

  Parameters

  • menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[]

    component menu item groups

  Returns ComponentBuilder

  component builder based on menuItemGroups provided

menuItems

• menuItems(menuItems: (MenuItem | MenuItemBuilder)[]): ComponentBuilder

  Set Component menu items

  Parameters

  • menuItems: (MenuItem | MenuItemBuilder)[]

    component menu items

  Returns ComponentBuilder

  component builder based on menuItems provided

minWidth

• minWidth(minWidth: number): ComponentBuilder

  Set the minimum width of the component pane

  Parameters

  • minWidth: number

    Minimum width in pixels

  Returns ComponentBuilder

  component builder with the minimum width applied

options

• options(options: { [key: string]: unknown }): ComponentBuilder

  Set Component options

  Parameters

  • options: { [key: string]: unknown }

    component options

  Returns ComponentBuilder

  component builder based on options provided

serialize

• serialize(options?: SerializeOptions): Component

  Serialize component

  Parameters

  • options: SerializeOptions = ...

    serialization options

  Returns Component

  component object based on path provided in options

title

• title(title: string): ComponentBuilder

  Set Component title

  Parameters

  • title: string

    component title

  Returns ComponentBuilder

  component builder based on title provided (and ID)