docs(site): update docs

Author: xiejay97

packages/site/src/app/routes/components/interface/Interface.md

@@ -1 +1,11 @@
 # Interface
+
+```ts
+type DId = string | number;
+
+type DSize = 'smaller' | 'larger';
+
+type DLang = 'en-US' | 'zh-CN';
+
+type DCloneHTMLElement<P = React.HTMLAttributes<HTMLElement>> = (el: React.ReactElement<P>) => React.ReactElement<P>;
+```

packages/site/src/app/routes/components/interface/Interface.zh-CN.md

@@ -1 +1,11 @@
 # 接口
+
+```ts
+type DId = string | number;
+
+type DSize = 'smaller' | 'larger';
+
+type DLang = 'en-US' | 'zh-CN';
+
+type DCloneHTMLElement<P = React.HTMLAttributes<HTMLElement>> = (el: React.ReactElement<P>) => React.ReactElement<P>;
+```

packages/site/src/app/routes/docs/faq/FAQ.md

@@ -20,14 +20,9 @@ We agree that `undefined` represents that the component is in an uncontrolled st
 
 ## What is the general null value of the controlled component
 
-The null value of the controlled component is divided into the following situations:
+The null value of the controlled component is generally defined as `null`, please refer to the component API for the actual situation.
 
-- String type: `''`
-- number: `null`
-- array: `[]`
-- Other: `null`
-
-## How to modify `dayjs` configuration
+## How to modify dayjs configuration
 
 First of all, we should ensure that the project is the only `dayjs` globally, so the `dayjs` of the component library is placed in `peerDependencies`.
 

packages/site/src/app/routes/docs/faq/FAQ.zh-CN.md

@@ -20,14 +20,9 @@
 
 ## 受控组件空值一般是什么
 
-受控组件空值分为下面几种情况：
+受控组件空值一般定义为 `null`，实际情况请参考组件 API。
 
-- 字符串类型：`''`
-- 数字: `null`
-- 数组: `[]`
-- 其它: `null`
-
-## 如何修改 `dayjs` 配置
+## 如何修改 dayjs 配置
 
 首先我们应该确保项目是全局唯一的 `dayjs`，所以组件库的 `dayjs` 是放在 `peerDependencies` 中。
 

packages/ui/src/components/accordion/README.md

@@ -5,3 +5,35 @@ aria: accordion
 ---
 
 ## API
+
+### DAccordionProps
+
+```tsx
+interface DAccordionItem<ID extends DId> {
+  id: ID;
+  title: React.ReactNode;
+  region: React.ReactNode;
+  arrow?: boolean | 'left';
+  disabled?: boolean;
+}
+
+interface DAccordionProps<ID extends DId, T extends DAccordionItem<ID>> extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
+  dList: T[];
+  dActive?: ID | null | ID[];
+  dActiveOne?: boolean;
+  dArrow?: 'left' | 'right' | false;
+  onActiveChange?: (id: any, item: any) => void;
+  afterActiveChange?: (id: any, item: any, active: boolean) => void;
+}
+```
+
+<!-- prettier-ignore-start -->
+| Property | Description | Default | Version | 
+| --- | --- | --- | --- | 
+| dList | List of data | - |  |
+| dActive | Expanded item, controlled, defaults to `dActiveOne? null : []` | - |  |
+| dActiveOne | Expand at most one item | `false` |  |
+| dArrow | Expand icon position | `'right'` |  |
+| onActiveChange | Callback for expanding/collapsing items | - |  |
+| afterActiveChange | Callback when expand/collapse is complete | - |  |
+<!-- prettier-ignore-end -->

packages/ui/src/components/accordion/README.zh-CN.md

@@ -3,3 +3,35 @@ title: 手风琴
 ---
 
 ## API
+
+### DAccordionProps
+
+```tsx
+interface DAccordionItem<ID extends DId> {
+  id: ID;
+  title: React.ReactNode;
+  region: React.ReactNode;
+  arrow?: boolean | 'left';
+  disabled?: boolean;
+}
+
+interface DAccordionProps<ID extends DId, T extends DAccordionItem<ID>> extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
+  dList: T[];
+  dActive?: ID | null | ID[];
+  dActiveOne?: boolean;
+  dArrow?: 'left' | 'right' | false;
+  onActiveChange?: (id: any, item: any) => void;
+  afterActiveChange?: (id: any, item: any, active: boolean) => void;
+}
+```
+
+<!-- prettier-ignore-start -->
+| 属性 | 说明 | 默认值 | 版本 | 
+| --- | --- | --- | --- | 
+| dList | 数据列表 | - |  |
+| dActive | 展开项目，受控，默认为 `dActiveOne ? null : []` | - |  |
+| dActiveOne | 至多展开一项 | `false` |  |
+| dArrow | 展开图标位置 | `'right'` |  |
+| onActiveChange | 展开/折叠项目的回调 | - |  |
+| afterActiveChange | 完成展开/折叠的回调 | - |  |
+<!-- prettier-ignore-end -->

