Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
reflexbox
Advanced tools
Changelog
4.0.6 2019-09-21
Readme
📦 Ergonomic, responsive React layout and grid system. The original Box component™ since 2015
sx
propnpm i reflexbox
import React from 'react'
import { Flex, Box } from 'reflexbox'
export default props =>
<Flex flexWrap='wrap'>
<Box
width={[ 1, 1/2 ]}
p={3}>
Reflex
</Box>
<Box
width={[ 1, 1/2 ]}
p={3}>
Box
</Box>
</Flex>
sx
PropThe Box
and Flex
components both accept a sx
prop that works with no additional setup required.
The sx
prop is similar to Emotion's css
prop, but allows you to use values derived from the theme object.
Reflexbox follows the Theme Specification, which means that any theme created for use with Theme UI, Styled System, or other similar libraries will work out-of-the-box. This allows you to share design constraints for typography, color, and layout throughout your application using a theming context.
<Box
sx={{
p: 4,
color: 'primary',
}}
/>
Note: to opt-out of theme-based styles, use the css
prop instead, which will not transform values.
Because Reflexbox follows the Theme Specification, all themes built for use with Styled System, Theme UI, or other related libraries are compatible with Reflexbox.
To add a theme to an application, import the ThemeProvider
component from emotion-theming
and pass a custom theme object in.
npm i emotion-theming
import React from 'react'
import { ThemeProvider } from 'emotion-theming'
import { Flex, Box } from 'reflexbox'
const theme = {
breakpoints: [
'40em', '52em', '64em',
],
colors: {
text: '#000',
background: '#fff',
primary: '#07c',
},
space: [
0, 4, 8, 16, 32, 64, 128, 256,
],
}
export default props =>
<ThemeProvider theme={theme}>
<Box
sx={{
p: 4,
bg: 'primary',
}}>
Hello
</Box>
</ThemeProvider>
For use with Theme UI, use gatsby-plugin-theme-ui
or import the Theme UI ThemeProvider
instead.
import { ThemeProvider } from 'theme-ui'
Reflexbox components also accept a variant
prop, which allows you to define commonly used styles,
such as cards, badges, and CSS grid layouts, in your theme object for reuse.
Add a variants
object to your theme and include any variants as style objects. These styles can reference other values in your theme such as colors, typographic styles, and more.
// example theme
export default {
colors: {
text: '#000',
background: '#fff',
primary: '#07c',
},
radii: {
default: 4,
},
shadows: {
card: '0 0 4px rgba(0, 0, 0, .125)',
},
variants: {
card: {
p: 3,
borderRadius: 'default',
bg: 'white',
boxShadow: 'card',
},
badge: {
color: 'white',
bg: 'primary',
p: 1,
borderRadius: 'default',
},
},
}
To apply a variant to your component, pass the name to the variant
prop.
<Box variant='card'>Card</Box>
<Box variant='badge'>Badge</Box>
Use array values to quickly and ergonomically add mobile-first responsive styles to specific properties.
This works on all style props and the sx
prop.
See the Styled System docs for more.
// 100% width at the smallest viewport width
// 50% width at the next breakpoint
// 25% width at the next breakpoint
<Box width={[ '100%', '50%', '25%' ]} />
You can customize the widths used for each breakpoint by defining a theme.breakpoints
array in your theme.
Reflexbox conforms to the Theme Specification and includes many common Styled System props.
The Box
and Flex
components accept the following props:
Prop | Theme Key |
---|---|
margin , m | space |
marginTop , mt | space |
marginRight , mr | space |
marginBottom , mb | space |
marginLeft , ml | space |
marginX , mx | space |
marginY , my | space |
padding , p | space |
paddingTop , pt | space |
paddingRight , pr | space |
paddingBottom , pb | space |
paddingLeft , pl | space |
paddingX , px | space |
paddingY , py | space |
Prop | Theme Key |
---|---|
width | sizes |
height | sizes |
minWidth | sizes |
maxWidth | sizes |
minHeight | sizes |
maxHeight | sizes |
Prop | Theme Key |
---|---|
fontFamily | fonts |
fontSize | fontSizes |
fontWeight | fontWeights |
lineHeight | lineHeights |
letterSpacing | letterSpacings |
fontStyle | N/A |
textAlign | N/A |
Prop | Theme Key |
---|---|
color | colors |
backgroundColor , bg | colors |
opacity | N/A |
Prop | Theme Key |
---|---|
alignItems | N/A |
alignContent | N/A |
justifyItems | N/A |
justifyContent | N/A |
flexWrap | N/A |
flexDirection | N/A |
flex | N/A |
flexGrow | N/A |
flexShrink | N/A |
flexBasis | N/A |
justifySelf | N/A |
alignSelf | N/A |
order | N/A |
To use Reflexbox with Styled Components, import components from reflexbox/styled-components
.
import { Flex, Box } from 'reflexbox/styled-components'
This library is the result of consolidating APIs and ergonomics from the original Reflexbox library, Grid Styled, and Rebass Grid. Reflexbox originally appeared with the original version of Rebass in 2015.
FAQs
Responsive React grid system built with Styled System, with support for Emotion and Styled Components
The npm package reflexbox receives a total of 52,241 weekly downloads. As such, reflexbox popularity was classified as popular.
We found that reflexbox demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.