Interface ConfigBuilder

Builds an ADK configuration. Register breakpoints, containers, and templates by chaining method calls before initialization.

interface ConfigBuilder {
    addBreakpoint(name: string, width: number): ConfigBuilder;
    addContainer(name: string, container: ContainerConfigurator): ConfigBuilder;
    addTemplate(name: string, template: TemplateConfigurator): ConfigBuilder;
    init(publisherId: string): void;
}

Index

Methods

addBreakpoint addContainer addTemplate init

Methods

addBreakpoint

addBreakpoint(name: string, width: number): ConfigBuilder
Define a named viewport breakpoint.
Parameters
- name: string
  The breakpoint name. Referenced by containers in ContainerConfigurator.breakpoints.
- width: number
  The minimum viewport width in pixels for the breakpoint.
Returns ConfigBuilder

addContainer

addContainer(name: string, container: ContainerConfigurator): ConfigBuilder
Register a container configuration.
Parameters
- name: string
  The container name. By default, this is used as the PlacementProviderParams.name by the adk.placement provider.
- container: ContainerConfigurator
  The container configuration.
Returns ConfigBuilder

addTemplate

addTemplate(name: string, template: TemplateConfigurator): ConfigBuilder
Register a template configuration.
Parameters
- name: string
  The template name.
- template: TemplateConfigurator
  The template configuration.
Returns ConfigBuilder

init

init(publisherId: string): void
Initialize ADK for a publisher after registering all breakpoints, containers, and templates.
Parameters
- publisherId: string
  The publisher ID.
Returns void