Skip to content

global config

Ben Elan edited this page Oct 16, 2024 · 1 revision

tags: [developer, conventions]

Global config

The calciteConfig global was introduced to allow for runtime configuration of calcite-components.

It is using a global to support both the lazy-loaded and non-lazy-loaded output targets. This also aligns with the Maps SDK config pattern.

Currently, the root of the config object is reserved for options specific to the calcite-components package.

window.calciteConfig = {
  // calcite-component options
};

Once there is a need for additional package options, these will be added as nested objects within the global config.

window.calciteConfig = {
  // calcite-component options

  // note: this is just an example and not the definitive structure for future package options
  "some-calcite-design-system-package": {
    // package options
  },
};