@esri/calcite-components/dist/utils/config.d.ts

Web Components for Esri's Calcite Design System.

import type { FocusTrap } from "focus-trap";
import type { LogLevel } from "./logger.js";

/**
 * Exporting for testing purposes only
 *
 * @internal
 */
export const defaultConfig: CalciteConfig;

/**
 * Clears the effective config so it will be recomputed on next getConfig().
 *
 * This is primarily intended for testing purposes.
 *
 * @internal
 */
export function clearConfig(): void;

/**
 * Returns the effective config.
 *
 * @internal
 */
export function getConfig(): CalciteConfig;

export interface CalciteConfig {
  /**
   * Defines the global trap stack to use for focus-trapping components.
   *
   * This is useful if your application uses its own instance of `focus-trap` and both need to be aware of each other.
   *
   * @see [focus-trap createOptions](https://github.com/focus-trap/focus-trap#createoptions).
   */
  focusTrapStack: FocusTrap[];
  /** Defines the global log level to use when logging messages. */
  logLevel: LogLevel;
  /** Contains the version of the Calcite components. */
  readonly version?: string;
}