@ant-design/cssinjs
Advanced tools
Package description
@ant-design/cssinjs is a library that allows you to write CSS-in-JS for Ant Design components. It provides a way to style your components using JavaScript, which can help in maintaining styles in a modular and reusable manner.
Define Styles
This feature allows you to define styles using JavaScript objects. The `createUseStyle` function takes a callback that returns an object with your styles. The `token` parameter can be used to access theme variables.
const useStyle = createUseStyle(({ token }) => ({
button: {
backgroundColor: token.colorPrimary,
color: token.colorText,
padding: '10px 20px',
border: 'none',
borderRadius: '4px',
cursor: 'pointer'
}
}));Apply Styles
This feature allows you to apply the defined styles to your components. The `useStyle` hook returns an object with the generated class names, which you can then apply to your JSX elements.
const MyButton = () => {
const { styles } = useStyle();
return <button className={styles.button}>Click Me</button>;
};Theming
This feature allows you to use theming in your application. You can define a theme object and use the `ThemeProvider` component to pass the theme to your styled components.
const theme = {
colorPrimary: '#1890ff',
colorText: '#ffffff'
};
const App = () => (
<ThemeProvider theme={theme}>
<MyButton />
</ThemeProvider>
);styled-components is a popular library for writing CSS-in-JS. It allows you to create styled components with tagged template literals. Compared to @ant-design/cssinjs, styled-components is more general-purpose and not specifically tied to Ant Design.
Emotion is another library for writing CSS-in-JS. It offers both a styled API similar to styled-components and a css function for creating class names. Emotion is known for its performance and flexibility, making it a strong alternative to @ant-design/cssinjs.
JSS is a library for writing CSS-in-JS with a focus on high performance and modularity. It provides a powerful API for defining styles and theming. JSS is more low-level compared to @ant-design/cssinjs, offering more control but requiring more setup.
Readme
Component level cssinjs solution used in ant.design. It's a subset of Emotion with design token logic wrapper. Please feel free to use emotion directly if you want to find a web cssinjs solution. cssinjs related dep packages:
https://ant-design.github.io/cssinjs/
npm install @ant-design/cssinjs
or
yarn add @ant-design/cssinjs
pnpm add @ant-design/cssinjs
npm install
npm start
@ant-design/cssinjs is released under the MIT license.
| Prop | Desc | Type | Default |
|---|---|---|---|
| autoClear | Clear inject style element when component remove. | boolean | false |
| cache | Config cssinjs cache entity. Only set when you need ssr to extract style on you own. | CacheEntity | - |
| hashPriority | Use :where selector to reduce hashId css selector priority | 'low' | 'high' | 'low' |
| container | Tell cssinjs where to inject style in. | Element | ShadowRoot | document.head |
| ssrInline | Component wil render inline <style /> for fallback in SSR. Not recommend. | boolean | false |
| transformers | Transform css before inject in document. Please note that transformers do not support dynamic update | Transformer[] | - |
return CacheEntity for StyleProvider.
Create theme object. When same algorithm provided, it will return same object.
Since @ant-design/cssinjs use strong constraints for cache hit performance, we recommend to view demo basic.tsx for usage and animation.tsx for animation usage.
When you need transform CSSObject before inject style. You can use transformers to handle this:
import {
legacyLogicalPropertiesTransformer,
StyleProvider,
} from '@ant-design/cssinjs';
export default () => (
<StyleProvider transformers={[legacyLogicalPropertiesTransformer]}>
<MyApp />
</StyleProvider>
);
Follow are the transform we provide:
Convert logical properties to legacy properties. e.g. marginBlockStart to marginTop:
Convert pixel units to rem units. px2remTransformer.options
FAQs
Unknown package
The npm package @ant-design/cssinjs receives a total of 598,755 weekly downloads. As such, @ant-design/cssinjs popularity was classified as popular.
We found that @ant-design/cssinjs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 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.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.