Small docs tweaks after changes related to Stylis v4 work (emotion-js…

…#1949)
louisgv · Aug 7, 2020 · 30825fe · 30825fe
1 parent 0a2f7c5
commit 30825fe
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/cache-provider.mdx b/docs/cache-provider.mdx
@@ -9,11 +9,14 @@ It can be useful to customize emotion's options - i.e. to add custom Stylis plug
 /** @jsx jsx */
 import { CacheProvider, jsx, css } from '@emotion/react'
 import createCache from '@emotion/cache'
+import { prefixer } from 'stylis'
 
 const myCache = createCache({
   key: 'my-prefix-key',
   stylisPlugins: [
-    /* your plugins here */
+    customPlugin,
+    // has to be included manually when customizing `stylisPlugins` if you want to have vendor prefixes added automatically
+    prefixer
   ],
 })
 

diff --git a/packages/cache/README.md b/packages/cache/README.md
@@ -41,7 +41,7 @@ A Stylis plugins that will be run by Stylis during preprocessing. [Read the Styl
 
 > Note:
 >
-> Prefixer is just a plugin which happens to be put in default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`.
+> Prefixer is just a plugin which happens to be put in default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`. You can import `prefixer` from the `stylis` module to do that (`import { prefixer } from 'stylis'`);
 
 ### `key`
-Original file line number
+Diff line change
@@ Expand Up @@
     > Note:
     >
-    > Prefixer is just a plugin which happens to be put in default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`.
+    > Prefixer is just a plugin which happens to be put in default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`. You can import `prefixer` from the `stylis` module to do that (`import { prefixer } from 'stylis'`);
     ### `key`
@@ Expand Down @@