starlight-view-modes/data.ts

Starlight plugin adding view mode capabilities to your documentation website.

import type { AdditionalMode, AvailableMode } from "./libs/definitions";

export interface StarlightViewModesRouteData {
  /**
   * A list of all configured view modes.
   */
  modes: {
    /**
     * The name of the view mode.
     */
    name: AvailableMode["name"];
    /**
     * The name of the view mode in readable form.
     */
    title: AvailableMode["title"];
    /**
     * The name of the view mode in readable form.
     */
    switchToText: AvailableMode["switchToText"];
    /**
     * The link to the same page in this view mode.
     */
    href: string;
    /**
     * The activation or deactivation icon of the view mode, depending on the current mode.
     * The default mode has no icon (`undefined`).
     */
    icon?: string;
    /**
     * Indicates if the current page is in this view mode right now.
     */
    isCurrent: boolean;
    /**
     * The keyboard shortcuts to switch to and from this view mode.
     */
    keyboardShortcuts?: AdditionalMode["keyboardShortcut"];
  }[];
}