Skip to content

Commit

Permalink
docs: 完善 tooltip 文档 (#2281)
Browse files Browse the repository at this point in the history
Co-authored-by: 卿珂 <lijinke.ljk@antgroup.com>
  • Loading branch information
lijinke666 and 卿珂 authored Jul 14, 2023
1 parent f610514 commit 32a5096
Show file tree
Hide file tree
Showing 4 changed files with 144 additions and 35 deletions.
21 changes: 21 additions & 0 deletions s2-site/docs/manual/basic/tooltip.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,27 @@ const s2Options = {
};
```
通过实例方法调用同理,[查看更多配置](/api/basic-class/base-tooltip#tooltipshowoptions)
```ts
s2.showTooltip({
options: {
operator: {
menus: [
{
key: 'custom-a',
text: '操作 1',
icon: 'Trend',
onClick: (cell) => {
console.log('操作 1 点击', cell);
},
}
],
},
}
})
```
<br/>
<Playground path='react-component/tooltip/demo/custom-operation.tsx' rid='container-custom-operations' height='300'></playground>
Expand Down
83 changes: 61 additions & 22 deletions s2-site/docs/manual/faq.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,70 @@ s2.render(false)

请查看 [这篇文章](/docs/manual/advanced/get-cell-data)

### 为什么 tooltip`@antv/s2` 中不显示,在 `@antv/s2-react` `@antv/s2-vue` 中可以正常显示?
### 为什么 Tooltip`@antv/s2` 中不显示,在 `@antv/s2-react` `@antv/s2-vue` 中可以正常显示?

请查看 [Tooltip 注意事项](/docs/manual/basic/tooltip#%E7%AE%80%E4%BB%8B)

### 如何在点击或悬停单元格的时候自定义 Tooltip?

请查看相关文档和示例

- [Tooltip 自定义教程](https://s2.antv.antgroup.com/manual/basic/tooltip#%E8%87%AA%E5%AE%9A%E4%B9%89)
- [自定义点击显示 Tooltip](/examples/react-component/tooltip/#custom-click-show-tooltip)
- [自定义悬停显示 Tooltip](/examples/react-component/tooltip/#custom-hover-show-tooltip)

### 如何在 Tooltip 里自定义操作项?

- 方式 1: 默认 tooltip 内容不变,通过 [自定义操作项](https://s2.antv.antgroup.com/zh/examples/react-component/tooltip/#custom-operation), 在内容上方增加自定义操作菜单。
- 方式 2: 通过 [自定义 Tooltip 内容](https://s2.antv.antgroup.com/zh/examples/react-component/tooltip/#custom-content), 完全自定义组件内容。

### React 组件,自定义显示 tooltip 后,内容未更新怎么回事?

当手动调用实例方法 `s2.showTooltip` 时,如果内容是一个 React 自定义组件,且组件内容未更新时,可以尝试声明 `forceRender` 强制更新组件内容

```ts
s2.showTooltip({
...,
content: <YourComponent props={"A"}/>
})

s2.showTooltip({
...,
content: <YourComponent props={"B"} />
options: {
forceRender: true
}
})
```

相关 issue: <https://github.com/antvis/S2/issues/1716>

### 使用 React 组件,Tooltip 莫名其妙被隐藏,不展示了?

```tsx
<SheetComponent options={options} dataCfg={dataCfg}/>
```

- `场景 1`: 当组件重新渲染,或者配置项更新后,组件会 [更新 S2 底表的配置](https://github.com/antvis/S2/blob/master/packages/s2-react/src/hooks/useSpreadSheet.ts#L111), 会触发 [隐藏 Tooltip 的逻辑](https://github.com/antvis/S2/blob/master/packages/s2-core/src/sheet-type/spread-sheet.ts#L381), 请检查并尽量避免你的`上层组件更新`, 或者`配置项的引用被改变` 所导致的 `SheetComponent` 无意义的重渲染。

- `场景 2`: S2 默认点击非表格区域,会隐藏 tooltip, 还原交互状态,请确保你自己的业务逻辑有无相应的 `click` 事件,看是否有被冒泡影响,尝试阻止冒泡

```ts
event.stopPropagation()
```

- `场景 3`: 手动调用 `s2.showTooltip` 展示 tooltip 后,点击内部的某个元素后,再次展示第二个 tooltip, 这个时候 tooltip 被隐藏,和场景 2 类似,请给 `click` 事件增加冒泡处理。

```ts
// 菜单 1-1 => click

s2.showTooltip({ ... })

// 菜单 1-1 => click
event.stopPropagation()
s2.showTooltip({ ... })
```

### 如何在 Vue 中自定义 Tooltip?

可直接使用 S2 的 Vue3 版本 `@antv/s2-vue`, 或查看 [在 Vue3 中自定义](/docs/manual/basic/tooltip/#在-vue3-中自定义)
Expand Down Expand Up @@ -184,27 +244,6 @@ s2.setTheme({
})
```

### React 组件,自定义显示 tooltip 后,内容未更新怎么回事?

当手动调用实例方法 `s2.showTooltip` 时,如果内容是一个 React 自定义组件,且组件内容未更新时,可以尝试声明 `forceRender` 强制更新组件内容

```ts
s2.showTooltip({
...,
content: <YourComponent props={"A"}/>
})

s2.showTooltip({
...,
content: <YourComponent props={"B"} />
options: {
forceRender: true
}
})
```

相关 issue: <https://github.com/antvis/S2/issues/1716>

### S2 支持对表格进行编辑吗?

请查看 [编辑模式示例](/examples/case/data-preview#excel)[编辑表示例](https://s2.antv.antgroup.com/examples/react-component/sheet/#editable)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import ReactDOM from 'react-dom';
import { SheetComponent } from '@antv/s2-react';
import '@antv/s2-react/dist/style.min.css';

const CustomColCellTooltip = () => <div>col cell</div>;

fetch(
'https://gw.alipayobjects.com/os/bmw-prod/2a5dbbc8-d0a7-4d02-b7c9-34f6ca63cff6.json',
)
Expand All @@ -13,30 +15,51 @@ fetch(
height: 480,
tooltip: {
showTooltip: true,
row: {
showTooltip: false,
},
},
};

const CustomTooltip = () => <div>demo</div>;

const onColCellClick = (value) => {
if (!value?.viewMeta) {
const onColCellClick = ({ viewMeta, event }) => {
if (!viewMeta) {
return;
}
const { spreadsheet, id } = value.viewMeta;
const { spreadsheet, id } = viewMeta;

// 点击列头的 [家具] 试试
if (id === 'root[&]家具') {
const position = {
x: value.event.clientX,
y: value.event.clientY,
x: event.clientX,
y: event.clientY,
};

// 查看更多配置项: https://s2.antv.antgroup.com/api/basic-class/base-tooltip#tooltipshowoptions
spreadsheet.showTooltip({
position,
content: <CustomTooltip />,
content: <CustomColCellTooltip />,
options: {
operator: {
menus: [
{
key: 'custom-a',
text: '操作1',
icon: 'Trend',
onClick: (cell) => {
console.log('操作1点击', cell);
},
children: [
{
key: 'custom-a-a',
text: '操作 1-1',
icon: 'Trend',
onClick: (cell) => {
console.log('操作 1-1 点击', cell);
},
},
],
},
],
},
},
});
} else {
spreadsheet.hideTooltip();
}
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,38 @@ fetch(
const CustomDataCellTooltip = () => <div>data cell tooltip</div>;

const onColCellHover = ({ event, viewMeta }) => {
// 查看更多配置项: https://s2.antv.antgroup.com/api/basic-class/base-tooltip#tooltipshowoptions
viewMeta.spreadsheet.tooltip.show({
position: {
x: event.clientX,
y: event.clientY,
},
content: <CustomColCellTooltip />,
// 自定义操作项
options: {
operator: {
menus: [
{
key: 'custom-a',
text: '操作1',
icon: 'Trend',
onClick: (cell) => {
console.log('操作1点击', cell);
},
children: [
{
key: 'custom-a-a',
text: '操作 1-1',
icon: 'Trend',
onClick: (cell) => {
console.log('操作 1-1 点击', cell);
},
},
],
},
],
},
},
});
};

Expand Down

1 comment on commit 32a5096

@vercel
Copy link

@vercel vercel bot commented on 32a5096 Jul 14, 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-git-master-antv-s2.vercel.app
antvis-s2.vercel.app
antvis-s2-antv-s2.vercel.app

Please sign in to comment.