githubmirror/material-ui

docs/src/MuiPage.ts
71 строка2 KB
Jan Potoms
[code-infra] Convert a few docs modules to ts (#45548)
12 мар 2025, 19:44
12 мар 2025, 19:44d97f138
import * as React from 'react';
import standardNavIcons from './modules/components/AppNavIcons';

export type MuiPageIcon = keyof typeof standardNavIcons | React.ComponentType;

export interface MuiPage {
  pathname: string;
  query?: object;
  children?: MuiPage[];
  disableDrawer?: boolean;
  icon?: MuiPageIcon;
  /**
   * Indicates if the pages are regarding some legacy API.
   */
  legacy?: boolean;
  /**
   * Indicates if the pages are only available in some plan.
   * @default 'community'
   */
  plan?: 'community' | 'pro' | 'premium';
  /**
   * In case the children have pathnames out of pathname value, use this field to scope other pathnames.
   * Pathname can be partial, for example '/components/' will cover '/components/button/' and '/components/link/'.
   * @deprecated Dead code, to remove.
   */
  scopePathnames?: string[];
  /**
   * Pages are considered to be ordered depth-first.
   * If a page should be excluded from this order, set `order: false`.
   * You want to set `inSideNav: false` if you don't want the page to appear in an ordered list e.g. for previous/next page navigation.
   */
  inSideNav?: boolean;
  /**
   * Props spread to the Link component.
   */
  linkProps?: Record<string, unknown>;
  /**
   * Subheader to display before navigation links.
   */
  subheader?: string;
  /**
   * Overrides the default page title.
   */
  title?: string;
  /**
   * Indicates if the feature has been recently released.
   * @default false
   */
  newFeature?: boolean;
  /**
   * Indicates if the feature is planned for development.
   * @default false
   */
  planned?: boolean;
  /**
   * Indicates if the component/hook is not stable yet.
   */
  unstable?: boolean;
  /**
   * Indicates the item is in beta release.
   */
  beta?: boolean;
  /**
   * Indicates if the pages are regarding some deprecated API.
   */
  deprecated?: boolean;
}

export interface OrderedMuiPage extends MuiPage {
  ordered?: true;
}