@h-ai/ui 0.1.0-alpha.67 → 0.1.0-alpha.68

package/dist/components/scenes/crud/crud-types.d.ts

@@ -7,7 +7,15 @@
 import type { Snippet } from 'svelte';
 import type { DataAttributes, FormLayoutOptions, Size } from '../../../types.js';
 import type { CrudFieldDef } from './crud-controller.svelte.js';
-/** CrudPage 权限控制 */
+/**
+ * CrudPage 权限控制
+ *
+ * @example
+ * ```ts
+ * import type { CrudPermissions } from '@h-ai/ui'
+ * const example: CrudPermissions = { create: true, update: true, delete: false }
+ * ```
+ */
 export interface CrudPermissions {
     /** 允许新建 */
     create?: boolean;
@@ -16,11 +24,35 @@ export interface CrudPermissions {
     /** 允许删除 */
     delete?: boolean;
 }
-/** 新建/编辑表单的展示形式 */
+/**
+ * 新建/编辑表单的展示形式
+ *
+ * @example
+ * ```ts
+ * import type { CrudFormVariant } from '@h-ai/ui'
+ * const example: CrudFormVariant = 'drawer'
+ * ```
+ */
 export type CrudFormVariant = 'drawer' | 'modal';
-/** 列表显示密度 */
+/**
+ * 列表显示密度
+ *
+ * @example
+ * ```ts
+ * import type { CrudDensity } from '@h-ai/ui'
+ * const example: CrudDensity = 'compact'
+ * ```
+ */
 export type CrudDensity = 'normal' | 'compact';
-/** 新建/编辑表单展示配置 */
+/**
+ * 新建/编辑表单展示配置
+ *
+ * @example
+ * ```ts
+ * import type { CrudFormConfig } from '@h-ai/ui'
+ * const example: CrudFormConfig = { variant: 'drawer', drawerWidth: '32rem', columns: 2, labelPosition: 'top' }
+ * ```
+ */
 export interface CrudFormConfig extends FormLayoutOptions {
     /** 展示形式：'drawer'（抽屉，默认）或 'modal'（弹出窗口） */
     variant?: CrudFormVariant;
@@ -37,7 +69,15 @@ export interface CrudFormConfig extends FormLayoutOptions {
     /** 弹窗自定义高度 CSS 值（variant='modal'） */
     modalHeight?: string;
 }
-/** 分页栏展示配置 */
+/**
+ * 分页栏展示配置
+ *
+ * @example
+ * ```ts
+ * import type { CrudPaginationConfig } from '@h-ai/ui'
+ * const example: CrudPaginationConfig = { showSizeChanger: true, pageSizeOptions: [10, 20, 50], showTotal: true }
+ * ```
+ */
 export interface CrudPaginationConfig {
     /** 是否显示每页条数选择器（默认 true） */
     showSizeChanger?: boolean;
@@ -52,9 +92,26 @@ export interface CrudPaginationConfig {
     /** 是否显示首页 / 末页跳转按钮（默认 true；紧凑视图可仅保留上一页 / 下一页） */
     showFirstLast?: boolean;
 }
-/** CrudPage 工具栏风格；toolbar 是默认的图标弹层布局。 */
+/**
+ * CrudPage 工具栏风格；toolbar 是默认的图标弹层布局。
+ *
+ * @example
+ * ```ts
+ * import type { CrudToolbarStyle } from '@h-ai/ui'
+ * const example: CrudToolbarStyle = 'toolbar'
+ * ```
+ */
 export type CrudToolbarStyle = 'filter-bar' | 'toolbar';
-/** CrudPage 初始列表数据（由 +page.server.ts load 返回） */
+/**
+ * CrudPage 初始列表数据（由 +page.server.ts load 返回）
+ * @typeParam T - 字段值或资源条目的数据类型。
+ *
+ * @example
+ * ```ts
+ * import type { CrudPageData } from '@h-ai/ui'
+ * const example: CrudPageData = { items: [{ id: 'u1', email: 'ada@example.com' }], total: 1, page: 1, pageSize: 20 }
+ * ```
+ */
 export interface CrudPageData<T = Record<string, unknown>> {
     items: T[];
     total: number;
@@ -62,7 +119,21 @@ export interface CrudPageData<T = Record<string, unknown>> {
     pageSize: number;
     filters?: Record<string, unknown>;
 }
-/** CrudPage 组件 Props */
+/**
+ * CrudPage 组件 Props
+ * @typeParam T - 字段值或资源条目的数据类型。
+ *
+ * @example
+ * ```svelte
+ * <script lang="ts">
+ *   import { CrudPage, defineCrud } from '@h-ai/ui'
+ *   import type { CrudPageProps } from '@h-ai/ui'
+ *   const crud = defineCrud({ name: 'users', label: '用户', fields: [{ id: 'email', label: '邮箱', type: 'email', validation: { required: true } }], api: { list: async () => ({ items: [{ id: 'u1', email: 'ada@example.com' }], total: 1, page: 1, pageSize: 20 }) } })
+ *   const props: CrudPageProps = { crud, data: { items: [{ id: 'u1', email: 'ada@example.com' }], total: 1, page: 1, pageSize: 20 }, permissions: { create: true, update: true, delete: false } }
+ * </script>
+ * <CrudPage {...props} />
+ * ```
+ */
 export interface CrudPageProps<T = Record<string, unknown>> extends DataAttributes {
     /** CRUD 操作定义（来自 kit.crud.define） */
     crud: {

package/dist/components/scenes/crud/nav-adapter.d.ts

@@ -14,6 +14,12 @@
  * - 读取当前 pathname（作为列表 URL 的 basePath 兜底）
  * - 调用 `navigate(url)` 同步搜索 / 过滤 / 分页参数到地址栏
  * - 调用 `refresh()` 在写操作后重新拉取列表数据
+ *
+ * @example
+ * ```ts
+ * import type { NavAdapter } from '@h-ai/ui'
+ * const example: NavAdapter = { pathname: '/users', navigate: url => { globalThis.location?.assign(url) } }
+ * ```
  */
 export interface NavAdapter {
     /** 当前页面路径（不含 query / hash），用于推导 `basePath`。 */
@@ -32,5 +38,13 @@ export interface NavAdapter {
  * - `navigate(url)` 调 `globalThis.location.assign(url)`；如需客户端路由（hash router 等），
  *   宿主应自行实现一个 `NavAdapter` 传入。
  * - 不提供 `refresh`：浏览器默认导航本身会触发页面加载，调用方需在导航前/后重新拉取数据。
+ * @returns 基于浏览器 location 的导航适配器；SSR 下 pathname 为空字符串。
+ *
+ * @example
+ * ```ts
+ * import { createBrowserNavAdapter } from '@h-ai/ui'
+ * const nav = createBrowserNavAdapter()
+ * await nav.navigate('/users?page=2')
+ * ```
  */
 export declare function createBrowserNavAdapter(): NavAdapter;

package/dist/components/scenes/crud/nav-adapter.js

@@ -18,6 +18,14 @@
  * - `navigate(url)` 调 `globalThis.location.assign(url)`；如需客户端路由（hash router 等），
  *   宿主应自行实现一个 `NavAdapter` 传入。
  * - 不提供 `refresh`：浏览器默认导航本身会触发页面加载，调用方需在导航前/后重新拉取数据。
+ * @returns 基于浏览器 location 的导航适配器；SSR 下 pathname 为空字符串。
+ *
+ * @example
+ * ```ts
+ * import { createBrowserNavAdapter } from '@h-ai/ui'
+ * const nav = createBrowserNavAdapter()
+ * await nav.navigate('/users?page=2')
+ * ```
  */
 export function createBrowserNavAdapter() {
     return {

package/dist/components/scenes/crypto/EncryptedInput.svelte

@@ -1,4 +1,5 @@
 <!--
+  @component EncryptedInput
   =============================================================================
   @h-ai/ui - EncryptedInput 组件
   =============================================================================
@@ -7,6 +8,16 @@
   使用 Svelte 5 Runes ($props, $state, $derived, $bindable)
   内置多语言支持，自动跟随全局 locale
   =============================================================================
+
+  @example
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import type { ComponentProps } from 'svelte'
+  import { EncryptedInput } from '@h-ai/ui'
+  const props: ComponentProps<typeof EncryptedInput> = { value: '', algorithm: 'SM2', showEncrypted: false }
+  const component = mount(EncryptedInput, { target: document.body, props })
+  await unmount(component)
+  ```
 -->
 <script lang='ts'>
   import type { DataAttributes, Size } from '../../../types.js'
@@ -15,6 +26,19 @@
   import { getDataAttributes } from '../../../utils.js'
   import { BareButton, IconButton, Input } from '../../primitives/index.js'
 
+  /**
+   * EncryptedInput 组件的属性契约；通过公开组件配置使用。
+   *
+   * @example
+   * ```ts
+   * import { mount, unmount } from 'svelte'
+   * import type { ComponentProps } from 'svelte'
+   * import { EncryptedInput } from '@h-ai/ui'
+   * const props: ComponentProps<typeof EncryptedInput> = { value: '', algorithm: 'SM2', showEncrypted: false }
+   * const component = mount(EncryptedInput, { target: document.body, props })
+   * await unmount(component)
+   * ```
+   */
   interface Props {
     /** 原始值 */
     value?: string

package/dist/components/scenes/crypto/EncryptedInput.svelte.d.ts

@@ -1,4 +1,17 @@
 import type { DataAttributes, Size } from '../../../types.js';
+/**
+ * EncryptedInput 组件的属性契约；通过公开组件配置使用。
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { EncryptedInput } from '@h-ai/ui'
+ * const props: ComponentProps<typeof EncryptedInput> = { value: '', algorithm: 'SM2', showEncrypted: false }
+ * const component = mount(EncryptedInput, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 interface Props {
     /** 原始值 */
     value?: string;
@@ -28,6 +41,27 @@ interface Props {
     }) => void;
 }
 type $$ComponentProps = Props & DataAttributes;
+/**
+ * EncryptedInput
+ * =============================================================================
+ * @h-ai/ui - EncryptedInput 组件
+ * =============================================================================
+ * 加密输入框组件，支持自动加密显示
+ *
+ * 使用 Svelte 5 Runes ($props, $state, $derived, $bindable)
+ * 内置多语言支持，自动跟随全局 locale
+ * =============================================================================
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { EncryptedInput } from '@h-ai/ui'
+ * const props: ComponentProps<typeof EncryptedInput> = { value: '', algorithm: 'SM2', showEncrypted: false }
+ * const component = mount(EncryptedInput, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 declare const EncryptedInput: import("svelte").Component<$$ComponentProps, {}, "value" | "encryptedValue">;
 type EncryptedInput = ReturnType<typeof EncryptedInput>;
 export default EncryptedInput;

package/dist/components/scenes/crypto/HashDisplay.svelte

@@ -1,4 +1,5 @@
 <!--
+  @component HashDisplay
   =============================================================================
   @h-ai/ui - HashDisplay 组件
   =============================================================================
@@ -7,6 +8,16 @@
   使用 Svelte 5 Runes ($props, $state, $derived)
   使用 primitives 组件：IconButton, Badge
   =============================================================================
+
+  @example
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import type { ComponentProps } from 'svelte'
+  import { HashDisplay } from '@h-ai/ui'
+  const props: ComponentProps<typeof HashDisplay> = { value: 'example-digest', algorithm: 'SM3', copyable: true }
+  const component = mount(HashDisplay, { target: document.body, props })
+  await unmount(component)
+  ```
 -->
 <script lang='ts'>
   import type { DataAttributes } from '../../../types.js'

package/dist/components/scenes/crypto/HashDisplay.svelte.d.ts

@@ -1,6 +1,27 @@
 import type { DataAttributes } from '../../../types.js';
 import type { HashDisplayProps } from '../types.js';
 type $$ComponentProps = HashDisplayProps & DataAttributes;
+/**
+ * HashDisplay
+ * =============================================================================
+ * @h-ai/ui - HashDisplay 组件
+ * =============================================================================
+ * 哈希值展示组件
+ *
+ * 使用 Svelte 5 Runes ($props, $state, $derived)
+ * 使用 primitives 组件：IconButton, Badge
+ * =============================================================================
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { HashDisplay } from '@h-ai/ui'
+ * const props: ComponentProps<typeof HashDisplay> = { value: 'example-digest', algorithm: 'SM3', copyable: true }
+ * const component = mount(HashDisplay, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 declare const HashDisplay: import("svelte").Component<$$ComponentProps, {}, "">;
 type HashDisplay = ReturnType<typeof HashDisplay>;
 export default HashDisplay;

package/dist/components/scenes/crypto/SignatureDisplay.svelte

@@ -1,4 +1,5 @@
 <!--
+  @component SignatureDisplay
   =============================================================================
   @h-ai/ui - SignatureDisplay 组件
   =============================================================================
@@ -7,6 +8,16 @@
   使用 Svelte 5 Runes ($props, $state, $derived)
   使用 primitives 组件：IconButton, Badge
   =============================================================================
+
+  @example
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import type { ComponentProps } from 'svelte'
+  import { SignatureDisplay } from '@h-ai/ui'
+  const props: ComponentProps<typeof SignatureDisplay> = { signature: 'example-signature', verified: false, showPublicKey: false }
+  const component = mount(SignatureDisplay, { target: document.body, props })
+  await unmount(component)
+  ```
 -->
 <script lang='ts'>
   import type { DataAttributes } from '../../../types.js'

package/dist/components/scenes/crypto/SignatureDisplay.svelte.d.ts

@@ -1,6 +1,27 @@
 import type { DataAttributes } from '../../../types.js';
 import type { SignatureDisplayProps } from '../types.js';
 type $$ComponentProps = SignatureDisplayProps & DataAttributes;
+/**
+ * SignatureDisplay
+ * =============================================================================
+ * @h-ai/ui - SignatureDisplay 组件
+ * =============================================================================
+ * 签名信息展示组件
+ *
+ * 使用 Svelte 5 Runes ($props, $state, $derived)
+ * 使用 primitives 组件：IconButton, Badge
+ * =============================================================================
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { SignatureDisplay } from '@h-ai/ui'
+ * const props: ComponentProps<typeof SignatureDisplay> = { signature: 'example-signature', verified: false, showPublicKey: false }
+ * const component = mount(SignatureDisplay, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 declare const SignatureDisplay: import("svelte").Component<$$ComponentProps, {}, "">;
 type SignatureDisplay = ReturnType<typeof SignatureDisplay>;
 export default SignatureDisplay;

package/dist/components/scenes/error/ErrorPage.svelte

@@ -8,7 +8,14 @@
   使用 Svelte 5 Runes ($props, $derived)
 
   @example
-  <ErrorPage status={403} homeUrl="/admin" onback={() => history.back()} />
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import type { ComponentProps } from 'svelte'
+  import { ErrorPage } from '@h-ai/ui'
+  const props: ComponentProps<typeof ErrorPage> = { status: 403, homeUrl: '/' }
+  const component = mount(ErrorPage, { target: document.body, props })
+  await unmount(component)
+  ```
 -->
 <script lang='ts'>
   import type { Snippet } from 'svelte'

package/dist/components/scenes/error/ErrorPage.svelte.d.ts

@@ -36,7 +36,14 @@ type $$ComponentProps = {
  * 使用 Svelte 5 Runes ($props, $derived)
  *
  * @example
- * <ErrorPage status={403} homeUrl="/admin" onback={() => history.back()} />
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { ErrorPage } from '@h-ai/ui'
+ * const props: ComponentProps<typeof ErrorPage> = { status: 403, homeUrl: '/' }
+ * const component = mount(ErrorPage, { target: document.body, props })
+ * await unmount(component)
+ * ```
  */
 declare const ErrorPage: import("svelte").Component<$$ComponentProps, {}, "">;
 type ErrorPage = ReturnType<typeof ErrorPage>;

package/dist/components/scenes/error/error-presets.d.ts

@@ -5,9 +5,25 @@
  * @module error-presets
  */
 import type { UIMessageKey } from '../../../messages.js';
-/** 内置错误预设标识 */
+/**
+ * 内置错误预设标识
+ *
+ * @example
+ * ```ts
+ * import type { ErrorPreset } from '@h-ai/ui'
+ * const example: ErrorPreset = '404'
+ * ```
+ */
 export type ErrorPreset = '401' | '403' | '404' | '500' | '503';
-/** 单个错误预设的展示信息 */
+/**
+ * 单个错误预设的展示信息
+ *
+ * @example
+ * ```ts
+ * import type { ErrorPresetInfo } from '@h-ai/ui'
+ * const example: ErrorPresetInfo = { code: '404', titleKey: 'error_404_title', descKey: 'error_404_desc', icon: 'icon-[tabler--map-search]' }
+ * ```
+ */
 export interface ErrorPresetInfo {
     /** HTTP 状态码（用于大号展示） */
     code: string;
@@ -18,7 +34,27 @@ export interface ErrorPresetInfo {
     /** Tabler 图标类名 */
     icon: string;
 }
-/** 错误预设映射表 */
+/**
+ * 错误预设映射表
+ *
+ * @example
+ * ```ts
+ * import { ERROR_PRESETS } from '@h-ai/ui'
+ * const missing = ERROR_PRESETS['404']
+ * const titleKey = missing.titleKey
+ * ```
+ */
 export declare const ERROR_PRESETS: Record<ErrorPreset, ErrorPresetInfo>;
-/** 根据 HTTP 状态码解析到最接近的预设 */
+/**
+ * 根据 HTTP 状态码解析到最接近的预设
+ * @param status - HTTP 状态码或文本形式。
+ * @returns 最接近输入状态的内置错误页标识。
+ *
+ * @example
+ * ```ts
+ * import { resolveErrorPreset } from '@h-ai/ui'
+ * const unavailable = resolveErrorPreset(503)
+ * const fallback = resolveErrorPreset(418)
+ * ```
+ */
 export declare function resolveErrorPreset(status: number | string | undefined): ErrorPreset;

package/dist/components/scenes/error/error-presets.js

@@ -4,7 +4,16 @@
  * 为 ErrorPage 提供常见 HTTP 错误的内置文案 key 与图标。
  * @module error-presets
  */
-/** 错误预设映射表 */
+/**
+ * 错误预设映射表
+ *
+ * @example
+ * ```ts
+ * import { ERROR_PRESETS } from '@h-ai/ui'
+ * const missing = ERROR_PRESETS['404']
+ * const titleKey = missing.titleKey
+ * ```
+ */
 export const ERROR_PRESETS = {
     401: { code: '401', titleKey: 'error_401_title', descKey: 'error_401_desc', icon: 'icon-[tabler--lock]' },
     403: { code: '403', titleKey: 'error_403_title', descKey: 'error_403_desc', icon: 'icon-[tabler--shield-lock]' },
@@ -12,7 +21,18 @@ export const ERROR_PRESETS = {
     500: { code: '500', titleKey: 'error_500_title', descKey: 'error_500_desc', icon: 'icon-[tabler--server-off]' },
     503: { code: '503', titleKey: 'error_503_title', descKey: 'error_503_desc', icon: 'icon-[tabler--tool]' },
 };
-/** 根据 HTTP 状态码解析到最接近的预设 */
+/**
+ * 根据 HTTP 状态码解析到最接近的预设
+ * @param status - HTTP 状态码或文本形式。
+ * @returns 最接近输入状态的内置错误页标识。
+ *
+ * @example
+ * ```ts
+ * import { resolveErrorPreset } from '@h-ai/ui'
+ * const unavailable = resolveErrorPreset(503)
+ * const fallback = resolveErrorPreset(418)
+ * ```
+ */
 export function resolveErrorPreset(status) {
     const code = String(status ?? '');
     if (code in ERROR_PRESETS) {

package/dist/components/scenes/guide/GuideHost.svelte

@@ -1,3 +1,17 @@
+<!--
+  @component GuideHost
+  GuideHost 组件的公开使用示例。
+
+  @example
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import { GuideHost, createGuide } from '@h-ai/ui'
+  const guide = createGuide({ tours: [], persistence: 'memory' })
+  const host = mount(GuideHost, { target: document.body, props: { guide, locale: 'zh-CN', scope: 'demo' } })
+  await unmount(host)
+  guide.stop()
+  ```
+-->
 <script lang='ts'>
   import type { GuideController } from '../../../guide-types.js'
   import type { DataAttributes } from '../../../types.js'
@@ -12,6 +26,19 @@
   import 'driver.js/dist/driver.css'
   import '../../../styles/guide.css'
 
+  /**
+   * 导览宿主属性；绑定应用语言、非敏感身份范围和控制器。
+   *
+   * @example
+   * ```ts
+   * import { mount, unmount } from 'svelte'
+   * import { GuideHost, createGuide } from '@h-ai/ui'
+   * const guide = createGuide({ tours: [], persistence: 'memory' })
+   * const host = mount(GuideHost, { target: document.body, props: { guide, locale: 'zh-CN', scope: 'demo' } })
+   * await unmount(host)
+   * guide.stop()
+   * ```
+   */
   interface Props {
     guide: GuideController
     locale?: string

package/dist/components/scenes/guide/GuideHost.svelte.d.ts

@@ -2,6 +2,19 @@ import type { GuideController } from '../../../guide-types.js';
 import type { DataAttributes } from '../../../types.js';
 import 'driver.js/dist/driver.css';
 import '../../../styles/guide.css';
+/**
+ * 导览宿主属性；绑定应用语言、非敏感身份范围和控制器。
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import { GuideHost, createGuide } from '@h-ai/ui'
+ * const guide = createGuide({ tours: [], persistence: 'memory' })
+ * const host = mount(GuideHost, { target: document.body, props: { guide, locale: 'zh-CN', scope: 'demo' } })
+ * await unmount(host)
+ * guide.stop()
+ * ```
+ */
 interface Props {
     guide: GuideController;
     locale?: string;
@@ -11,6 +24,20 @@ interface Props {
     autoStart?: string;
 }
 type $$ComponentProps = Props & DataAttributes;
+/**
+ * GuideHost
+ * GuideHost 组件的公开使用示例。
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import { GuideHost, createGuide } from '@h-ai/ui'
+ * const guide = createGuide({ tours: [], persistence: 'memory' })
+ * const host = mount(GuideHost, { target: document.body, props: { guide, locale: 'zh-CN', scope: 'demo' } })
+ * await unmount(host)
+ * guide.stop()
+ * ```
+ */
 declare const GuideHost: import("svelte").Component<$$ComponentProps, {}, "">;
 type GuideHost = ReturnType<typeof GuideHost>;
 export default GuideHost;

package/dist/components/scenes/guide/HelpCenter.svelte

@@ -1,3 +1,17 @@
+<!--
+  @component HelpCenter
+  HelpCenter 组件的公开使用示例。
+
+  @example
+  ```ts
+  import { mount, unmount } from 'svelte'
+  import type { ComponentProps } from 'svelte'
+  import { HelpCenter } from '@h-ai/ui'
+  const props: ComponentProps<typeof HelpCenter> = { articles: [{ id: 'start', title: '开始使用', content: '# 操作说明' }] }
+  const component = mount(HelpCenter, { target: document.body, props })
+  await unmount(component)
+  ```
+-->
 <script lang='ts'>
   import type { GuideArticle, GuideTour } from '../../../guide-types.js'
   import type { DataAttributes } from '../../../types.js'
@@ -8,6 +22,19 @@
   import Button from '../../primitives/Button.svelte'
   import Input from '../../primitives/Input.svelte'
 
+  /**
+   * HelpCenter 组件的属性契约；通过公开组件配置使用。
+   *
+   * @example
+   * ```ts
+   * import { mount, unmount } from 'svelte'
+   * import type { ComponentProps } from 'svelte'
+   * import { HelpCenter } from '@h-ai/ui'
+   * const props: ComponentProps<typeof HelpCenter> = { articles: [{ id: 'start', title: '开始使用', content: '# 操作说明' }] }
+   * const component = mount(HelpCenter, { target: document.body, props })
+   * await unmount(component)
+   * ```
+   */
   interface Props {
     articles: readonly GuideArticle[]
     tours?: readonly GuideTour[]

package/dist/components/scenes/guide/HelpCenter.svelte.d.ts

@@ -1,5 +1,18 @@
 import type { GuideArticle, GuideTour } from '../../../guide-types.js';
 import type { DataAttributes } from '../../../types.js';
+/**
+ * HelpCenter 组件的属性契约；通过公开组件配置使用。
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { HelpCenter } from '@h-ai/ui'
+ * const props: ComponentProps<typeof HelpCenter> = { articles: [{ id: 'start', title: '开始使用', content: '# 操作说明' }] }
+ * const component = mount(HelpCenter, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 interface Props {
     articles: readonly GuideArticle[];
     tours?: readonly GuideTour[];
@@ -8,6 +21,20 @@ interface Props {
     onstart?: (tourId: string) => void;
 }
 type $$ComponentProps = Props & DataAttributes;
+/**
+ * HelpCenter
+ * HelpCenter 组件的公开使用示例。
+ *
+ * @example
+ * ```ts
+ * import { mount, unmount } from 'svelte'
+ * import type { ComponentProps } from 'svelte'
+ * import { HelpCenter } from '@h-ai/ui'
+ * const props: ComponentProps<typeof HelpCenter> = { articles: [{ id: 'start', title: '开始使用', content: '# 操作说明' }] }
+ * const component = mount(HelpCenter, { target: document.body, props })
+ * await unmount(component)
+ * ```
+ */
 declare const HelpCenter: import("svelte").Component<$$ComponentProps, {}, "">;
 type HelpCenter = ReturnType<typeof HelpCenter>;
 export default HelpCenter;