useScreenSafeArea

Category

Browser

Export Size

1.5 kB

Last Changed

2 years ago

Reactive env(safe-area-inset-*)

Demo

source

top:

right:

bottom:

left:

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:

<meta name="viewport" content="initial-scale=1, viewport-fit=cover" />

Then we could use useScreenSafeArea in the component as shown below:

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

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

<template>
  <UseScreenSafeArea top right bottom left>
    content
  </UseScreenSafeArea>
</template>

Type Declarations

/**
 * Reactive `env(safe-area-inset-*)`
 *
 * @see https://vueuse.org/useScreenSafeArea
 */
export declare function useScreenSafeArea(): {
  top: Ref<string>
  right: Ref<string>
  bottom: Ref<string>
  left: Ref<string>
  update: () => void
}

Source

Source • Demo • Docs

Contributors

Anthony Fu

vaakian X

Ayaka Rizumu

Jelf

Changelog

v9.11.0 on 1/17/2023

d5321 - fix(components): mark defineComponent as pure (#2623)