@emotion/cache
    TypeScript icon, indicating that this package has built-in type declarations

    10.0.9 • Public • Published

    @emotion/cache

    createCache

    createCache allows for low level customization of how styles get inserted by emotion. It's intended to be used with the <CacheProvider/> component to override the default cache which is created with sensible defaults for most applications.

    import createCache from '@emotion/cache'
     
    export const myCache = createCache({
      key: 'my-prefix-key',
      stylisPlugins: [
        /* your plugins here */
      ]
    })

    Primary use cases

    • Using emotion in embedded contexts such as an <iframe/>

    • Setting a nonce on any <style/> tag emotion creates for security purposes

    • Use emotion with a developer defined <style/> tag

    • Using emotion with custom stylis plugins

    Options

    nonce: string

    A nonce that will be set on each style tag that emotion inserts for Content Security Policies.

    stylisPlugins: Function | Array

    A Stylis plugin or plugins that will be run by stylis during preprocessing. Read Stylis' docs to find out more. This can for be used for many purposes such as RTL.

    prefix: boolean | Function

    Allows changing Stylis' prefixing settings, this defaults to true. It can be a boolean or a function to dynamicly set which properties are prefixed. More information can be found in Stylis' docs

    key: string

    The prefix before class names, this defaults to css. It will also be set as the value of the data-emotion attribute on the style tags that emotion inserts and it's used in the attribute name that marks style elements in renderStylesToString and renderStylesToNodeStream. This is required if using multiple emotion caches in the same app.

    container: HTMLElement

    A DOM Node that emotion will insert all of it's style tags into, this is useful for inserting styles into iframes.

    Keywords

    none

    Install

    npm i @emotion/cache@10.0.9

    Version

    10.0.9

    License

    MIT

    Unpacked Size

    44.8 kB

    Total Files

    16

    Last publish

    Collaborators

    • tkh44
    • mitchellhamilton
    • emotion-release-bot
    • andarist