Skip to content

docs(useFullscreen): fix type of zIndex options #2143

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

Merged
merged 1 commit into from
Apr 7, 2023
Merged

docs(useFullscreen): fix type of zIndex options #2143

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
10 changes: 5 additions & 5 deletions packages/hooks/src/useFullscreen/index.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ const [isFullscreen, {

### Options

| Property | Description | Type | Default |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ------- |
| onExit | Exit full screen trigger | `() => void` | - |
| onEnter | Enter full screen trigger | `() => void` | - |
| pageFullscreen | Whether to enable full screen of page. If its type is object, it can set `className` and `z-index` of the full screen element | `boolean` \| `{ className?: string, zIndex: number }` | `false` |
| Property | Description | Type | Default |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------- |
| onExit | Exit full screen trigger | `() => void` | - |
| onEnter | Enter full screen trigger | `() => void` | - |
| pageFullscreen | Whether to enable full screen of page. If its type is object, it can set `className` and `z-index` of the full screen element | `boolean` \| `{ className?: string, zIndex?: number }` | `false` |

### Result

Expand Down
10 changes: 5 additions & 5 deletions packages/hooks/src/useFullscreen/index.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ const [isFullscreen, {

### Options

| 参数 | 说明 | 类型 | 默认值 |
| -------------- | ---------------------------------------------------------------------- | ----------------------------------------------------- | ------- |
| onExit | 退出全屏触发 | `() => void` | - |
| onEnter | 全屏触发 | `() => void` | - |
| pageFullscreen | 是否是页面全屏。当参数类型为对象时，可以设置全屏元素的类名和 `z-index` | `boolean` \| `{ className?: string, zIndex: number }` | `false` |
| 参数 | 说明 | 类型 | 默认值 |
| -------------- | ---------------------------------------------------------------------- | ------------------------------------------------------ | ------- |
| onExit | 退出全屏触发 | `() => void` | - |
| onEnter | 全屏触发 | `() => void` | - |
| pageFullscreen | 是否是页面全屏。当参数类型为对象时，可以设置全屏元素的类名和 `z-index` | `boolean` \| `{ className?: string, zIndex?: number }` | `false` |

### Result

Expand Down