docs: 统一组件文档格式

2026-10-06 14:33:11 +08:00 · 2026-04-29 00:57:54 +08:00
parent caedad8e72
commit 871dd5c56f
36 changed files with 36 additions and 36 deletions
@@ -1,4 +1,4 @@
-# FaAvatar 头像组件
+# FaAvatar 头像
 用户头像组件，支持图片加载失败时显示降级内容。
@@ -1,4 +1,4 @@
-# FaButton 按钮组件
+# FaButton 按钮
 基础按钮组件，支持多种样式变体和尺寸，内置加载状态支持。
@@ -1,4 +1,4 @@
-# FaCard 卡片组件
+# FaCard 卡片
 基础卡片容器组件，支持标题、描述、内容和页脚区域。
@@ -1,4 +1,4 @@
-# FaCheckbox 复选框组件
+# FaCheckbox 复选框
 简洁的复选框组件，支持双向绑定和标签内容插槽。
@@ -1,4 +1,4 @@
-# FaCollapsible 折叠面板组件
+# FaCollapsible 折叠面板
 可折叠的内容面板，支持展开/收起动画。
@@ -1,4 +1,4 @@
-# FaContextMenu 右键菜单组件
+# FaContextMenu 右键菜单
 右键点击时弹出的上下文菜单，支持分组、子菜单和图标。
@@ -1,4 +1,4 @@
-# FaDivider 分割线组件
+# FaDivider 分割线
 带文字内容的分割线组件，支持文字位置调整。
@@ -1,4 +1,4 @@
-# FaDrawer 抽屉组件
+# FaDrawer 抽屉
 侧滑抽屉组件，支持从四个方向弹出，内置头部、内容区和底部操作区。
@@ -1,4 +1,4 @@
-# FaDropdown 下拉菜单组件
+# FaDropdown 下拉菜单
 功能强大的下拉菜单组件，支持分组、子菜单、图标和自定义内容。
@@ -1,4 +1,4 @@
-# FaFileUpload 文件上传组件
+# FaFileUpload 文件上传
 支持拖拽、点击和粘贴上传的文件上传组件，带进度显示和文件管理功能。
@@ -1,4 +1,4 @@
-# FaHoverCard 悬浮卡片组件
+# FaHoverCard 悬浮卡片
 鼠标悬停时显示的卡片，用于展示额外信息。
@@ -1,4 +1,4 @@
-# FaIcon 图标组件
+# FaIcon 图标
 统一的图标组件，支持 UnoCSS 图标类、Iconify、SVG 雪碧图和外部图片 URL 四种图标来源。
@@ -1,4 +1,4 @@
-# FaImagePreview 图片预览组件
+# FaImagePreview 图片预览
 带加载状态和错误处理的图片预览组件，支持点击放大查看。
@@ -1,4 +1,4 @@
-# FaImageUpload 图片上传组件
+# FaImageUpload 图片上传
 专门用于图片上传的组件，支持预览、排序和粘贴上传。
@@ -1,4 +1,4 @@
-# FaInputOTP 验证码输入组件
+# FaInputOTP 验证码输入
 用于输入短信验证码、邮箱验证码等一次性密码的输入组件。
@@ -1,4 +1,4 @@
-# FaInput 输入框组件
+# FaInput 输入框
 基础输入框组件，支持密码显示切换、清空按钮和前后缀插槽。
@@ -1,4 +1,4 @@
-# FaKbdGroup 键盘组合组件
+# FaKbdGroup 键盘组合
 用于包裹多个 `FaKbd` 组件，展示组合按键的容器组件。
@@ -1,4 +1,4 @@
-# FaKbd 键盘按键组件
+# FaKbd 键盘按键
 用于展示键盘按键组合的视觉样式，常用于快捷键提示。
@@ -1,4 +1,4 @@
-# FaLabel 标签组件
+# FaLabel 标签
 表单标签组件，支持固定宽度标签和自定义内容，用于表单字段的标签显示。
@@ -1,4 +1,4 @@
-# FaModal 对话框组件
+# FaModal 对话框
 模态对话框组件，支持拖拽、最大化、自定义内容和多种显示模式。
@@ -1,4 +1,4 @@
-# FaPageHeader 页面头部组件
+# FaPageHeader 页面头部
 页面级标题组件，支持标题、描述和右侧操作区。
@@ -1,4 +1,4 @@
-# FaPageMain 页面主内容区组件
+# FaPageMain 页面主内容区
 页面主内容容器组件，支持标题和可折叠的内容区域。
@@ -1,4 +1,4 @@
-# FaPagination 分页组件
+# FaPagination 分页
 功能完整的分页组件，支持总条数显示、每页条数选择、页码跳转和自定义布局。
@@ -1,4 +1,4 @@
-# FaPasswordStrength 密码强度组件
+# FaPasswordStrength 密码强度
 实时显示密码强度指示，帮助用户创建更安全的密码。
@@ -1,4 +1,4 @@
-# FaPopover 弹出框组件
+# FaPopover 弹出框
 灵活的弹出容器组件，支持自定义内容和多种弹出位置。
