valaxy-theme-sakura/types/config.ts

<h1 align="center">valaxy-theme-sakura</h1> <pre align="center"> 一个简单、个性化、可爱的动漫风格博客主题 ❥(ゝω・✿ฺ) </pre>

import type { DefaultTheme } from 'valaxy'
import type { Footer } from './footer'
import type { Hero } from './hero'
import type { NavItem, NavbarOptions } from './navbar'
import type { Pagination } from './pagination'
import type { PinnedPost } from './pinned'
import type { PostFooter, PostList } from './post'
import type { SidebarItem, SidebarOptions } from './sidebar'
import type { UserUI } from './ui'

export interface ThemeConfig extends DefaultTheme.Config {
  ui: UserUI
  /**
   * @zh 页脚配置
   * @en Footer configuration
   */
  footer: Footer
  /**
   * @zh 置顶文章
   * @en Pinned articles
   */
  pinnedPost?: PinnedPost
  /**
   * @zh 文章配置
   * @en Post configuration
   */
  postList?: PostList
  postFooter?: PostFooter
  /**
   * @deprecated Use hero instead
   */
  banner: Hero
  /**
   * @zh 横幅配置
   * @en Banner configuration
   */
  hero: Hero
  /**
   * @zh 侧边栏配置
   * @en Sidebar configuration
   */
  sidebar: NavItem[] | SidebarItem[]
  /**
   * @zh 侧边栏选项配置
   * @en Sidebar options configuration
   */
  sidebarOptions: SidebarOptions
  /**
   * @zh 是否显示站点图标
   * @en Whether to display the site favicon
   * @default true
   * @deprecated Use navbarOptions.favicon instead
   */
  favicon: boolean
  /**
   * @zh 导航栏
   * @en Navbar
   */
  navbar: NavItem[]
  /**
   * @zh 导航栏标题
   * @en Navbar title
   * @deprecated Use NavbarOptions.title instead
   */
  navbarTitle: string | string[]
  /**
   * @zh 导航栏选项配置
   * @en Navbar options configuration
   */
  navbarOptions: NavbarOptions
  /**
   * @zh 大纲标题
   * @en Outline title
   */
  outlineTitle?: string
  /**
   * @zh 分页配置
   * @en Pagination configuration
   */
  pagination?: Pagination
  /**
   * @zh 滚动阻尼
   * @en Scroll damping
   * @default false
   */
  scrollDamping: boolean
  /**
   * @zh 滚动动画
   * @en Scroll animation
   * @default true
   */
  scrollAnimation: boolean
  /**
   * @default false
   */
  scrollIndicator: boolean
  /**
   * @default true
   */
  scrollLock: boolean
  /**
   * @zh 是否显示滚动到顶部组件，默认为按钮样式
   * @en Whether to display the scroll-to-top component. The default is a button style.
   * @default true
   */
  scrollToTop: boolean | 'cord'
  scrollDown: {
    enable: boolean
  }
  /**
   * @zh 404图片
   * @en Image for the 404
   */
  notFoundImage?: string
  /**
   * @zh 公告
   * @en Notice
   */
  notice?: {
    /**
     * @zh 公告信息
     * @en Notice message
     */
    message: string
  }

  tags?: {
    /**
     * @zh 是否开启彩色标签
     * @en Whether to enable rainbow tags
     * @default false
     */
    rainbow?: boolean | string[]
  }
}

export type ThemeUserConfig = {
  [K in keyof ThemeConfig]?: Partial<ThemeConfig[K]>
}
/**
 * @deprecated Use ThemeUserConfig instead
 */
export type UserThemeConfig = ThemeUserConfig