carbon-components-svelte/src/DataTable/Table.svelte.d.ts

Svelte implementation of the Carbon Design System

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

type $RestProps = SvelteHTMLElements["section"];

type $Props = {
  /**
   * Set the size of the table.
   * @default undefined
   */
  size?: "compact" | "short" | "medium" | "tall";

  /**
   * Set to `true` to use zebra styles
   * @default false
   */
  zebra?: boolean;

  /**
   * Set to `true` to use static width
   * @default false
   */
  useStaticWidth?: boolean;

  /**
   * Set to `true` for the sortable variant
   * @default false
   */
  sortable?: boolean;

  /**
   * Set to `true` to enable a sticky header
   * @default false
   */
  stickyHeader?: boolean;

  /**
   * Set the style attribute on the `table` element.
   * @default undefined
   */
  tableStyle?: string;

  /**
   * Obtain a reference to the section HTML element (when stickyHeader is enabled) or table HTML element.
   * @default null
   */
  ref?: null | HTMLElement;

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

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

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

export default class Table extends SvelteComponentTyped<
  TableProps,
  Record<string, any>,
  { default: Record<string, never> }
> {}