Skip to content

useScreenOrientation

Category
Export Size
704 B
Last Changed
15 minutes ago

响应式 屏幕方向 API。它为 Web 开发人员提供了关于用户当前屏幕方向的信息。

Demo

为了获得最佳效果,请使用手机或平板设备(或使用浏览器的原生检查器来模拟屏幕方向变化)
是否支持: false
Orientation 类型:
Orientation 角度: 0

用法

ts
import { useScreenOrientation } from '@vueuse/core'

const {
  isSupported,
  orientation,
  angle,
  lockOrientation,
  unlockOrientation,
} = useScreenOrientation()

要锁定方向,您可以将 OrientationLockType 传递给 lockOrientation 函数:

ts
import { useScreenOrientation } from '@vueuse/core'

const {
  isSupported,
  orientation,
  angle,
  lockOrientation,
  unlockOrientation,
} = useScreenOrientation()

lockOrientation('portrait-primary')

然后再次解锁,使用以下方式:

ts
unlockOrientation()

可接受的方向类型包括 "landscape-primary""landscape-secondary""portrait-primary""portrait-secondary""any""landscape""natural""portrait"

Screen Orientation API MDN

类型声明

显示类型声明
typescript
export type OrientationType =
  | "portrait-primary"
  | "portrait-secondary"
  | "landscape-primary"
  | "landscape-secondary"
export type OrientationLockType =
  | "any"
  | "natural"
  | "landscape"
  | "portrait"
  | "portrait-primary"
  | "portrait-secondary"
  | "landscape-primary"
  | "landscape-secondary"
export interface ScreenOrientation extends EventTarget {
  lock: (orientation: OrientationLockType) => Promise<void>
  unlock: () => void
  readonly type: OrientationType
  readonly angle: number
  addEventListener: (
    type: "change",
    listener: (this: this, ev: Event) => any,
    useCapture?: boolean,
  ) => void
}
/**
 * 响应式屏幕方向
 *
 * @see https://vueuse.org/useScreenOrientation
 */
export declare function useScreenOrientation(options?: ConfigurableWindow): {
  isSupported: ComputedRef<boolean>
  orientation: Ref<OrientationType | undefined, OrientationType | undefined>
  angle: Ref<number, number>
  lockOrientation: (type: OrientationLockType) => Promise<void>
  unlockOrientation: () => void
}
export type UseScreenOrientationReturn = ReturnType<typeof useScreenOrientation>

Source

SourceDemoDocs

贡献者

Anthony Fu
丶远方
Michael J. Roberts
Anthony Fu
Satrong
JunaYa
Jelf
Nicolas Hedger

变更日志

v10.8.0 on 2/20/2024
a086e - fix: stricter types
v10.7.0 on 12/5/2023
be3cc - fix: Add fault tolerance to lock and unlock (#3575)

Released under the MIT License.