interface ThemeHomeActionOptions {
  /**
   * Action name
   */
  text: string;

  /**
   * Action link
   */
  link: string;

  /**
   * Type of action
   * @default 'default'
   */
  type?: "primary" | "default";
}

Required: No

Home actions

highlights

Type: (ThemeProjectHomeFeatureOptions |ThemeProjectHomeHighlightOptions)[]

interface ThemeProjectHomeHighlightItem {
  /**
   * Item name, supports HTML string
   */
  title: string;

  /**
   * Item description, supports HTML string
   */
  details?: string;

  /**
   * Item icon
   *
   * @description image link or icon fontClass are supported
   */
  icon?: string;

  /**
   * Item link
   */
  link?: string;
}

type ThemeProjectHomeFeatureItem = ThemeProjectHomeHighlightItem;

interface ThemeProjectHomeFeatureOptions {
  /**
   * Feature header
   */
  header?: string;

  /**
   * Feature section description, supports HTML string
   */
  description?: string;

  /**
   * Text color
   */
  color?: string;

  /**
   * Feature section image
   */
  image?: string;

  /**
   * Feature section image used in darkmode
   *
   * @default image
   */
  imageDark?: string;

  /**
   * Feature Background image
   */
  bgImage?: string;

  /**
   * Feature Background image used in darkmode
   *
   * @default bgImage
   */
  bgImageDark?: string;

  /**
   * Features Background image style
   */
  bgImageStyle?: Record<string, string> | string;

  /**
   * Features
   */
  features: ThemeProjectHomeFeatureItem[];
}

interface ThemeProjectHomeHighlightSection {
  /**
   * Highlight section header, supports HTML string
   */
  header: string;

  /**
   * Highlight section description, supports HTML string
   */
  description?: string;

  /**
   * Text color
   */
  color?: string;

  /**
   * Highlight section image
   */
  image?: string;

  /**
   * Highlight section image used in darkmode
   *
   * @default image
   */
  imageDark?: string;

  /**
   * Highlight Background image
   */
  bgImage?: string;

  /**
   * Highlight Background image used in darkmode
   *
   * @default bgImage
   */
  bgImageDark?: string;

  /**
   * Highlight Background image style
   */
  bgImageStyle?: Record<string, string> | string;

  /**
   * Highlight section list type
   *
   * @default un-order
   */
  type?: "order" | "un-order" | "no-order";

  /**
   * Highlights
   */
  highlights?: ThemeProjectHomeHighlightItem[];
}

Required: No

Highlights description.

features

Type: ThemeProjectHomeFeatureItem[]

interface ThemeProjectHomeFeatureItem {
  /**
   * Item name, supports HTML string
   */
  title: string;

  /**
   * Item description, supports HTML string
   */
  details?: string;

  /**
   * Item icon
   *
   * @description image link or icon fontClass are supported
   */
  icon?: string;

  /**
   * Item link
   */
  link?: string;
}

Required: No

Features description.