This content originally appeared on DEV Community and was authored by Aral Roca
Traditional way of writing Web Components is not very SSR (Server Side Rendering) friendly. In this post, I show you how you can build reactive Web Components that work with SSR and with any JavaScript framework (Vue, React, Svelte, Solid, Brisa) or Vanilla JS.
- Introduction
- Writting a Web Component with Brisa
- Building the Web Component
- Loading the Web Component in a Vanilla JS project
- SSR of the Web Component
- Tell me more about Brisa... Please...
- Note for Web Component library creators
- Example
- Conclusion
Introduction
We are going to use Brisa Web Component Compiler. Brisa is a web framework that, besides being similar to other frameworks like Next.js or Nuxt.js, also allows you to build reactive Web Components that work with signals for reactivity, with JSX and with SSR.
Brisa logo
In order to do this, you only need to know the syntax of Brisa when writing Web Components. Brisa is not yet public as it is currently at 95.48% of the v0.1 routemap, but we estimate that in 1 month it will be ready for launch and everyone will be able to access it. However, even if it is not public at all, you can already use it to create your own Web Components libraries.
Writting a Web Component with Brisa
As an example, we are going to write a Web Component of a counter, as always, the classic example.
counter-wc.tsx
import type { WebContext } from "brisa";
export default function CounterWC(
{ start = 0, color = "#2cebcf" }: { start?: number; color?: string },
{ state, css }: WebContext,
) {
const count = state(start);
css`
button {
background-color: ${color};
color: white;
border: none;
border-radius: 5px;
padding: 10px;
margin: 5px;
cursor: pointer;
}
div {
display: flex;
justify-content: center;
align-items: center;
}
`;
return (
<div>
<button onClick={() => count.value++}>+</button>
{count.value}
<button onClick={() => count.value--}>-</button>
</div>
);
}
Brisa uses the name of the files to know the selector, here the selector would be counter-wc.
TIP: Although Brisa is not public yet, you can use TypeScript types to guide you on how to write Web Components.
In the example above, state is used to create a signal and then using the .value you make it reactive inside the JSX. The props are also special signals, since as they are read-only, the .value is not used to make it easier to use and to define default values more easily, this is done through build-time optimizations, similar to React to act as if they were using signals but the other way around.
The css template literal allows it to react to reactive changes in this case of the color property. This css template literal outside of this example is very useful for making reactive animations easily. It is important to remember that Web Components work with Shadow DOM, so the CSS does not affect the rest of the page.
Building the Web Component
To build the Web Component, you need to run the following command:
brisa build -w counter-wc.tsx
This command will generate 2 files:
[ wait ] 🚀 building your standalone components...
[ info ]
[ info ] Standalone components:
[ info ] - build/counter-wc.client.js (670.00 B)
[ info ] - build/counter-wc.server.js (842.00 B)
[ info ]
[ info ] ✨ Done in 42.20ms.
These files are not the Web Component, it is only the rendering function of the Web Component optimized at build-time to be as light as possible (the bytes that come out are without gzip).
So, how do we load the Web Component?
Loading the Web Component in a Vanilla JS project
To do this, you need to add the importmap in the HTML with brisa/client and then import the counter-wc.client.js file:
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Brisa Web Component Example</title>
<script type="importmap">
{
"imports": {
"brisa/client": "https://unpkg.com/brisa@latest/client-simplified/index.js"
}
}
</script>
<script type="module" src="https://unpkg.com/counter-wc@latest"></script>
</head>
<body>
<counter-wc start="15"></counter-wc>
</body>
</html>
Here only the rendering part would be ported in each web component file, while they would all use the same Brisa wrapper defined in the importmap, which is responsible for creating the Web Component with the signals and the shadow DOM.
SSR of the Web Component
SSR of a Web Component can now be done thanks to Declarative Shadow DOM. The counter-wc.server.js file has already been compiled with this behavior, so you only need to import it on your server and render it in the HTML and adapt it to your server framework.
Here is an example with Bun.js or Node.js without using JSX:
ssr.js
import { renderToString } from "brisa/server";
import { jsx } from "brisa/jsx-runtime";
import CustomCounter from "counter-wc/server";
const html = `
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Brisa Web Component Example</title>
<script type="importmap">
{
"imports": {
"brisa/client": "https://unpkg.com/brisa@latest/client-simplified/index.js"
}
}
</script>
<script type="module" src="https://unpkg.com/counter-wc@latest"></script>
</head>
<body>
${await renderToString(jsx(CustomCounter, { start: 10 }))}
</body>
</html>
`;
console.log(html);
Then run bun run ssr.js and you will see the HTML with the rendered web component using the Declarative Shadow DOM.
Tell me more about Brisa... Please...
The integration of these Web Component libraries with Brisa is done through a configuration file:
import type { WebComponentIntegrations } from "brisa";
export default {
"custom-counter": {
client: "./path/to/web-component.client.js",
server: "./path/to/web-component.server.js",
types: "./path/to/web-component.types.d.ts",
},
} satisfies WebComponentIntegrations;
In this way, SSR and TypeScript types are automatically integrated into your project. And you can use the Web Component in any Server Component or within another Web Component.
If you are interested in knowing more, I invite you to subscribe to the Brisa newsletter to receive the latest news and updates on Brisa. We estimate that by the end of September it will be ready for launch.
Note for Web Component library creators
We encourage you to try Brisa to create your own Web Component libraries. If you put the "made with Brisa" badge, we will put a link to your library on the Brisa page.
<a href="https://brisa.build" target="_blank" rel="noopener noreferrer">
<img
width="150"
height="42"
src="https://aralroca.com/images/blog-images/brisa_badge.svg"
alt="Made with Brisa"
/>
</a>
Example
If you want to see the GitHub repository of the example of the counter that we have explained in this article, you can take a look and use it as a reference for your own creations:
Conclusion
In this post, we have seen how to build reactive Web Components that work with SSR and with any JavaScript framework or Vanilla JS. We have used Brisa to build the Web Component and we have seen how to load it in a Vanilla JS project and how to do SSR with it.
I hope you have enjoyed this post and that you have learned something new. If you have any questions, do not hesitate to ask me in the comments below. I will be happy to help you.
Happy coding and enjoy the rest of the summer! 🌞🌴
This content originally appeared on DEV Community and was authored by Aral Roca
Aral Roca | Sciencx (2024-08-24T00:27:13+00:00) Build Reactive Web Components with SSR. Retrieved from https://www.scien.cx/2024/08/24/build-reactive-web-components-with-ssr/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.