Skip to content

Interface

The breakpoints interface.

Properties

PropertyTypeNotes
keysBreakpoint[]

The keys of the breakpoints.

unitstring

The unit used for the breakpoint's values.

values{ md?: number; sm?: number }

Each breakpoint (a key) matches with a fixed screen width (a value). The breakpoint start at this value. For instance with the first breakpoint xs: [sm, md).

keys

Interface Property

unit

optional
Interface Property

values

Interface Property

Methods

MethodReturns
between(start, end)string
down(key)string
not(key)string
only(key)string
up(key)string

between

Interface Method
between(startnumber | Breakpoint, endnumber | Breakpoint): string
Parameters
ParameterTypeNotes
startnumber | Breakpoint

A breakpoint key ( sm , md , etc.) or a screen width number in px.

endnumber | Breakpoint

A breakpoint key ( sm , md , etc.) or a screen width number in px.

Returns 
string

down

Interface Method
down(keynumber | Breakpoint): string
Parameters
ParameterTypeNotes
keynumber | Breakpoint

A breakpoint key ( sm , md , etc.) or a screen width number in px.

Returns 
string

not

Interface Method
not(keyBreakpoint): string
Parameters
ParameterTypeNotes
keyBreakpoint

A breakpoint key ( sm , md , etc.).

Returns 
string

only

Interface Method
only(keyBreakpoint): string
Parameters
ParameterTypeNotes
keyBreakpoint

A breakpoint key ( sm , md , etc.) or a screen width number in px.

Returns 
string

up

Interface Method
up(keynumber | Breakpoint): string
Parameters
ParameterTypeNotes
keynumber | Breakpoint

A breakpoint key ( sm , md , etc.) or a screen width number in px.

Returns 
string

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.