Title

Global

Members

number

# constant MEDIUM_UPPER_BOUND

Width (in pixels) that represents the upper boundary (exclusive) of the medium value

Until doc auto renders, value is set to 1000

View Source tools/hooks/useWidthCheck.ts, line 23

number

# constant NARROW_UPPER_BOUND

Width (in pixels) that represents the upper boundary (exclusive) of the narrow value.

Until doc auto renders, value is set to 575

View Source tools/hooks/useWidthCheck.ts, line 13

Type Definitions

object

# EnvironmentCheckReturn

Properties:
Name Type Description
prod boolean

Whether we are currently in Production mode

dev boolean

Whether we are currently in Development mode

View Source tools/hooks/useEnvironmentCheck.ts, line 40

object

# ScopeCheckReturn

Properties:
Name Type Description
allScope boolean

Whether the logged in user has ALL of the provided scopes

anyScope boolean

Whether the logged in user has ONE OR MORE of the provided scopes

loggedIn boolean

Whether there is a user currently logged in (if no user is present, all return values are false)

View Source tools/hooks/useScopeCheck.ts, line 93

object

# WidthCheckReturn

Properties:
Name Type Description
wide boolean

Whether the screen width is below NARROW_UPPER_BOUND (exclusive)

medium boolean

Whether the screen width is above NARROW_UPPER_BOUND (inclusive) and below MEDIUM_UPPER_BOUND (exclusive)

narrow boolean

Whether the screen width is above MEDIUM_UPPER_BOUND (inclusive)

View Source tools/hooks/useWidthCheck.ts, line 85