carbon-components-svelte/src/IconIndicator/IconIndicator.svelte.d.ts

Svelte implementation of the Carbon Design System

import { SvelteComponentTyped } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";

type $RestProps = SvelteHTMLElements["div"];

type $Props = {
  /**
   * Specify the kind of the icon indicator.
   * @default undefined
   */
  kind: "failed" | "caution-major" | "caution-minor" | "undefined" | "succeeded" | "normal" | "in-progress" | "incomplete" | "not-started" | "pending" | "unknown" | "informative";

  /**
   * Specify the label displayed next to the icon.
   * @default undefined
   */
  label: string;

  /**
   * Specify the size of the icon indicator.
   * @default 16
   */
  size?: 16 | 20;

  labelChildren?: (this: void) => void;

  [key: `data-${string}`]: unknown;
};

export type IconIndicatorProps = Omit<$RestProps, keyof $Props> & $Props;

export default class IconIndicator extends SvelteComponentTyped<
  IconIndicatorProps,
  Record<string, any>,
  { labelChildren: Record<string, never> }
> {}