@antd-tiny-vue/cssinjs
Component level cssinjs solution used in antd-tiny-vue. 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:
- stylis
- @emotion/hash
- @emotion/unitless
Install
Development
npm install
npm dev
License
@antd-tiny-vue/cssinjs is released under the MIT license.
API
StyleProvider
| 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[] | - |
createCache
return CacheEntity for StyleProvider.
createTheme
Create theme object. When same algorithm provided, it will return same object.
Design Token related API
Since @antd-tiny-vue/cssinjs use strong constraints for cache hit performance, we recommend to view demo basic.tsx for usage and animation.tsx for animation usage.
Transform
When you need transform CSSObject before inject style. You can use transformers to handle this:
<script lang="ts" setup>
import {legacyLogicalPropertiesTransformer, StyleProvider} from '@antd-tiny-vue/cssinjs';
</script>
<template>
<StyleProvider :transformers="[legacyLogicalPropertiesTransformer]">
<MyApp />
</StyleProvider>
</template>
Follow are the transform we provide:
legacyLogicalPropertiesTransformer
Convert logical properties to legacy properties. e.g. marginBlockStart to marginTop:
- inset
- margin
- padding
- border
px2remTransformer
Convert pixel units to rem units. px2remTransformer.options