@@ -1,4 +1,4 @@
-# FaProgress 进度条组件
+# FaProgress 进度条
 线性进度条组件，展示任务的完成进度。
@@ -1,4 +1,4 @@
-# FaRadioGroup 单选组组件
+# FaRadioGroup 单选组
 基于选项数组的单选组件，支持描述文案、自定义布局样式和选项插槽扩展。
@@ -1,4 +1,4 @@
-# FaScrollArea 滚动区域组件
+# FaScrollArea 滚动区域
 自定义滚动条的滚动容器，支持水平/垂直滚动、渐变遮罩和滚动事件监听。
@@ -1,4 +1,4 @@
-# FaSearchBar 搜索栏组件
+# FaSearchBar 搜索栏
 可折叠的搜索区域容器组件，用于表单筛选条件区域。
@@ -1,4 +1,4 @@
-# FaSelect 选择器组件
+# FaSelect 选择器
 下拉选择器组件，支持单选、多选、分组和下拉内容定位方式。
@@ -1,4 +1,4 @@
-# FaSwitch 开关组件
+# FaSwitch 开关
 开关切换组件，支持图标和状态变化前的回调处理。
@@ -1,4 +1,4 @@
-# FaTabs 标签页组件
+# FaTabs 标签页
 标签页切换组件，支持图标和自定义样式。
@@ -1,4 +1,4 @@
-# FaTextarea 文本域组件
+# FaTextarea 文本域
 多行文本输入组件，支持前后缀插槽和自定义样式。
@@ -1,4 +1,4 @@
-# FaToast 轻提示组件
+# FaToast 轻提示
 全局轻提示组件，用于展示操作反馈消息。
@@ -1,4 +1,4 @@
-# FaTooltip 文字提示组件
+# FaTooltip 文字提示
 简洁的文字提示组件，鼠标悬停时显示说明文字。
@@ -1,4 +1,4 @@
-# FaTrend 趋势标识组件
+# FaTrend 趋势标识
 带箭头的趋势标识组件，用于展示数据上升/下降趋势，提供多种视觉风格。
`@@ -1,4 +1,4 @@`
	`# FaAvatar 头像组件`	`# FaAvatar 头像`

	`用户头像组件，支持图片加载失败时显示降级内容。`	`用户头像组件，支持图片加载失败时显示降级内容。`
`@@ -1,4 +1,4 @@`
	`# FaButton 按钮组件`	`# FaButton 按钮`

	`基础按钮组件，支持多种样式变体和尺寸，内置加载状态支持。`	`基础按钮组件，支持多种样式变体和尺寸，内置加载状态支持。`
`@@ -1,4 +1,4 @@`
	`# FaCard 卡片组件`	`# FaCard 卡片`

	`基础卡片容器组件，支持标题、描述、内容和页脚区域。`	`基础卡片容器组件，支持标题、描述、内容和页脚区域。`
`@@ -1,4 +1,4 @@`
	`# FaCheckbox 复选框组件`	`# FaCheckbox 复选框`

	`简洁的复选框组件，支持双向绑定和标签内容插槽。`	`简洁的复选框组件，支持双向绑定和标签内容插槽。`
`@@ -1,4 +1,4 @@`
	`# FaCollapsible 折叠面板组件`	`# FaCollapsible 折叠面板`

	`可折叠的内容面板，支持展开/收起动画。`	`可折叠的内容面板，支持展开/收起动画。`
`@@ -1,4 +1,4 @@`
	`# FaContextMenu 右键菜单组件`	`# FaContextMenu 右键菜单`

	`右键点击时弹出的上下文菜单，支持分组、子菜单和图标。`	`右键点击时弹出的上下文菜单，支持分组、子菜单和图标。`
`@@ -1,4 +1,4 @@`
	`# FaDivider 分割线组件`	`# FaDivider 分割线`

	`带文字内容的分割线组件，支持文字位置调整。`	`带文字内容的分割线组件，支持文字位置调整。`
`@@ -1,4 +1,4 @@`
	`# FaDrawer 抽屉组件`	`# FaDrawer 抽屉`

	`侧滑抽屉组件，支持从四个方向弹出，内置头部、内容区和底部操作区。`	`侧滑抽屉组件，支持从四个方向弹出，内置头部、内容区和底部操作区。`
`@@ -1,4 +1,4 @@`
	`# FaDropdown 下拉菜单组件`	`# FaDropdown 下拉菜单`

	`功能强大的下拉菜单组件，支持分组、子菜单、图标和自定义内容。`	`功能强大的下拉菜单组件，支持分组、子菜单、图标和自定义内容。`
`@@ -1,4 +1,4 @@`
	`# FaFileUpload 文件上传组件`	`# FaFileUpload 文件上传`

	`支持拖拽、点击和粘贴上传的文件上传组件，带进度显示和文件管理功能。`	`支持拖拽、点击和粘贴上传的文件上传组件，带进度显示和文件管理功能。`