king-design-analyzer 2.1.9 → 2.2.0

package/dist/metadata/index.d.mts

@@ -1,7 +1,10 @@
+import { C as ComponentInheritance } from '../resolve-BsLBxlBi.mjs';
+
 /**
  * Components 元数据模块入口
  * 提供对 components 目录中 JSON 元数据的访问
  */
+
 /**
  * 组件元数据类型定义
  */
@@ -15,11 +18,13 @@ interface ComponentProp {
     required?: boolean;
     default?: string;
     usageExample?: string;
+    tags?: string[];
 }
 interface ComponentEvent {
     name: string;
     vueEventName?: string;
     description: string;
+    params?: ComponentActionParam[];
     payload?: {
         name: string;
         type: string;
@@ -27,6 +32,20 @@ interface ComponentEvent {
     }[];
     usageExample?: string;
 }
+interface ComponentActionParam {
+    name: string;
+    type: string;
+    description: string;
+    optional?: boolean;
+    default?: string;
+}
+interface ComponentMethod {
+    name: string;
+    description: string;
+    params?: ComponentActionParam[];
+    returnType?: string;
+    usageExample?: string;
+}
 interface ComponentSlot {
     name: string;
     description: string;
@@ -43,13 +62,14 @@ interface ComponentMetadata {
     props: ComponentProp[];
     events: ComponentEvent[];
     slots: ComponentSlot[];
-    methods?: any[];
+    methods?: ComponentMethod[];
     examples?: any[];
     subComponents?: any[];
     commonMistakes?: any[];
     searchKeywords?: string[];
     useCases?: string[];
     relatedComponents?: string[];
+    inherits?: ComponentInheritance[];
 }
 /**
  * 获取所有可用的组件名称列表
@@ -74,4 +94,4 @@ declare function getComponentsDir(): string;
  */
 declare function getComponentPath(componentName: string): string;
 
-export { type ComponentEvent, type ComponentMetadata, type ComponentProp, type ComponentSlot, getAllComponentsMetadata, getComponentMetadata, getComponentPath, getComponentsDir, getComponentsList };
+export { type ComponentActionParam, type ComponentEvent, type ComponentMetadata, type ComponentMethod, type ComponentProp, type ComponentSlot, getAllComponentsMetadata, getComponentMetadata, getComponentPath, getComponentsDir, getComponentsList };

package/dist/metadata/index.d.ts

@@ -1,7 +1,10 @@
+import { C as ComponentInheritance } from '../resolve-BsLBxlBi.js';
+
 /**
  * Components 元数据模块入口
  * 提供对 components 目录中 JSON 元数据的访问
  */
+
 /**
  * 组件元数据类型定义
  */
@@ -15,11 +18,13 @@ interface ComponentProp {
     required?: boolean;
     default?: string;
     usageExample?: string;
+    tags?: string[];
 }
 interface ComponentEvent {
     name: string;
     vueEventName?: string;
     description: string;
+    params?: ComponentActionParam[];
     payload?: {
         name: string;
         type: string;
@@ -27,6 +32,20 @@ interface ComponentEvent {
     }[];
     usageExample?: string;
 }
+interface ComponentActionParam {
+    name: string;
+    type: string;
+    description: string;
+    optional?: boolean;
+    default?: string;
+}
+interface ComponentMethod {
+    name: string;
+    description: string;
+    params?: ComponentActionParam[];
+    returnType?: string;
+    usageExample?: string;
+}
 interface ComponentSlot {
     name: string;
     description: string;
@@ -43,13 +62,14 @@ interface ComponentMetadata {
     props: ComponentProp[];
     events: ComponentEvent[];
     slots: ComponentSlot[];
-    methods?: any[];
+    methods?: ComponentMethod[];
     examples?: any[];
     subComponents?: any[];
     commonMistakes?: any[];
     searchKeywords?: string[];
     useCases?: string[];
     relatedComponents?: string[];
+    inherits?: ComponentInheritance[];
 }
 /**
  * 获取所有可用的组件名称列表
@@ -74,4 +94,4 @@ declare function getComponentsDir(): string;
  */
 declare function getComponentPath(componentName: string): string;
 
-export { type ComponentEvent, type ComponentMetadata, type ComponentProp, type ComponentSlot, getAllComponentsMetadata, getComponentMetadata, getComponentPath, getComponentsDir, getComponentsList };
+export { type ComponentActionParam, type ComponentEvent, type ComponentMetadata, type ComponentMethod, type ComponentProp, type ComponentSlot, getAllComponentsMetadata, getComponentMetadata, getComponentPath, getComponentsDir, getComponentsList };

package/dist/metadata/index.js

@@ -1,11 +1,10 @@
 'use strict';
 
+var chunkKF5YBEM5_js = require('../chunk-KF5YBEM5.js');
 require('../chunk-JSBRDJBE.js');
 var fs = require('fs');
 var path = require('path');
-var url = require('url');
 
-var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function _interopNamespace(e) {
   if (e && e.__esModule) return e;
   var n = Object.create(null);
@@ -27,9 +26,21 @@ function _interopNamespace(e) {
 var fs__namespace = /*#__PURE__*/_interopNamespace(fs);
 var path__namespace = /*#__PURE__*/_interopNamespace(path);
 
-var __filename$1 = url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.js', document.baseURI).href)));
-var __dirname$1 = path__namespace.dirname(__filename$1);
-var COMPONENTS_DIR = path__namespace.resolve(__dirname$1, "../components");
+var COMPONENTS_DIR = chunkKF5YBEM5_js.resolvePackageResourceDir("components");
+function loadAllRawComponents() {
+  const metadata = {};
+  try {
+    const files = fs__namespace.readdirSync(COMPONENTS_DIR).filter((f) => f.endsWith(".json"));
+    for (const file of files) {
+      const content = fs__namespace.readFileSync(path__namespace.join(COMPONENTS_DIR, file), "utf-8");
+      const data = JSON.parse(content);
+      metadata[data.name] = data;
+    }
+  } catch {
+    return {};
+  }
+  return metadata;
+}
 function getComponentsList() {
   try {
     return fs__namespace.readdirSync(COMPONENTS_DIR).filter((f) => f.endsWith(".json")).map((f) => f.replace(".json", ""));
@@ -39,23 +50,22 @@ function getComponentsList() {
 }
 function getComponentMetadata(componentName) {
   try {
-    const filePath = path__namespace.join(COMPONENTS_DIR, `${componentName}.json`);
-    const content = fs__namespace.readFileSync(filePath, "utf-8");
-    return JSON.parse(content);
+    const rawMetadata = loadAllRawComponents();
+    const target = Object.values(rawMetadata).find(
+      (component) => component.name === componentName || component.id === componentName
+    );
+    return target ? chunkKF5YBEM5_js.resolveMetadataInheritance(target, rawMetadata) : null;
   } catch {
     return null;
   }
 }
 function getAllComponentsMetadata() {
-  const metadata = {};
-  const list = getComponentsList();
-  for (const name of list) {
-    const data = getComponentMetadata(name);
-    if (data) {
-      metadata[name] = data;
-    }
+  const rawMetadata = loadAllRawComponents();
+  const resolvedMetadata = {};
+  for (const component of Object.values(rawMetadata)) {
+    resolvedMetadata[component.name] = chunkKF5YBEM5_js.resolveMetadataInheritance(component, rawMetadata);
   }
-  return metadata;
+  return resolvedMetadata;
 }
 function getComponentsDir() {
   return COMPONENTS_DIR;

package/dist/metadata/index.mjs

@@ -1,11 +1,23 @@
+import { resolvePackageResourceDir, resolveMetadataInheritance } from '../chunk-QC6VTSA3.mjs';
 import '../chunk-UJCSKKID.mjs';
 import * as fs from 'fs';
 import * as path from 'path';
-import { fileURLToPath } from 'url';
 
-var __filename$1 = fileURLToPath(import.meta.url);
-var __dirname$1 = path.dirname(__filename$1);
-var COMPONENTS_DIR = path.resolve(__dirname$1, "../components");
+var COMPONENTS_DIR = resolvePackageResourceDir("components");
+function loadAllRawComponents() {
+  const metadata = {};
+  try {
+    const files = fs.readdirSync(COMPONENTS_DIR).filter((f) => f.endsWith(".json"));
+    for (const file of files) {
+      const content = fs.readFileSync(path.join(COMPONENTS_DIR, file), "utf-8");
+      const data = JSON.parse(content);
+      metadata[data.name] = data;
+    }
+  } catch {
+    return {};
+  }
+  return metadata;
+}
 function getComponentsList() {
   try {
     return fs.readdirSync(COMPONENTS_DIR).filter((f) => f.endsWith(".json")).map((f) => f.replace(".json", ""));
@@ -15,23 +27,22 @@ function getComponentsList() {
 }
 function getComponentMetadata(componentName) {
   try {
-    const filePath = path.join(COMPONENTS_DIR, `${componentName}.json`);
-    const content = fs.readFileSync(filePath, "utf-8");
-    return JSON.parse(content);
+    const rawMetadata = loadAllRawComponents();
+    const target = Object.values(rawMetadata).find(
+      (component) => component.name === componentName || component.id === componentName
+    );
+    return target ? resolveMetadataInheritance(target, rawMetadata) : null;
   } catch {
     return null;
   }
 }
 function getAllComponentsMetadata() {
-  const metadata = {};
-  const list = getComponentsList();
-  for (const name of list) {
-    const data = getComponentMetadata(name);
-    if (data) {
-      metadata[name] = data;
-    }
+  const rawMetadata = loadAllRawComponents();
+  const resolvedMetadata = {};
+  for (const component of Object.values(rawMetadata)) {
+    resolvedMetadata[component.name] = resolveMetadataInheritance(component, rawMetadata);
   }
-  return metadata;
+  return resolvedMetadata;
 }
 function getComponentsDir() {
   return COMPONENTS_DIR;

package/dist/resolve-BsLBxlBi.d.mts

@@ -0,0 +1,24 @@
+interface ComponentInheritance {
+    component: string;
+    include?: Array<'props' | 'events' | 'slots' | 'methods'>;
+    exclude?: string[];
+}
+type NamedItem = {
+    name: string;
+    tags?: string[];
+    [key: string]: any;
+};
+interface ResolvableComponentMetadata {
+    id?: string;
+    name: string;
+    props?: NamedItem[];
+    events?: NamedItem[];
+    slots?: NamedItem[];
+    methods?: NamedItem[];
+    inherits?: ComponentInheritance[];
+    [key: string]: any;
+}
+declare function normalizeMetadataName(value: string): string;
+declare function resolveMetadataInheritance<T extends ResolvableComponentMetadata>(metadata: T, lookup: Record<string, T>, visited?: Set<string>): T;
+
+export { type ComponentInheritance as C, type ResolvableComponentMetadata as R, normalizeMetadataName as n, resolveMetadataInheritance as r };

package/dist/resolve-BsLBxlBi.d.ts

@@ -0,0 +1,24 @@
+interface ComponentInheritance {
+    component: string;
+    include?: Array<'props' | 'events' | 'slots' | 'methods'>;
+    exclude?: string[];
+}
+type NamedItem = {
+    name: string;
+    tags?: string[];
+    [key: string]: any;
+};
+interface ResolvableComponentMetadata {
+    id?: string;
+    name: string;
+    props?: NamedItem[];
+    events?: NamedItem[];
+    slots?: NamedItem[];
+    methods?: NamedItem[];
+    inherits?: ComponentInheritance[];
+    [key: string]: any;
+}
+declare function normalizeMetadataName(value: string): string;
+declare function resolveMetadataInheritance<T extends ResolvableComponentMetadata>(metadata: T, lookup: Record<string, T>, visited?: Set<string>): T;
+
+export { type ComponentInheritance as C, type ResolvableComponentMetadata as R, normalizeMetadataName as n, resolveMetadataInheritance as r };

package/dist/runtime/index.js

@@ -1,16 +1,16 @@
 'use strict';
 
-var chunkD3Y6FGWA_js = require('../chunk-D3Y6FGWA.js');
-var chunkHPAUCD5I_js = require('../chunk-HPAUCD5I.js');
+var chunkEYKZY2F3_js = require('../chunk-EYKZY2F3.js');
+var chunkCR3GC4H3_js = require('../chunk-CR3GC4H3.js');
 require('../chunk-JSBRDJBE.js');
 
 
 
 Object.defineProperty(exports, "validateRuntimePrecheck", {
   enumerable: true,
-  get: function () { return chunkD3Y6FGWA_js.validateRuntimePrecheck; }
+  get: function () { return chunkEYKZY2F3_js.validateRuntimePrecheck; }
 });
 Object.defineProperty(exports, "compileSFC", {
   enumerable: true,
-  get: function () { return chunkHPAUCD5I_js.compileSFC; }
+  get: function () { return chunkCR3GC4H3_js.compileSFC; }
 });

package/dist/runtime/index.mjs

@@ -1,3 +1,3 @@
-export { validateRuntimePrecheck } from '../chunk-NZ6TLWMD.mjs';
-export { compileSFC } from '../chunk-L4DS3EXI.mjs';
+export { validateRuntimePrecheck } from '../chunk-D2SXGGTX.mjs';
+export { compileSFC } from '../chunk-BI5TIQID.mjs';
 import '../chunk-UJCSKKID.mjs';

package/dist/shared/index.d.mts

@@ -0,0 +1,10 @@
+export { C as ComponentInheritance, R as ResolvableComponentMetadata, n as normalizeMetadataName, r as resolveMetadataInheritance } from '../resolve-BsLBxlBi.mjs';
+
+interface ResolvePackagePathOptions {
+    cwd?: string;
+    packageName?: string;
+}
+declare function resolvePackageRoot(options?: ResolvePackagePathOptions): string | null;
+declare function resolvePackageResourceDir(resourceDirName: string, options?: ResolvePackagePathOptions): string;
+
+export { type ResolvePackagePathOptions, resolvePackageResourceDir, resolvePackageRoot };

package/dist/shared/index.d.ts

@@ -0,0 +1,10 @@
+export { C as ComponentInheritance, R as ResolvableComponentMetadata, n as normalizeMetadataName, r as resolveMetadataInheritance } from '../resolve-BsLBxlBi.js';
+
+interface ResolvePackagePathOptions {
+    cwd?: string;
+    packageName?: string;
+}
+declare function resolvePackageRoot(options?: ResolvePackagePathOptions): string | null;
+declare function resolvePackageResourceDir(resourceDirName: string, options?: ResolvePackagePathOptions): string;
+
+export { type ResolvePackagePathOptions, resolvePackageResourceDir, resolvePackageRoot };

package/dist/shared/index.js

@@ -0,0 +1,23 @@
+'use strict';
+
+var chunkKF5YBEM5_js = require('../chunk-KF5YBEM5.js');
+require('../chunk-JSBRDJBE.js');
+
+
+
+Object.defineProperty(exports, "normalizeMetadataName", {
+  enumerable: true,
+  get: function () { return chunkKF5YBEM5_js.normalizeMetadataName; }
+});
+Object.defineProperty(exports, "resolveMetadataInheritance", {
+  enumerable: true,
+  get: function () { return chunkKF5YBEM5_js.resolveMetadataInheritance; }
+});
+Object.defineProperty(exports, "resolvePackageResourceDir", {
+  enumerable: true,
+  get: function () { return chunkKF5YBEM5_js.resolvePackageResourceDir; }
+});
+Object.defineProperty(exports, "resolvePackageRoot", {
+  enumerable: true,
+  get: function () { return chunkKF5YBEM5_js.resolvePackageRoot; }
+});

package/dist/shared/index.mjs

@@ -0,0 +1,2 @@
+export { normalizeMetadataName, resolveMetadataInheritance, resolvePackageResourceDir, resolvePackageRoot } from '../chunk-QC6VTSA3.mjs';
+import '../chunk-UJCSKKID.mjs';

package/dist/static/index.js

@@ -1,20 +1,20 @@
 'use strict';
 
-var chunkWYSRJVX4_js = require('../chunk-WYSRJVX4.js');
-var chunkHPAUCD5I_js = require('../chunk-HPAUCD5I.js');
+var chunkTA3SV4SP_js = require('../chunk-TA3SV4SP.js');
+var chunkCR3GC4H3_js = require('../chunk-CR3GC4H3.js');
 require('../chunk-JSBRDJBE.js');
 
 
 
 Object.defineProperty(exports, "validateCompilation", {
   enumerable: true,
-  get: function () { return chunkWYSRJVX4_js.validateCompilation; }
+  get: function () { return chunkTA3SV4SP_js.validateCompilation; }
 });
 Object.defineProperty(exports, "compileSFC", {
   enumerable: true,
-  get: function () { return chunkHPAUCD5I_js.compileSFC; }
+  get: function () { return chunkCR3GC4H3_js.compileSFC; }
 });
 Object.defineProperty(exports, "scopeStyles", {
   enumerable: true,
-  get: function () { return chunkHPAUCD5I_js.scopeStyles; }
+  get: function () { return chunkCR3GC4H3_js.scopeStyles; }
 });

package/dist/static/index.mjs

@@ -1,3 +1,3 @@
-export { validateCompilation } from '../chunk-DSWKLUIX.mjs';
-export { compileSFC, scopeStyles } from '../chunk-L4DS3EXI.mjs';
+export { validateCompilation } from '../chunk-3LYQ5XFM.mjs';
+export { compileSFC, scopeStyles } from '../chunk-BI5TIQID.mjs';
 import '../chunk-UJCSKKID.mjs';

package/docs_for_llm/actions.doc.md

@@ -0,0 +1,77 @@
+# 操作按钮集 (Actions)
+
+用于组织主操作和次操作的按钮集合组件，常放在表格操作列、详情页头部和工具栏右侧，避免页面出现过多平铺按钮。
+
+**关键词**: actions, action buttons, 操作按钮集, 更多操作, 主次操作, 操作列按钮
+
+**使用场景**: 表格操作列、页面头部操作区、主次操作分层展示
+
+## 导入语句
+```typescript
+import { Actions } from '@ksyun-internal/versatile';
+```
+
+## 属性 (Props)
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| primaries | `ActionConfig[]` | `[]` | 否 | 一级操作按钮列表 | - | - |
+| secondaries | `ActionConfig[]` | `[]` | 否 | 二级操作按钮列表，通常展示在“更多”菜单中 | - | - |
+
+## 插槽 (Slots)
+| 插槽名 | 说明 | 模板写法 | 示例 |
+| --- | --- | --- | --- |
+| btnText | 自定义按钮文案渲染 | `<template #btnText="{ action }">...</template>` | - |
+
+## 使用示例
+### 表格操作列中的主次操作
+**场景**: 在列表行内同时承载高频与低频操作，减少操作列拥挤。
+
+将高频操作直接展示，低频操作折叠到更多菜单中。
+
+**使用的 API**: 属性: primaries, secondaries
+
+```vue
+<script setup lang="ts">
+import { Actions } from '@ksyun-internal/versatile';
+
+const primaries = [
+  { text: '重启', type: 'primary', onClick: () => console.log('restart') },
+];
+const secondaries = [
+  { text: '续费', onClick: () => console.log('renew') },
+  { text: '释放', danger: true, onClick: () => console.log('delete') },
+];
+</script>
+
+<template>
+  <Actions :primaries="primaries" :secondaries="secondaries" />
+</template>
+```
+
+### 自定义操作按钮文案
+**场景**: 在操作区给危险动作补充更明确的文案提示。
+
+使用 btnText 插槽为危险操作补充风险提示。
+
+**使用的 API**: 属性: primaries, secondaries
+
+```vue
+<script setup lang="ts">
+import { Actions } from '@ksyun-internal/versatile';
+
+const primaries = [{ text: '启动', onClick: () => console.log('start') }];
+const secondaries = [{ text: '释放', danger: true, onClick: () => console.log('release') }];
+</script>
+
+<template>
+  <Actions :primaries="primaries" :secondaries="secondaries">
+    <template #btnText="{ action }">
+      {{ action.danger ? action.text + '（高风险）' : action.text }}
+    </template>
+  </Actions>
+</template>
+```
+
+## 相关组件
+ButtonLink, IconTooltip
+

package/docs_for_llm/advancedset.doc.md

@@ -0,0 +1,89 @@
+# 高级设置开关 (AdvancedSet)
+
+用于折叠和展开高级配置区域的业务组件，适合购买页、创建页中把非高频参数收进“高级设置”。
+
+**关键词**: advanced set, advanced options, 高级设置, 折叠配置区, 高级参数
+
+**使用场景**: 高级参数开关、可折叠配置区、编辑页默认展开高级设置
+
+## 导入语句
+```typescript
+import { AdvancedSet } from '@ksyun-internal/versatile';
+```
+
+## 属性 (Props)
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| modelValue | `boolean` | `undefined` | 否 | 是否展开高级设置 | - | - |
+| label | `string` | `undefined` | 否 | 标题文案 | - | - |
+| appendTip | `string` | `undefined` | 否 | 追加提示文案 | - | - |
+
+## 事件 (Events)
+| 事件名 | Vue事件名 | 说明 | 回调参数 | 示例 |
+| --- | --- | --- | --- | --- |
+| update:modelValue | `@update:modelValue` | 用户展开或收起高级设置区域时触发，可用于同步表单状态或埋点。 | `value?: boolean` | - |
+
+### 事件参数说明
+**update:modelValue**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| value | `boolean` | 否 | - | 当前高级设置区域的展开状态。 |
+
+## 插槽 (Slots)
+| 插槽名 | 说明 | 模板写法 | 示例 |
+| --- | --- | --- | --- |
+| default | 高级设置内容区域 | `<AdvancedSet>...</AdvancedSet>` | - |
+
+## 使用示例
+### 购买页中的高级设置折叠区
+**场景**: 创建实例时把网络、命名等低频参数收纳到高级设置区。
+
+默认收起高级参数，只在用户主动展开后展示额外配置。
+
+**使用的 API**: 属性: modelValue, label, appendTip | 事件: update:modelValue
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { AdvancedSet, FormItemInput, FormItemSpinner } from '@ksyun-internal/versatile';
+
+const advanced = ref(false);
+const hostname = ref('web-01');
+const bandwidth = ref(20);
+</script>
+
+<template>
+  <AdvancedSet v-model="advanced" label="高级设置" append-tip="修改后将影响实例网络配置">
+    <FormItemInput v-model="hostname" label="主机名" />
+    <FormItemSpinner v-model="bandwidth" label="带宽峰值" unit="Mbps" />
+  </AdvancedSet>
+</template>
+```
+
+### 默认展开高级设置
+**场景**: 在编辑页面中默认展开高级参数，方便用户快速核对设置。
+
+在编辑已有配置时直接展开高级区域，减少额外点击。
+
+**使用的 API**: 属性: modelValue, label, appendTip | 事件: update:modelValue
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { AdvancedSet, FormItemSwitch } from '@ksyun-internal/versatile';
+
+const advanced = ref(true);
+const enableMonitor = ref(false);
+</script>
+
+<template>
+  <AdvancedSet v-model="advanced" label="高级设置" append-tip="修改后即时生效">
+    <FormItemSwitch v-model="enableMonitor" label="开启监控增强" />
+  </AdvancedSet>
+</template>
+```
+
+## 相关组件
+FormItemInput, FormItemSpinner
+

package/docs_for_llm/affix.doc.md

@@ -12,25 +12,33 @@ import { Affix } from '@king-design/vue';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| top | `number` | `undefined` | 否 | 距离窗口顶部的偏移量，设置为 undefined 则不生效 | `<Affix :top="100"></Affix>` |
-| bottom | `number` | `undefined` | 否 | 距离窗口底部的偏移量，设置为 undefined 则不生效 | `<Affix :bottom="50"></Affix>` |
-| shouldFix | `Function` | `undefined` | 否 | 自定义是否需要固定的函数，返回 boolean | `<Affix :shouldFix="checkFix"></Affix>` |
-| exclude | `Function` | `undefined` | 否 | 自定义排除固定的函数，返回 boolean 表示不固定 | `<Affix :exclude="checkExclude"></Affix>` |
-| disabled | `boolean` | `false` | 否 | 是否禁用固定功能 | `<Affix disabled></Affix>` |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| top | `number` | `undefined` | 否 | 距离窗口顶部的偏移量，设置为 undefined 则不生效 | - | `<Affix :top="100"></Affix>` |
+| bottom | `number` | `undefined` | 否 | 距离窗口底部的偏移量，设置为 undefined 则不生效 | - | `<Affix :bottom="50"></Affix>` |
+| shouldFix | `Function` | `undefined` | 否 | 自定义是否需要固定的函数，返回 boolean | - | `<Affix :shouldFix="checkFix"></Affix>` |
+| exclude | `Function` | `undefined` | 否 | 自定义排除固定的函数，返回 boolean 表示不固定 | - | `<Affix :exclude="checkExclude"></Affix>` |
+| disabled | `boolean` | `false` | 否 | 是否禁用固定功能 | - | `<Affix disabled></Affix>` |
 
 ## 事件 (Events)
 | 事件名 | Vue事件名 | 说明 | 回调参数 | 示例 |
 | --- | --- | --- | --- | --- |
 | change | `@change` | 固定状态改变时触发 | `isFixed: boolean` | `<Affix @change="handleChange"></Affix>` |
 
+### 事件参数说明
+**change**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| isFixed | `boolean` | 是 | - | 当前是否处于固定状态 |
+
 ## 插槽 (Slots)
 | 插槽名 | 说明 | 模板写法 | 示例 |
 | --- | --- | --- | --- |
 | default | 需要被固定的元素 | `#default` | `<Affix><Button>Fixed Button</Button></Affix>` |
 
 ## 常见错误与正确用法 (Anti-Hallucination)
+### 父容器滚动问题
 > **错误用法**: `<div style="overflow: auto; height: 200px;">
   <Affix :top="10">...</Affix>
 </div>`