BlogPlaygroundOne

useDisplay API


Exposed
Readonly<Ref<{ [x: string]: boolean }, { [x: string]: boolean }>>
Ref<number, number>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
ComputedRef<boolean>
Ref<number | DisplayBreakpoint, number | DisplayBreakpoint>
Ref<DisplayBreakpoint, DisplayBreakpoint>
Ref<DisplayPlatform, DisplayPlatform>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
boolean
Ref<DisplayThresholds, DisplayThresholds>
() => void
Ref<number, number>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>
Ref<boolean, boolean>

Returns an object containing the breakpoints and their corresponding classes.

The inner height of the browser window.

Returns true if the current browser breakpoint is lg.

Returns true if the current browser breakpoint is lg or lower.

Returns true if the current browser breakpoint is lg or higher.

Returns true if the current browser breakpoint is md.

Returns true if the current browser breakpoint is md or lower.

Returns true if the current browser breakpoint is md or higher.

Returns true if the current browser breakpoint is considered to be a mobile breakpoint.

Controls which named breakpoint (lg, md, etc) or browser width (in px) is considered to be mobile.

Name of the current breakpoint.

Name of the current platform.

Returns true if the current browser breakpoint is sm.

Returns true if the current browser breakpoint is sm or lower.

Returns true if the current browser breakpoint is sm or higher.

Returns true if the current page was server rendered.

An object describing the width values of each breakpoint.

Function that updates the current width and height values.

The inner width of the browser window.

Returns true if the current browser breakpoint is xl.

Returns true if the current browser breakpoint is xl or lower.

Returns true if the current browser breakpoint is xl or higher.

Returns true if the current browser breakpoint is xs.

Returns true if the current browser breakpoint is xxl.