docs(Indexes): sync api docs

Tencent · Sep 11, 2024 · 3061ca5 · 3061ca5
1 parent 3e93bae
commit 3061ca5
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 5 deletions.
diff --git a/src/_common b/src/_common
diff --git a/src/common.ts b/src/common.ts
@@ -64,6 +64,8 @@ export type TreeOptionData<T = string | number> = {
 
 export type SizeEnum = 'small' | 'medium' | 'large';
 
+export type ShapeEnum = 'circle' | 'round';
+
 export type HorizontalAlignEnum = 'left' | 'center' | 'right';
 
 export type VerticalAlignEnum = 'top' | 'middle' | 'bottom';

diff --git a/src/indexes/demos/custom.vue b/src/indexes/demos/custom.vue
@@ -57,6 +57,7 @@ const change = (index: number | string) => {
 <style lang="less">
 .component-wrap {
   height: calc(100vh - 50px);
+  background-color: #fff;
 }
 
 .capsule {
@@ -65,7 +66,7 @@ const change = (index: number | string) => {
   height: 30px;
   border-radius: 15px;
   background-color: #f3f3f3;
-  padding-left: 32rpx;
+  padding-left: 16px;
   display: flex;
   align-items: center;
   font-size: 14px;

diff --git a/src/indexes/indexes.en-US.md b/src/indexes/indexes.en-US.md
@@ -6,7 +6,7 @@
 
 name | type | default | description | required
 -- | -- | -- | -- | --
-indexList | Array | - | Typescript：`(string \| number)[]` | N
+indexList | Array | - | Typescript：`Array<string \| number>` | N
 sticky | Boolean | true | Typescript：`Boolean` | N
 stickyOffset | Number | 0 | \- | N
 onChange | Function |  | Typescript：`(index: string \| number) => void`<br/> | N

diff --git a/src/indexes/indexes.md b/src/indexes/indexes.md
@@ -6,7 +6,7 @@
 
 名称 | 类型 | 默认值 | 描述 | 必传
 -- | -- | -- | -- | --
-indexList | Array | - | 索引字符列表。不传默认 `A-Z`。TS 类型：`(string \| number)[]` | N
+indexList | Array | - | 索引字符列表。不传默认 `A-Z`。TS 类型：`Array<string \| number>` | N
 sticky | Boolean | true | 索引是否吸顶，默认为true。TS 类型：`Boolean` | N
 stickyOffset | Number | 0 | 锚点吸顶时与顶部的距离	 | N
 onChange | Function |  | TS 类型：`(index: string \| number) => void`<br/>索引发生变更时触发事件 | N

diff --git a/src/indexes/type.ts b/src/indexes/type.ts
@@ -8,7 +8,7 @@ export interface TdIndexesProps {
   /**
    * 索引字符列表。不传默认 `A-Z`
    */
-  indexList?: (string | number)[];
+  indexList?: Array<string | number>;
   /**
    * 索引是否吸顶，默认为true
    * @default true