Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Popup): update popperOptions usage #3200

Merged
merged 3 commits into from
Nov 15, 2024
Merged

docs(Popup): update popperOptions usage #3200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ab4bb1
docs(popup): update popperOptions usage
HaixingOoO Nov 13, 2024
f90f6ac
ci(popup): update test snap
HaixingOoO Nov 13, 2024
7c835da
docs(popup): update docs
HaixingOoO Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions src/popup/_example/popper-options.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import React, { useState } from 'react';
import { Button, Input, Popup, Space } from 'tdesign-react';

export default function PopperOptions() {
const [offsetX, setOffsetX] = useState('0');
const [offsetY, setOffsetY] = useState('0');

return (
<Space direction="vertical">
<Space>
<Space align="center">
<span>请输入横向偏移量:</span>
<Input
placeholder="请输入横向偏移量"
value={offsetX}
onChange={(v) => setOffsetX(v)}
style={{ width: '130px', display: 'inline-block' }}
/>
</Space>
<Space align="center">
<span>请输入纵向偏移量:</span>
<Input
placeholder="请输入纵向偏移量"
value={offsetY}
onChange={(v) => setOffsetY(v)}
style={{ width: '130px', display: 'inline-block' }}
/>
</Space>
</Space>
<Space>
<Popup
trigger="hover"
showArrow
content="这是一个弹出框"
popperOptions={{
modifiers: [
{
name: 'offset',
options: {
offset: [Number(offsetX), Number(offsetY)],
},
},
],
}}
>
<Button>Hover me</Button>
</Popup>
</Space>
</Space>
);
}
14 changes: 14 additions & 0 deletions src/popup/popup.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ Support functional calls `PopupPlugin` 。

{{ plugin }}

### Dynamic Adaptation

When the trigger or popup display content changes dynamically, the position is adjusted adaptively

{{ dynamic }}

### popperOptions usage

https://popper.js.org/docs/v2/constructors/#types

- `popperOptions` = `Options`

{{ popper-options }}

## FAQ

### How to solve the problem of position offset when nesting `Popup` components?
Expand Down
8 changes: 8 additions & 0 deletions src/popup/popup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@

{{ dynamic }}

### popperOptions 使用

https://popper.js.org/docs/v2/constructors/#types

- `popperOptions` = `Options`

{{ popper-options }}

## FAQ

### `Popup` 组件，嵌套使用可能出现位置偏移的情况，如何解决？
Expand Down
118 changes: 118 additions & 0 deletions test/snap/__snapshots__/csr.test.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67312,6 +67312,122 @@ exports[`csr snapshot test > csr test src/popup/_example/plugin.tsx 1`] = `
</div>
`;

exports[`csr snapshot test > csr test src/popup/_example/popper-options.tsx 1`] = `
<div>
<div
class="t-space t-space-vertical"
style="gap: 16px;"
>
<div
class="t-space-item"
>
<div
class="t-space t-space-horizontal"
style="gap: 16px;"
>
<div
class="t-space-item"
>
<div
class="t-space t-space-align-center t-space-horizontal"
style="gap: 16px;"
>
<div
class="t-space-item"
>
<span>
请输入横向偏移量:
</span>
</div>
<div
class="t-space-item"
>
<div
class="t-input__wrap"
spellcheck="false"
style="width: 130px; display: inline-block;"
value="0"
>
<div
class="t-input t-align-left"
>
<input
class="t-input__inner"
placeholder="请输入横向偏移量"
type="text"
value="0"
/>
</div>
</div>
</div>
</div>
</div>
<div
class="t-space-item"
>
<div
class="t-space t-space-align-center t-space-horizontal"
style="gap: 16px;"
>
<div
class="t-space-item"
>
<span>
请输入纵向偏移量:
</span>
</div>
<div
class="t-space-item"
>
<div
class="t-input__wrap"
spellcheck="false"
style="width: 130px; display: inline-block;"
value="0"
>
<div
class="t-input t-align-left"
>
<input
class="t-input__inner"
placeholder="请输入纵向偏移量"
type="text"
value="0"
/>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div
class="t-space-item"
>
<div
class="t-space t-space-horizontal"
style="gap: 16px;"
>
<div
class="t-space-item"
>
<button
class="t-button t-button--theme-primary t-button--variant-base"
type="button"
>
<span
class="t-button__text"
>
Hover me
</span>
</button>
</div>
</div>
</div>
</div>
</div>
`;

exports[`csr snapshot test > csr test src/popup/_example/style.tsx 1`] = `
<div>
<div
Expand Down Expand Up @@ -135031,6 +135147,8 @@ exports[`ssr snapshot test > ssr test src/popup/_example/placement.tsx 1`] = `"<

