@puckeditor/plugin-emotion-cache 0.21.0-canary.d1c0d6a2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # plugin-emotion-cache
2
+
3
+ Inject [emotion cache](https://emotion.sh/docs/@emotion/cache) into the Puck iframe.
4
+
5
+ ## Quick start
6
+
7
+ ```sh
8
+ npm i @puckeditor/plugin-emotion-cache
9
+ ```
10
+
11
+ ```jsx
12
+ import { Puck } from "@puckeditor/core";
13
+ import createEmotionCache from "@puckeditor/plugin-emotion-cache";
14
+
15
+ // Create your emotion cache plugin. This example configures it for Chakra.
16
+ const chakraEmotionCache = createEmotionCache("cha");
17
+
18
+ // Render Puck
19
+ export function Page() {
20
+ return <Puck config={config} data={data} plugins={[chakraEmotionCache]} />;
21
+ }
22
+ ```
23
+
24
+ ## Args
25
+
26
+ | Param | Example | Type | Status |
27
+ | ------------- | ------- | ------ | -------- |
28
+ | [`key`](#key) | `cha` | String | Required |
29
+
30
+ ### Required args
31
+
32
+ #### `key`
33
+
34
+ Key to pass to Emotion's [`createCache` method](https://emotion.sh/docs/@emotion/cache#createcache).
35
+
36
+ ## License
37
+
38
+ MIT © [The Puck Contributors](https://github.com/puckeditor/puck/graphs/contributors)