Interface ContainerApi

Hierarchy

Refreshable
- ContainerApi

Implemented by

Index

Properties

children

Methods

add addBinding addBlade addButton addFolder addTab refresh remove

Properties

`Readonly` children

children: BladeApi<BladeController<View>>[]

Children of the container.

Methods

add

add(api: BladeApi<BladeController<View>>, opt_index?: number): void
Parameters
- api: BladeApi<BladeController<View>>
- Optional opt_index: number
Returns void
- Defined in core/src/blade/common/api/container.ts:25

addBinding

addBinding<O, Key>(object: O, key: Key, opt_params?: BindingParams): BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>
Creates a new binding and add it to the container.

Returns
The API object.
Type Parameters
- O extends Bindable
- Key extends string | number | symbol
Parameters
- object: O
  
  The binding target.
- key: Key
  
  The key of the target property.
- Optional opt_params: BindingParams
  
  The options of a binding.
Returns BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>
- Defined in core/src/blade/common/api/container.ts:35

addBlade

addBlade(params: BaseBladeParams): BladeApi<BladeController<View>>
Creates a new blade and add it to the container.
Parameters
- params: BaseBladeParams
  
  The options for a blade.
Returns BladeApi<BladeController<View>>
- Defined in core/src/blade/common/api/container.ts:45

refresh

refresh(): void
Refreshes the target.

Returns void
Inherited from Refreshable.refresh
- Defined in core/src/blade/common/api/refreshable.ts:7

remove

remove(api: BladeApi<BladeController<View>>): void
Parameters
- api: BladeApi<BladeController<View>>
Returns void
- Defined in core/src/blade/common/api/container.ts:26

Interface ContainerApi

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly children

Methods

add

Parameters

api: BladeApi<BladeController<View>>

Optional opt_index: number

Returns void

addBinding

Returns

Type Parameters

O extends Bindable

Key extends string | number | symbol

Parameters

object: O

key: Key

Optional opt_params: BindingParams

Returns BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>

addBlade

Parameters

params: BaseBladeParams

Returns BladeApi<BladeController<View>>

addButton

Parameters

params: ButtonParams

Returns ButtonApi

addFolder

Parameters

params: FolderParams

Returns FolderApi

addTab

Parameters

params: TabParams

Returns TabApi

refresh

Returns void

remove

Parameters

api: BladeApi<BladeController<View>>

Returns void

Settings

Member Visibility

Theme

`Readonly` children

`Optional` opt_index: number

`Optional` opt_params: BindingParams