-
Notifications
You must be signed in to change notification settings - Fork 982
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(og-gen): Implement middleware and hooks (#10469)
Co-authored-by: Rob Cameron <cannikin@fastmail.com>
- Loading branch information
Showing
32 changed files
with
1,135 additions
and
63 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,45 @@ | ||
- feat(og-gen): Implement middleware and hooks (#10469) by @dac09 | ||
|
||
The OG Gen saga continues with @cannikin and @dac09 ⚔️ | ||
|
||
This PR: | ||
- adds OgImageMiddleware and Hooks to `@redwoodjs/og-gen`, complete with tests | ||
|
||
⚠️ Template changes: | ||
- updates entry.client template to pass in Routes to App | ||
- updates App to take children (i.e. Routes) | ||
|
||
This is so that we can pass the OG component to be rendered _with_ your App's CSS setup. | ||
|
||
|
||
**How to use this?** | ||
|
||
1. **Registering the middleware:** | ||
```ts | ||
import OgImageMiddleware from '@redwoodjs/ogimage-gen/middleware' | ||
|
||
export const registerMiddleware = () => { | ||
const ogMw = new OgImageMiddleware({ | ||
App, | ||
Document, | ||
}) | ||
|
||
return [ogMw] | ||
} | ||
``` | ||
|
||
2. Configure your `vite.config.ts` | ||
```ts | ||
import vitePluginOgImageGen from '@redwoodjs/ogimage-gen/plugin' | ||
const viteConfig: UserConfig = { | ||
// 👇 so it builds your OG components | ||
plugins: [redwood(), vitePluginOgImageGen()], | ||
} | ||
export default defineConfig(viteConfig) | ||
``` | ||
3. Add your OG Image component next to the page it's for | ||
e.g. web/src/pages/AboutPage/AboutPage.png.tsx | ||
|
||
4. Use hooks on AboutPage to generate the ogURL |
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 |
---|---|---|
|
@@ -31,6 +31,7 @@ | |
"Flightcontrol", | ||
"graphiql", | ||
"memfs", | ||
"OGIMAGE", | ||
"opentelemetry", | ||
"pino", | ||
"Pistorius", | ||
|
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
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
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
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
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
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
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
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
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
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
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
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
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,3 @@ | ||
/* eslint-env node */ | ||
|
||
module.exports = require('../dist/hooks.js').default |
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,3 @@ | ||
/* eslint-env node */ | ||
|
||
module.exports = require('../dist/OgImageMiddleware.js').default |
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.