Skip to content

Commit

Permalink
docs: 修复 headerActionIcons 错误文档 close #2362 (#2363)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lijinke666
lijinke666 authored Oct 11, 2023
1 parent c8d2c94 commit b719c8a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
18 changes: 9 additions & 9 deletions s2-site/docs/common/header-action-icon.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
| 参数 | 说明 | 类型 | 默认值 | 必选 | 取值 | 版本 |
| ---------------- | ----------- | ----------- | ------ | ---- | ----------- | --- |
| iconNames | 已经注册的 icon 名称，或用户通过 customSVGIcons 注册的 icon 名称 | `string[]` | | ✓ | | |
| belongsCell | 需要增加操作图标的单元格名称 | `string[]` | | ✓ | 角头：'cornerCell';<br>列头：'colCell';<br>行头：'rowCell' | |
| defaultHide | 控制是否 hover 才展示 icon | `boolean | (meta: Node, iconName: string) => boolean` | false | | true | `1.26.0` 支持配置为一个函数 |
| displayCondition | 展示的过滤条件，可以通过该回调函数用户自定义行列头哪些层级或单元格需要展示 icon。 所有返回值为 true 的 icon 会展示给用户。 | `(mete: Node, iconName: string) => boolean;` | | | | `1.26.0` 回传 `iconName` 并按单个 icon 控制显隐 |
| action | icon 点击之后的执行函数 | `(headerActionIconProps: HeaderActionIconProps) => void;` | | | | 已废弃，请使用 `onClick` |
| onClick | icon 点击之后的执行函数 | `(headerIconClickParams: HeaderIconClickParams) => void;` | | | | `1.26.0` |
| onHover | icon hover 开始及结束之后的执行函数 | `(headerIconHoverParams: HeaderIconHoverParams) => void;` | | | | `1.26.0` |
| belongsCell | 需要增加操作图标的单元格名称 | `string` | | ✓ | 角头：`cornerCell`;<br>列头：`colCell`;<br>行头：`rowCell` | |
| defaultHide | 控制是否 hover 在对应单元格时才展示 icon, 默认始终展示 | `boolean \| (meta: Node, iconName: string) => boolean` | false | | | `1.26.0` 支持配置为一个函数 |
| displayCondition | 自定义展示条件，可根据当前单元格信息动态控制 icon 是否展示 | `(mete: Node, iconName: string) => boolean` | | | | `1.26.0` 回传 `iconName` 并按单个 icon 控制显隐 |
| action | icon 点击之后的执行函数 （已废弃，请使用 `onClick`) | `(headerActionIconProps: HeaderActionIconProps) => void` | | | | |
| onClick | icon 点击之后的执行函数 | `(headerIconClickParams: HeaderIconClickParams) => void` | | | | `1.26.0` |
| onHover | icon hover 开始及结束之后的执行函数 | `(headerIconHoverParams: HeaderIconHoverParams) => void` | | | | `1.26.0` |

​

Expand All @@ -24,9 +24,9 @@

| 参数 | 功能描述 | 类型 | 默认值 | 必选 |
| --- | --- | --- | --- | --- |
| iconName | 当前点击的 icon 名称 | string | | ✓ |
| meta |当前 cell 的 meta 信息| Node | | ✓ |
| event |当前点击事件信息| Event |false| ✓ |
| iconName | 当前 icon 名称 | string | | ✓ |
| meta |当前 cell 的 meta 信息| [Node](/api/basic-class/node) | | ✓ |
| event |当前点击事件信息| Event | false | ✓ |

## CustomSVGIcon

Expand Down
10 changes: 5 additions & 5 deletions s2-site/docs/common/icon.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ order: 3