exports[`ssr snapshot test > ssr test src/popup/_example/plugin.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-vertical"><div class="t-space-item"><button type="button" class="trigger-element1 t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">正常的方式打开</span></button></div><div class="t-space-item"><button type="button" class="trigger-element2 t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">通过Plugin打开，并修改不同浮层的配置</span></button></div><div class="t-space-item"><div><span>这里是一个日志查询的例子，在很长的日志内容中，日志内容存在换行的情况，可以点击链接进行日志查询操作</span><a class="trigger-element3" style="color:var(--td-text-color-brand)">点击此链接，会打开浮层进行跳转操作</a></div></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/popper-options.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-vertical"><div class="t-space-item"><div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><div style="gap:16px" class="t-space t-space-align-center t-space-horizontal"><div class="t-space-item"><span>请输入横向偏移量:</span></div><div class="t-space-item"><div style="width:130px;display:inline-block" class="t-input__wrap" value="0" spellcheck="false"><div class="t-input t-align-left"><input placeholder="请输入横向偏移量" type="text" class="t-input__inner" value="0"/></div></div></div></div></div><div class="t-space-item"><div style="gap:16px" class="t-space t-space-align-center t-space-horizontal"><div class="t-space-item"><span>请输入纵向偏移量:</span></div><div class="t-space-item"><div style="width:130px;display:inline-block" class="t-input__wrap" value="0" spellcheck="false"><div class="t-input t-align-left"><input placeholder="请输入纵向偏移量" type="text" class="t-input__inner" value="0"/></div></div></div></div></div></div></div><div class="t-space-item"><div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-primary t-button--variant-base"><span class="t-button__text">Hover me</span></button></div></div></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/style.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">自定义浮层类名</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">固定浮层宽度</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">浮层最大宽度</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">浮层和触发元素同宽</span></button></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/trigger.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">悬浮时触发（默认）</span></button></div><div class="t-space-item"><div style="width:200px" class="t-input__wrap" spellcheck="false"><div class="t-input t-align-left"><input placeholder="获得焦点时触发" type="text" class="t-input__inner" value=""/></div></div></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">点击时触发</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">右击时触发</span></button></div></div>"`;
Expand Down
2 changes: 2 additions & 0 deletions test/snap/__snapshots__/ssr.test.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,8 @@ exports[`ssr snapshot test > ssr test src/popup/_example/placement.tsx 1`] = `"<

exports[`ssr snapshot test > ssr test src/popup/_example/plugin.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-vertical"><div class="t-space-item"><button type="button" class="trigger-element1 t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">正常的方式打开</span></button></div><div class="t-space-item"><button type="button" class="trigger-element2 t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">通过Plugin打开，并修改不同浮层的配置</span></button></div><div class="t-space-item"><div><span>这里是一个日志查询的例子，在很长的日志内容中，日志内容存在换行的情况，可以点击链接进行日志查询操作</span><a class="trigger-element3" style="color:var(--td-text-color-brand)">点击此链接，会打开浮层进行跳转操作</a></div></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/popper-options.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-vertical"><div class="t-space-item"><div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><div style="gap:16px" class="t-space t-space-align-center t-space-horizontal"><div class="t-space-item"><span>请输入横向偏移量:</span></div><div class="t-space-item"><div style="width:130px;display:inline-block" class="t-input__wrap" value="0" spellcheck="false"><div class="t-input t-align-left"><input placeholder="请输入横向偏移量" type="text" class="t-input__inner" value="0"/></div></div></div></div></div><div class="t-space-item"><div style="gap:16px" class="t-space t-space-align-center t-space-horizontal"><div class="t-space-item"><span>请输入纵向偏移量:</span></div><div class="t-space-item"><div style="width:130px;display:inline-block" class="t-input__wrap" value="0" spellcheck="false"><div class="t-input t-align-left"><input placeholder="请输入纵向偏移量" type="text" class="t-input__inner" value="0"/></div></div></div></div></div></div></div><div class="t-space-item"><div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-primary t-button--variant-base"><span class="t-button__text">Hover me</span></button></div></div></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/style.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">自定义浮层类名</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">固定浮层宽度</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">浮层最大宽度</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">浮层和触发元素同宽</span></button></div></div>"`;

exports[`ssr snapshot test > ssr test src/popup/_example/trigger.tsx 1`] = `"<div style="gap:16px" class="t-space t-space-horizontal"><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">悬浮时触发（默认）</span></button></div><div class="t-space-item"><div style="width:200px" class="t-input__wrap" spellcheck="false"><div class="t-input t-align-left"><input placeholder="获得焦点时触发" type="text" class="t-input__inner" value=""/></div></div></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">点击时触发</span></button></div><div class="t-space-item"><button type="button" class="t-button t-button--theme-default t-button--variant-outline"><span class="t-button__text">右击时触发</span></button></div></div>"`;
Expand Down
Loading