useBreakpoints API
Reactive viewport detection for building responsive layouts with named breakpoints.
Related
Explore these related pages for additional context and usage patterns.
| Page | Category |
|---|---|
| useBreakpoints | Plugins |
| useMediaQuery | System |
| Plugins | Fundamentals |
Functions
createBreakpoints
(_options?: BreakpointsOptions) => BreakpointsContextCreates a new breakpoints instance.
createBreakpointsContext
<_E>(_options?: BreakpointsContextOptions | undefined) => ContextTrinity<_E>createBreakpointsPlugin
(_options?: BreakpointsContextOptions | undefined) => PluginuseBreakpoints
<_E>(namespace?: string) => _EOptions
namespace
string | undefinedmobileBreakpoint
number | BreakpointName | undefinedbreakpoints
Partial<Record<BreakpointName, number>> | undefinedssr
{ clientWidth: number; clientHeight?: number; } | undefinedProperties
breakpoints
Readonly<Record<BreakpointName, number>>mobileBreakpoint
number | BreakpointNamename
Readonly<ShallowRef<BreakpointName>>width
Readonly<ShallowRef<number>>height
Readonly<ShallowRef<number>>isMobile
Readonly<ShallowRef<boolean>>xs
Readonly<ShallowRef<boolean>>sm
Readonly<ShallowRef<boolean>>md
Readonly<ShallowRef<boolean>>lg
Readonly<ShallowRef<boolean>>xl
Readonly<ShallowRef<boolean>>xxl
Readonly<ShallowRef<boolean>>smAndUp
Readonly<ShallowRef<boolean>>mdAndUp
Readonly<ShallowRef<boolean>>lgAndUp
Readonly<ShallowRef<boolean>>xlAndUp
Readonly<ShallowRef<boolean>>smAndDown
Readonly<ShallowRef<boolean>>mdAndDown
Readonly<ShallowRef<boolean>>lgAndDown
Readonly<ShallowRef<boolean>>xlAndDown
Readonly<ShallowRef<boolean>>ssr
booleanMethods
update
() => void