useBreakpoints
| Category | Browser |
|---|---|
| Export Size | 915 B |
| Last Changed | 2 weeks ago |
Reactive viewport breakpoints.
Usage
import { breakpointsTailwind, useBreakpoints } from '@vueuse/core'
const breakpoints = useBreakpoints(breakpointsTailwind)
const smAndLarger = breakpoints.greaterOrEqual('sm') // sm and larger
const largerThanSm = breakpoints.greater('sm') // only larger than sm
const lgAndSmaller = breakpoints.smallerOrEqual('lg') // lg and smaller
const smallerThanLg = breakpoints.smaller('lg') // only smaller than lgimport { useBreakpoints } from '@vueuse/core'
const breakpoints = useBreakpoints({
tablet: 640,
laptop: 1024,
desktop: 1280,
})
const laptop = breakpoints.between('laptop', 'desktop')Type Declarations
export * from "./breakpoints"
export type Breakpoints<K extends string = string> = Record<K, number | string>
/**
* Reactively viewport breakpoints
*
* @see https://vueuse.org/useBreakpoints
* @param options
*/
export declare function useBreakpoints<K extends string>(
breakpoints: Breakpoints<K>,
options?: ConfigurableWindow
): Record<K, Ref<boolean>> & {
greater(k: K): Ref<boolean>
greaterOrEqual: (k: K) => Ref<boolean>
smaller(k: K): Ref<boolean>
smallerOrEqual(k: K): Ref<boolean>
between(a: K, b: K): Ref<boolean>
isGreater(k: K): boolean
isGreaterOrEqual(k: K): boolean
isSmaller(k: K): boolean
isSmallerOrEqual(k: K): boolean
isInBetween(a: K, b: K): boolean
current(): ComputedRef<string[]>
}
export type UseBreakpointsReturn<K extends string = string> = {
greater: (k: K) => ComputedRef<boolean>
greaterOrEqual: (k: K) => ComputedRef<boolean>
smaller(k: K): ComputedRef<boolean>
smallerOrEqual: (k: K) => ComputedRef<boolean>
between(a: K, b: K): ComputedRef<boolean>
isGreater(k: K): boolean
isGreaterOrEqual(k: K): boolean
isSmaller(k: K): boolean
isSmallerOrEqual(k: K): boolean
isInBetween(a: K, b: K): boolean
current(): ComputedRef<string[]>
} & Record<K, ComputedRef<boolean>>Source
© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/core/useBreakpoints/