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

Svelte implementation of the Carbon Design System

import { SvelteComponentTyped } from "svelte";

export type ContainedListProps = {
  /**
   * Specify the kind of contained list.
   * @default "on-page"
   */
  kind?: "on-page" | "disclosed";

  /**
   * Specify the label text.
   * Alternatively, use the named slot "labelChildren".
   * @default ""
   */
  labelText?: string;

  /**
   * Specify the size of the list.
   * @default "md"
   */
  size?: "sm" | "md" | "lg" | "xl";

  /**
   * Set to `true` for lines between list items to be inset
   * @default false
   */
  inset?: boolean;

  /**
   * Set an id for the list element
   * @default `ccs-${Math.random().toString(36)}`
   */
  id?: string;

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

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

  children?: (this: void) => void;
};

export default class ContainedList extends SvelteComponentTyped<
  ContainedListProps,
  Record<string, any>,
  {
    default: Record<string, never>;
    action: Record<string, never>;
    labelChildren: Record<string, never>;
  }
> {}