Class Zones

constructor

• new Zones(): Zones

• Returns Zones

[INITIALIZED]

[ZONES]

defaultControls

[FILTER]

• [FILTER](zoneRegistrations, zone): ComponentRegistration<any>[]

• Parameters

  • zoneRegistrations: ComponentRegistration<any>[]
  • zone: string

  Returns ComponentRegistration<any>[]

[MAP]

• [MAP](zoneRegistrations, zone): ComponentRegistration<any>[]

• Parameters

  • zoneRegistrations: ComponentRegistration<any>[]
  • zone: string

  Returns ComponentRegistration<any>[]

[SORT]

• [SORT](zoneRegistrations, zone): ComponentRegistration<any>[]

• Parameters

  • zoneRegistrations: ComponentRegistration<any>[]
  • zone: string

  Returns ComponentRegistration<any>[]

[UNSUBSCRIBE]

• [UNSUBSCRIBE](id): void

• Parameters

  • id: any

  Returns void

[UPDATE]

• [UPDATE](zone): void

• Parameters

  • zone: string

  Returns void

_addComponent

• _addComponent<P>(registration): string

• Type Parameters

  • P = any

  Parameters

  • registration: ComponentRegistration<P>

  Returns string

addComponent

• addComponent<P>(zone, component, props?, update?, id?): string

• Add a component to the zone.

  Type Parameters

  • P = any

  Parameters

  • zone: string | string[]

    The zone(s) to add the component to.
  • component: ComponentType<P>

    The component to add.
  • Optional props: P

    Additional properties for the component.
  • Optional update: boolean

    Whether to update the component if it already exists.
  • Optional id: string

    The ID of the component. If not provided, a UUID will be generated.

  Returns string

  The ID of the added component.
• addComponent<P>(registration): any

• Add a component to the zone.

  Type Parameters

  • P = any

  Parameters

  • registration: ComponentRegistration<P>

    The registration details of the component.

  Returns any

  The ID of the added component.

addControl

• addControl(type, zone, argument, order?): string

• Add a control to a zone.

  Parameters

  • type: ZoneControlType

    The type of the control.
  • zone: string

    The name of the zone.
  • argument: ZoneControl

    The control to add.
  • Optional order: Priority = Enums.priority.neutral

    The order of the control.

  Returns string

  The ID of the added control.

addFilter

• addFilter(zone, argument, order?): string

• Add a filter to a zone.

  Parameters

  • zone: string

    The name of the zone.
  • argument: ZoneFilter

    The filter to add.
  • Optional order: Priority = Enums.priority.neutral

    The order of the filter.

  Returns string

  The ID of the added filter.

addMapper

• addMapper(zone, argument, order): string

• Add a mapper to a zone.

  Parameters

  • zone: string

    The name of the zone.
  • argument: ZoneMap

    The mapper to add.
  • order: any

    The order of the mapper.

  Returns string

  The ID of the added mapper.

addSort

• addSort(zone, sortBy?, reverse?, order): string

• Add an underscore sorter to a zone.

  Parameters

  • zone: string

    The name of the zone.
  • Optional sortBy: string = 'order'

    The property to sort by.
  • Optional reverse: boolean = false

    Whether to reverse the sort order.
  • order: any

    The order of the sorter.

  Returns string

  The ID of the added sorter.

getZoneComponent

• getZoneComponent(zone, id): undefined | ComponentRegistration<any>

• Get a specific component from a zone.

  Parameters

  • zone: any

    The name of the zone.
  • id: any

    The ID of the component to get.

  Returns undefined | ComponentRegistration<any>

  The component with the given ID, or undefined if no such component exists.

getZoneComponents

• getZoneComponents(zone, raw?): ComponentRegistration<any>[]

• Get all components from a zone.

  Parameters

  • zone: string

    The name of the zone.
  • raw: boolean = false

  Returns ComponentRegistration<any>[]

  An array of components in the specified zone.

hasZoneComponent

• hasZoneComponent(zone, id): boolean

• Check if a specific component exists in a zone.

  Parameters

  • zone: any

    The name of the zone.
  • id: any

    The ID of the component to check.

  Returns boolean

  True if the component exists in the zone, false otherwise.

init

• init(): Promise<undefined | any[]>

• Setup default controls and components.

  Returns Promise<undefined | any[]>

  The IDs of the added components.

  Throws

  If components are not an array of objects.

removeComponent

• removeComponent(id): void

• Remove a component from the zone.

  Parameters

  • id: string

    The ID of the component to remove.

  Returns void

  Throws

  If the component with the given ID does not exist.

removeControl

• removeControl(id): void

• Remove a control from a zone.

  Parameters

  • id: string

    The ID of the control to remove.

  Returns void

removeFilter

• removeFilter(id): void

• Remove a filter from a zone.

  Parameters

  • id: string

    The ID of the filter to remove.

  Returns void

removeMapper

• removeMapper(id): void

• Remove a mapper from a zone.

  Parameters

  • id: string

    The ID of the mapper to remove.

  Returns void

removeSort

• removeSort(id): void

• Remove a sorter from a zone.

  Parameters

  • id: string

    The ID of the sorter to remove.

  Returns void

reset

• reset(init?): void

• Parameters

  • init: boolean = true

  Returns void

subscribe

• subscribe(zone, cb): (() => void)

• Subscribe to changes in a zone.

  Parameters

  • zone: string

    The name of the zone.
  • cb: Function

    The callback function to call when the zone changes.

  Returns (() => void)

  A function that, when called, will unsubscribe the callback from the zone.

  • • (): void

    • Returns void

updateComponent

• updateComponent<P>(id, updates): string

• Update a component in the zone.

  Type Parameters

  • P = any

  Parameters

  • id: string

    The ID of the component to update.
  • updates: ComponentRegistration<P>

    The updates to apply to the component.

  Returns string

  The ID of the updated component.

  Throws

  If the component with the given ID does not exist.