Skip to content

refactor(fullscreen): convert request and exit methods to arrow functions; update documentation for trigger options to accept arrays #7680

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

Open
yangda666 wants to merge 1 commit into
base: v5
Choose a base branch
from
+9 −9
Open

refactor(fullscreen): convert request and exit methods to arrow functions; update documentation for trigger options to accept arrays #7680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions packages/g6/src/plugins/fullscreen/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,22 +130,22 @@ export class Fullscreen extends BasePlugin<FullscreenOptions> {
*
* <en/> Request full screen
*/
public request() {
public request = () => {
if (document.fullscreenElement || !isFullscreenEnabled()) return;
this.$el.requestFullscreen().catch((err: Error) => {
print.warn(`Error attempting to enable full-screen: ${err.message} (${err.name})`);
});
}
};

/**
* <zh/> 退出全屏
*
* <en/> Exit full screen
*/
public exit() {
public exit = () => {
if (!document.fullscreenElement) return;
document.exitFullscreen();
}
};

/**
* <zh/> 更新配置
Expand Down
10 changes: 5 additions & 5 deletions packages/site/docs/manual/plugin/Fullscreen.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ const graph = new Graph({
type: 'fullscreen',
autoFit: true,
trigger: {
request: 'F', // 使用快捷键 F 进入全屏
exit: 'Esc', // 使用快捷键 Esc 退出全屏
request: ['F'], // 使用快捷键 F 进入全屏
exit: ['Esc'], // 使用快捷键 Esc 退出全屏
},
onEnter: () => {
console.log('进入全屏模式');
Expand All @@ -47,7 +47,7 @@ const graph = new Graph({
| type | 插件类型 | string | `fullscreen` | ✓ |
| key | 插件的唯一标识，可用于获取插件实例或更新插件选项 | string | - | |
| autoFit | 是否自适应画布尺寸，全屏后画布尺寸会自动适应屏幕尺寸 | boolean | true | |
| trigger | 触发全屏的方式，[示例](#trigger) | { request?: string; exit?: string; } | - | |
| trigger | 触发全屏的方式，[示例](#trigger) | { request?: string[]; exit?: string[]; } | - | |
| onEnter | 进入全屏后的回调 | () => void | - | |
| onExit | 退出全屏后的回调 | () => void | - | |

Expand All @@ -65,8 +65,8 @@ const graph = new Graph({
{
type: 'fullscreen',
trigger: {
request: 'F', // 使用快捷键 F 进入全屏
exit: 'Esc', // 使用快捷键 Esc 退出全屏
request: ['F'], // 使用快捷键 F 进入全屏
exit: ['Esc'], // 使用快捷键 Esc 退出全屏
},
},
],
Expand Down