useScreenOrientation
响应式 屏幕方向 API。它为 Web 开发人员提供了关于用户当前屏幕方向的信息。
Demo
用法
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"
。
类型声明
显示类型声明
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
贡献者
Anthony Fu
丶远方
Michael J. Roberts
Anthony Fu
Satrong
JunaYa
Jelf
Nicolas Hedger