Mark the container configuration as abstract so it cannot be instantiated. This is useful for defining base configurations that other containers can inherit from using extends.
Containers that are not intended to be instantiated should always be abstract, since the configuration validation will fail for any non-abstract container with incomplete configuration.
The container is not abstract if not configured.
OptionalisAbstract: booleanWhether the container is abstract. Defaults to true.
Align content horizontally when it is smaller than the container.
For grouped placement results, this aligns the group as a whole.
Defaults to 'center' if not configured.
The horizontal alignment.
Restrict the container to named viewport breakpoints configured with ConfigBuilder.addBreakpoint. This means that the container will only load when the viewport fulfills certain width conditions.
No breakpoints are applied if not configured, meaning the container can load at any viewport width.
Breakpoint names.
Enable or disable the container. Disabled containers are not instantiated.
The container is enabled if not configured.
OptionalisEnabled: booleanWhether the container is enabled. Defaults to true.
Inherit all settings except abstract from another container. Any container can be extended, abstract or not, and inheritance can be chained across multiple containers.
A setting configured in the extending container takes precedence; otherwise, it is inherited from the parents recursively. Settings are replaced as a whole, meaning Array and Object type settings are not deep-merged.
No inheritance is applied if not configured.
The name of the configuration to inherit from.
Postpone loading the container until it is likely that it will be viewable. The container will load when the user scrolls towards it or when it is in the viewport. The distance can be set using lazyDistance.
Lazy loading is disabled if not configured.
OptionalisLazy: booleanWhether lazy loading is enabled. Defaults to false.
Set how close to the viewport a lazy container must be before it loads.
Defaults to 100px if not configured.
An integer distance from the viewport, in pixels, from 0 to 1000 inclusive.
Limit the container content width in pixels. For grouped placement results, this limits the group as a whole rather than each item individually.
No width limit is applied if not configured, meaning the content can expand horizontally to fill the available space.
A non-negative integer maximum content width in pixels.
Include or exclude the container from the ADK Panel. Excluding is useful for utility containers, e.g. for ad marking, that would otherwise clutter the panel.
The container is included in the panel if not configured.
OptionalisPanel: booleanWhether the container is included in the panel. Defaults to true.
Set parameters passed to the configured provider when the container loads or unloads content.
Defaults to {} if not configured.
The parameters to pass to the provider.
Select the provider that loads content into the container. Configure the provider-specific parameters using params.
Defaults to adk.placement if not configured.
The provider ID.
Keep the container in the viewport as the visitor scrolls, within its parent by default. Use stickyMarginBottom, stickyMarginTop, stickyTop and stickyZIndex to customize the sticky behavior.
Sticky behavior is disabled if not configured.
OptionalisSticky: booleanWhether sticky behavior is enabled. Defaults to true.
Set the bottom margin for the sticky container's outer position.
Bottom margin is 0 if not configured.
A non-negative integer bottom margin.
Set the top margin for the sticky container's outer position.
Top margin is 0 if not configured.
A non-negative integer top margin.
Use another element to limit the sticky container's top position instead of its parent.
Defaults to the container's parent if not configured.
The selector for the limiting element.
Set the stacking order while the sticky container is fixed.
If not configured, containers will use the value configured by ContainerConfigurator.zIndex while fixed.
An integer fixed-position stacking order.
Set the stacking order of the container. Use the stickyZIndex option to set the stacking order while a sticky container is fixed.
Defaults to auto if not configured.
An integer stacking order.
Configures how an ADK container is instantiated and loads content.
Chain the methods to set the container's options, then pass the configurator as the second argument to ConfigBuilder.addContainer.