4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
---
|
|
category: Browser
|
|
---
|
|
|
|
# useScreenSafeArea
|
|
|
|
Reactive `env(safe-area-inset-*)`
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
In order to make the page to be fully rendered in the screen, the additional attribute `viewport-fit=cover` within `viewport` meta tag must be set firstly, the viewport meta tag may look like this:
|
|
|
|
```html
|
|
<meta name="viewport" content="initial-scale=1, viewport-fit=cover" />
|
|
```
|
|
|
|
Then we could use `useScreenSafeArea` in the component as shown below:
|
|
|
|
```ts
|
|
import { useScreenSafeArea } from '@vueuse/core'
|
|
|
|
const {
|
|
top,
|
|
right,
|
|
bottom,
|
|
left,
|
|
} = useScreenSafeArea()
|
|
```
|
|
|
|
For further details, you may refer to this documentation: [Designing Websites for iPhone X](https://webkit.org/blog/7929/designing-websites-for-iphone-x/)
|
|
|
|
## Component Usage
|
|
|
|
```vue
|
|
<template>
|
|
<UseScreenSafeArea top right bottom left>
|
|
content
|
|
</UseScreenSafeArea>
|
|
</template>
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export interface UseScreenSafeAreaReturn {
|
|
top: ShallowRef<string>
|
|
right: ShallowRef<string>
|
|
bottom: ShallowRef<string>
|
|
left: ShallowRef<string>
|
|
update: () => void
|
|
}
|
|
/**
|
|
* Reactive `env(safe-area-inset-*)`
|
|
*
|
|
* @see https://vueuse.org/useScreenSafeArea
|
|
*/
|
|
export declare function useScreenSafeArea(): UseScreenSafeAreaReturn
|
|
```
|