f4870cd530 | ||
---|---|---|
.. | ||
dist | ||
src | ||
types | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
package.json |
README.md
@emotion/sheet
A StyleSheet for css-in-js libraries
yarn add @emotion/sheet
import { StyleSheet } from '@emotion/sheet'
const sheet = new StyleSheet({ key: '', container: document.head })
sheet.insert('html { color: hotpink; }')
Note: This is not useful for server-side rendering, you should implement SSR seperately
StyleSheet
Options
type Options = {
nonce?: string
key: string
container: HTMLElement
speedy?: boolean
maxLength?: number
}
nonce
A nonce that will be set on each style tag that the sheet inserts for Content Security Policies.
container
A DOM Node that the sheet will insert all of it's style tags into, this is useful for inserting styles into iframes.
key
This will be set as the value of the data-emotion
attribute on the style tags that get inserted. This is useful to identify different sheets.
speedy
This defines how rules are inserted. If it is true, rules will be inserted with insertRule
which is very fast but doesn't allow rules to be edited in DevTools. If it is false, rules will be inserted by appending text nodes to style elements which is much slower than insertRule but allows rules to be edited in DevTools. By default, speedy is enabled in production and disabled in development.
maxLength
This defines the number of rules that are inserted into each style tag. This generally shouldn't be modified.
Methods
insert
This method inserts a single rule into the document. It must be a single rule otherwise an error will be thrown in speedy mode which is enabled by default in production.
flush
This method will remove all style tags that were inserted into the document.
Example with all options
import { StyleSheet } from '@emotion/sheet'
const container = document.createElement('div')
document.head.appendChild(container)
const sheet = new StyleSheet({
nonce: 'some-nonce',
key: 'some-key',
container,
maxLength: 20
})
sheet.insert('html { color: hotpink; }')
sheet.flush()
Thanks
This StyleSheet is based on glamor's StyleSheet written by Sunil Pai. ❤️