packages/ui/src/components/affix/README.md

@@ -4,3 +4,22 @@ title: Affix
 ---
 
 ## API
+
+### DAffixProps
+
+```tsx
+interface DAffixProps {
+  children: React.ReactElement;
+  dTarget?: DRefExtra | false;
+  dTop?: number | string;
+  dZIndex?: number | string;
+}
+```
+
+<!-- prettier-ignore-start -->
+| Property | Description | Default | Version | 
+| --- | --- | --- | --- | 
+| dTarget | Set the target element, `false` means the `parentElement` of the element, the default is the scroll container provided by the global configuration | - |  |
+| dTop | The `top` value of the affix away from the target element | `0` |  |
+| dZIndex | Set the `z-index` of the affix | - |  |
+<!-- prettier-ignore-end -->

packages/ui/src/components/affix/README.zh-CN.md

@@ -3,3 +3,22 @@ title: 固钉
 ---
 
 ## API
+
+### DAffixProps
+
+```tsx
+interface DAffixProps {
+  children: React.ReactElement;
+  dTarget?: DRefExtra | false;
+  dTop?: number | string;
+  dZIndex?: number | string;
+}
+```
+
+<!-- prettier-ignore-start -->
+| 属性 | 说明 | 默认值 | 版本 | 
+| --- | --- | --- | --- | 
+| dTarget | 设置目标元素，`false` 表示元素的 `parentElement`，默认为全局配置提供的滚动容器 | - |  |
+| dTop | 固钉距离目标元素的 `top` 值 | `0` |  |
+| dZIndex | 设置固钉的 `z-index` | - |  |
+<!-- prettier-ignore-end -->

packages/ui/src/components/alert/README.md

@@ -5,3 +5,31 @@ aria: alert
 ---
 
 ## API
+
+### DAlertProps
+
+```tsx
+interface DAlertProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
+  dVisible?: boolean;
+  dType?: 'success' | 'warning' | 'error' | 'info';
+  dIcon?: React.ReactNode;
+  dTitle: React.ReactNode;
+  dDescription?: React.ReactNode;
+  dActions?: React.ReactNode[];
+  onClose?: () => void;
+  afterVisibleChange?: (visible: boolean) => void;
+}
+```
+
+<!-- prettier-ignore-start -->
+| Property | Description | Default | Version | 
+| --- | --- | --- | --- | 
+| dVisible | Visible, controlled, default `false` | - | |
+| dType | set type | - | |
+| dIcon | Settings icon | - | |
+| dTitle | set title | - | |
+| dDescription | set description | - | |
+| dActions | set button group, `'close'` means close button | `[]` | |
+| onClose | Callback to close the warning prompt | - | |
+| afterVisibleChange | Finished visible/hidden callback | - | |
+<!-- prettier-ignore-end -->

packages/ui/src/components/alert/README.zh-CN.md

@@ -3,3 +3,31 @@ title: 警告提示
 ---
 
 ## API
+
+### DAlertProps
+
+```tsx
+interface DAlertProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
+  dVisible?: boolean;
+  dType?: 'success' | 'warning' | 'error' | 'info';
+  dIcon?: React.ReactNode;
+  dTitle: React.ReactNode;
+  dDescription?: React.ReactNode;
+  dActions?: React.ReactNode[];
+  onClose?: () => void;
+  afterVisibleChange?: (visible: boolean) => void;
+}
+```
+
+<!-- prettier-ignore-start -->
+| 属性 | 说明 | 默认值 | 版本 | 
+| --- | --- | --- | --- | 
+| dVisible | 是否可见，受控，默认为 `false` | - |  |
+| dType | 设置警告提示类型 | - |  |
+| dIcon | 设置图标 | - |  |
+| dTitle | 设置标题 | - |  |
+| dDescription | 设置描述 | - |  |
+| dActions | 设置按钮组，`'close'` 表示关闭按钮 | `[]` |  |
+| onClose | 关闭警告提示的回调 | - |  |
+| afterVisibleChange | 完成显/隐的回调 | - |  |
+<!-- prettier-ignore-end -->