-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add plugin for injecting Emotion cache
- Loading branch information
Showing
7 changed files
with
382 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# plugin-emotion-cache | ||
|
||
Inject [emotion cache](https://emotion.sh/docs/@emotion/cache) into the Puck iframe. | ||
|
||
## Quick start | ||
|
||
```sh | ||
npm i @measured/puck-plugin-emotion-cache | ||
``` | ||
|
||
```jsx | ||
import { Puck } from "@measured/puck"; | ||
import createEmotionCache from "@measured/puck-plugin-emotion-cache"; | ||
|
||
// Create your emotion cache plugin. This example configures it for Chakra. | ||
const chakraEmotionCache = createEmotionCache("cha"); | ||
|
||
// Render Puck | ||
export function Page() { | ||
return <Puck config={config} data={data} plugins={[chakraEmotionCache]} />; | ||
} | ||
``` | ||
|
||
## Args | ||
|
||
| Param | Example | Type | Status | | ||
| ------------- | ------- | ------ | -------- | | ||
| [`key`](#key) | `cha` | String | Required | | ||
|
||
### Required args | ||
|
||
#### `key` | ||
|
||
Key to pass to Emotion's [`createCache` method](https://emotion.sh/docs/@emotion/cache#createcache). | ||
|
||
## License | ||
|
||
MIT © [Measured Corporation Ltd](https://measured.co) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
import { Plugin } from "@/core/types/Plugin"; | ||
import { useEffect, useState } from "react"; | ||
|
||
import createCache, { EmotionCache } from "@emotion/cache"; | ||
import { CacheProvider } from "@emotion/react"; | ||
|
||
const createEmotionCachePlugin = (key: string): Plugin => { | ||
return { | ||
overrides: { | ||
iframe: ({ children, document }) => { | ||
// eslint-disable-next-line react-hooks/rules-of-hooks | ||
const [cache, setCache] = useState<EmotionCache | null>(null); | ||
|
||
// eslint-disable-next-line react-hooks/rules-of-hooks | ||
useEffect(() => { | ||
if (document) { | ||
setCache( | ||
createCache({ | ||
key, | ||
container: document.head, | ||
}) | ||
); | ||
} | ||
}, [document, key]); | ||
|
||
if (cache) { | ||
return <CacheProvider value={cache}>{children}</CacheProvider>; | ||
} | ||
|
||
return <>{children}</>; | ||
}, | ||
}, | ||
}; | ||
}; | ||
|
||
export default createEmotionCachePlugin; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"name": "@measured/puck-plugin-emotion-cache", | ||
"version": "0.15.0", | ||
"author": "Measured Corporation Ltd <[email protected]>", | ||
"repository": "measuredco/puck", | ||
"bugs": "https://github.com/measuredco/puck/issues", | ||
"homepage": "https://puckeditor.com", | ||
"private": false, | ||
"main": "./dist/index.js", | ||
"types": "./dist/index.d.ts", | ||
"license": "MIT", | ||
"scripts": { | ||
"lint": "eslint \"**/*.ts*\"", | ||
"build": "rm -rf dist && tsup index.tsx", | ||
"prepare": "yarn build" | ||
}, | ||
"files": [ | ||
"dist" | ||
], | ||
"devDependencies": { | ||
"@emotion/react": "^11.13.3", | ||
"@measured/puck": "^0.15.0", | ||
"@types/react": "^18.2.0", | ||
"@types/react-dom": "^18.2.0", | ||
"eslint": "^7.32.0", | ||
"eslint-config-custom": "*", | ||
"tsconfig": "*", | ||
"tsup": "^8.2.4", | ||
"tsup-config": "*", | ||
"typescript": "^5.5.4" | ||
}, | ||
"dependencies": {}, | ||
"peerDependencies": { | ||
"react": "^17.0.0 || ^18.0.0", | ||
"@emotion/react": "^11.0.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"extends": "tsconfig/react-library.json", | ||
"include": ["."], | ||
"exclude": ["dist", "build", "node_modules"], | ||
"compilerOptions": { | ||
"paths": { | ||
"@/core": ["../core"], | ||
"@/core/*": ["../core/*"] | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
import { defineConfig } from "tsup"; | ||
import tsupconfig from "../tsup-config"; | ||
|
||
export default defineConfig(tsupconfig); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.