carbon-components-svelte/src/ListBox/ListBoxSelection.svelte.d.ts

Svelte implementation of the Carbon Design System

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

export type ListBoxSelectionTranslationId = "clearAll" | "clearSelection";

type $RestProps = SvelteHTMLElements["div"];

type $Props = {
  /**
   * Specify the number of selected items.
   * @default undefined
   */
  selectionCount?: number;

  /**
   * Set to `true` to disable the list box selection
   * @default false
   */
  disabled?: boolean;

  /**
   * Set to `true` to use the read-only variant
   * @default false
   */
  readonly?: boolean;

  /**
   * Override the default translation ids.
   */
  translateWithId?: (id: ListBoxSelectionTranslationId) => string;

  /**
   * Obtain a reference to the top-level HTML element.
   * @default null
   */
  ref?: null | HTMLDivElement;

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

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

export default class ListBoxSelection extends SvelteComponentTyped<
  ListBoxSelectionProps,
  { clear: CustomEvent<KeyboardEvent | MouseEvent> },
  Record<string, never>
> {
  /**
   * Default translation ids
   */
  translationIds: { clearAll: "clearAll", clearSelection: "clearSelection", };
}