| icon 名称 | icon 图标 | 功能描述 | icon 名称 | icon 图标 | 功能描述 |
| ------------- | --------------------- | ---------- | ---------------- | ----------- | ------------------ |
| CellDown | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471683806-41687600-9f55-49f7-8210-25c438b8152e.png" height=30> | 同环比下降 | ExpandColIcon | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472462583-40f32d2a-0a26-4e4f-8ebf-39603c3b8939.png" height=30> | 明细表隐藏展开 |
| CellDown | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471683806-41687600-9f55-49f7-8210-25c438b8152e.png" height=30> | 同环比下降 | ExpandColIcon | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472462583-40f32d2a-0a26-4e4f-8ebf-39603c3b8939.png" height=30> | 展开列头 |
| CellUp | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471716079-9bc714c4-0b4e-4176-a2b9-d620251d30d6.png" height=30> | 同环比上升 | Plus | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632475581023-4a53ecff-942c-45ff-8dc5-1c5b08e7b157.png" height=30> | 树状表格展开 |
| GlobalAsc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471780679-5a7ee62d-73be-4713-945d-6b03f2786e8d.png" height=30> | 全局升序 | Minus | <img alt="icon" src="https://gw.alipayobjects.com/zos/antfincdn/dKGwptOOB9/34d9064e-eaee-4160-ad84-a08f4ef1fee4.png" height=30> | 树状表格收起 |
| GlobalDesc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471882478-bdbe6981-ce4b-4082-b6ad-f13577329147.png" height=30> | 全局降序 | SortDown | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473030451-4aed635f-d192-470b-91e6-5bfed9fac595.png" height=30> | 明细表降序 |
| GroupAsc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471962652-722d8fec-9bee-4a85-9cc1-ac4f51f483c6.png" height=30> | 组内升序 | SortDownSelected | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472951651-80c2949e-7b03-4a64-a283-1c4e37fc5e60.png" height=30> | 明细表降序选择状态 |
| GroupDesc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472173126-d751f07a-10c4-44fb-a916-362f2ba611e6.png" height=30> | 组内降序 | SortUp | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473083059-12d7b39e-1a59-4584-b2f6-4608ee9e04fb.png" height=30> | 明细表升序 |
| Trend | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473312620-593aeff4-c618-4b2e-bc26-136a751efff9.png" height=30> | 趋势图 | SortUpSelected | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473154460-1a7c66bc-7f3f-4c46-a6e1-a586d566b94c.png" height=30> | 明细表升序选择状态 |
| GlobalDesc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471882478-bdbe6981-ce4b-4082-b6ad-f13577329147.png" height=30> | 全局降序 | SortDown | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473030451-4aed635f-d192-470b-91e6-5bfed9fac595.png" height=30> | 降序 |
| GroupAsc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632471962652-722d8fec-9bee-4a85-9cc1-ac4f51f483c6.png" height=30> | 组内升序 | SortDownSelected | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472951651-80c2949e-7b03-4a64-a283-1c4e37fc5e60.png" height=30> | 降序选中状态 |
| GroupDesc | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632472173126-d751f07a-10c4-44fb-a916-362f2ba611e6.png" height=30> | 组内降序 | SortUp | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473083059-12d7b39e-1a59-4584-b2f6-4608ee9e04fb.png" height=30> | 升序 |
| Trend | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473312620-593aeff4-c618-4b2e-bc26-136a751efff9.png" height=30> | 趋势图 | SortUpSelected | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473154460-1a7c66bc-7f3f-4c46-a6e1-a586d566b94c.png" height=30> | 升序选中状态 |
| ArrowUp | <img alt="icon" src="https://gw.alipayobjects.com/zos/antfincdn/g9lTlN2xG/84042923-69b2-4ccc-89b4-1b2b5aa45d68.png" height=30> | 指标上升 |ArrowDown | <img alt="icon" src="https://gw.alipayobjects.com/zos/antfincdn/OjQEFxclz/c7f5cce0-16e4-4522-987a-ae21ab9f24fa.png" height=30> | 指标下降 |
| DrillDownIcon | <img alt="icon" src="https://intranetproxy.alipay.com/skylark/lark/0/2021/png/315626/1632473411428-4959bde8-ead3-4c81-921d-26035bee21ae.png" height=30> | 下钻 | | | |

1 comment on commit b719c8a

@vercel
Copy link

@vercel vercel bot commented on b719c8a Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

antvis-s2 – ./

antvis-s2-antv-s2.vercel.app
antvis-s2.vercel.app
antvis-s2-git-master-antv-s2.vercel.app

Please sign in to comment.