useBreakpoints API
API reference for the useBreakpoints composable.
Functions
createBreakpointsContext
(_options?: BreakpointsContextOptions) => ContextTrinity<E>Creates a new breakpoints context.
createBreakpointsPlugin
(_options?: BreakpointsPluginOptions) => anyCreates a new breakpoints plugin.
Options
namespace
stringmobileBreakpoint
number | BreakpointNamebreakpoints
Partial<Record<BreakpointName, number>>Properties
breakpoints
Readonly<Record<BreakpointName, number>>name
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>>xxlAndUp
Readonly<ShallowRef<boolean>>smAndDown
Readonly<ShallowRef<boolean>>mdAndDown
Readonly<ShallowRef<boolean>>lgAndDown
Readonly<ShallowRef<boolean>>xlAndDown
Readonly<ShallowRef<boolean>>xxlAndDown
Readonly<ShallowRef<boolean>>Methods
update
() => void