carbon-components-svelte/types/CodeSnippet/CodeSnippet.svelte.d.ts

import type { SvelteComponentTyped } from "svelte";

export type CodeSnippetProps = {
  /**
   * Set the type of code snippet
   * @default "single"
   */
  type?: "single" | "inline" | "multi";

  /**
   * Set the code snippet text.
   * Alternatively, use the default slot (e.g., `<CodeSnippet>{code}</CodeSnippet>`).
   *
   * NOTE: you *must* use the `code` prop for the copy-to-clipboard functionality.
   * @default undefined
   */
  code?: string;

  /**
   * By default, this component uses `navigator.clipboard.writeText` API to copy text to the user's clipboard.
   *
   * Provide a custom function to override this behavior.
   * @default async (code) => { try { await navigator.clipboard.writeText(code); } catch (e) { console.log(e); } }
   */
  copy?: (code: string) => void;

  /**
   * Set to `true` to expand a multi-line code snippet (type="multi")
   * @default false
   */
  expanded?: boolean;

  /**
   * Set to `true` to hide the copy button
   * @default false
   */
  hideCopyButton?: boolean;

  /**
   * Set to `true` for the disabled variant.
   * Only applies to the "single", "multi" types
   * @default false
   */
  disabled?: boolean;

  /**
   * Set to `true` to wrap the text.
   *
   * NOTE: this prop only works with the `type="multi"` variant
   * @default false
   */
  wrapText?: boolean;

  /**
   * Set to `true` to enable the light variant
   * @default false
   */
  light?: boolean;

  /**
   * Set to `true` to display the skeleton state
   * @default false
   */
  skeleton?: boolean;

  /**
   * Specify the ARIA label for the copy button icon
   * @default undefined
   */
  copyButtonDescription?: string;

  /**
   * Specify the ARIA label of the copy button
   * @default undefined
   */
  copyLabel?: string;

  /**
   * Specify the feedback text displayed when clicking the snippet
   * @default "Copied!"
   */
  feedback?: string;

  /**
   * Set the timeout duration (ms) to display feedback text
   * @default 2000
   */
  feedbackTimeout?: number;

  /**
   * Specify the show less text.
   *
   * NOTE: this prop only works with the `type="multi"` variant
   * @default "Show less"
   */
  showLessText?: string;

  /**
   * Specify the show more text
   *
   * NOTE: this prop only works with the `type="multi"` variant
   * @default "Show more"
   */
  showMoreText?: string;

  /**
   * Set to `false` to hide the show more/less button
   *
   * NOTE: this prop only works with the `type="multi"` variant
   * @default true
   */
  showMoreLess?: boolean;

  /**
   * Set an id for the code element
   * @default "ccs-" + Math.random().toString(36)
   */
  id?: string;

  /**
   * Obtain a reference to the pre HTML element
   * @default null
   */
  ref?: null | HTMLPreElement;
};

export default class CodeSnippet extends SvelteComponentTyped<
  CodeSnippetProps,
  {
    expand: CustomEvent<null>;
    collapse: CustomEvent<null>;
    copy: CustomEvent<null>;
    click: WindowEventMap["click"];
    mouseover: WindowEventMap["mouseover"];
    mouseenter: WindowEventMap["mouseenter"];
    mouseleave: WindowEventMap["mouseleave"];
    animationend: WindowEventMap["animationend"];
  },
  { default: {} }
> {}