Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@chakra-ui/system
Advanced tools
Readme
Styled API for creating atomic, theme-aware component styling.
yarn add @chakra-ui/system
# or
npm i @chakra-ui/system
In modern web development, we have lots of solutions and architectures that have tried to unify how components are styled. We've seen CSS architectures like BEM, SMACSS, etc, and frameworks like theme-ui, and Tailwind CSS.
While these solutions work great, we still think there is a sheer amount of work required to create a fully customizable, theme-aware component.
Chakra provides enhanced JSX elements that can be styled directly via props, or
can accept the common sx
prop for custom styles.
We'll provide a chakra function, just like styled-components. Users can create
any component using the chakra.[element]
. The resulting component will be a
styled component and have all system props.
<chakra.button bg="green.200" _hover={{ bg: "green.300" }}>
Click me
</chakra.button>
<chakra.h1 fontSize="lg"> Heading </chakra.h1>
// create your own box
const Box = chakra.div
// you can still use the `as` prop
<Box as="h1">This is my box</Box>
// for custom components
const ChakraPowered = chakra(YourComponent)
// TS: chakra will infer the types of Link and
// make it available in props
<chakra.a as={Link} to="/home"> Click me</chakra.a>
A way to define themeable components in chakra. We believe most re-usable, atomic components have the following modifiers:
Our goal with this component API is to design a common interface to style any component given these characteristics. Here's how it works:
// 1. create a component schema in your theme
const theme = {
colors: {
green: {
light: "#dfdfdf",
normal: "#dfdfdf",
dark: "#d566Df",
darker: "#dfd56f"
},
blue: {}
},
components: {
Button: {
defaultProps: {
variant: "solid",
size: "md",
colorScheme: "blue"
},
variants: {
// props has colorScheme, colorMode (light mode or dark mode)
solid: props => ({
bg: `${props.colorScheme}.normal`,
color: "white",
}),
outline: {
border: "2px",
borderColor: "green.normal"
}
},
sizes: {
sm: {
padding: 20,
fontSize: 12
},
md: {
padding: 40,
fontSize: 15
}
}
}
}
};
// 2. create or import Button from chakra-ui
import { Button } from "@chakra-ui/react"
// or your own button
const Button = chakra("button", { themeKey: "Button" })
// 3. use the button. It'll have the visual props defined in defaultProps
<Button>Click me</Button>
// 4. override the defaultProps
<Button variant="outline" colorScheme="green">Click me</Button>
FAQs
Chakra UI system primitives
The npm package @chakra-ui/system receives a total of 497,143 weekly downloads. As such, @chakra-ui/system popularity was classified as popular.
We found that @chakra-ui/system demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
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.