🧞‍♂️
Style Genie
  • Introduction
  • Utilities
    • Breakpoint
    • Color
    • Spacing
    • Transform
    • Transition
  • Integration
    • Overview
    • Styled-Components
    • React-JSS
Powered by GitBook
On this page
  • Usage
  • Parameters
  • Default options
  • Custom breakpoints

Was this helpful?

  1. Utilities

Breakpoint

Media query strings generated based on customizable values.

Default values are the most commonly used breakpoints, but they can be configured as you like.

Usage

import { generateBreakpoint } from 'style-genie'

const breakpoint = generateBreakpoint()

breakpoint.up.md
// '@media (min-width: 960px)'
breakpoint.down.md
// '@media (max-width: 959.95px)'
breakpoint.only.md
// '@media (min-width: 960px) and (max-width: 1279.95px)'
breakpoint.between('md', 'xl')
// '@media (min-width: 960px) and (max-width: 1919.95px)'

Parameters

The generateBreakpoint function accepts only one options parameter, which can have the following properties.

property

type

description

breakpoints

{ [key: string]: number }

custom breakpoint values

Default options

{
  breakpoints: {
    xs: 0,
    sm: 600,
    md: 960,
    lg: 1280,
    xl: 1920,
  },
}

Custom breakpoints

You can pass in custom breakpoints to the generateBreakpoint function. It is recommended to have one breakpoint for 0 and no repeating number.

const breakpoint = generateBreakpoint({
  breakpoints: {
    zero: 0,
    phone: 420,
    tablet: 780,
    desktop: 1440,
  },
})
PreviousIntroductionNextColor

Last updated 5 years ago

Was this helpful?