ayo/wcb
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): indicate "stable alpha" status

Browse source
This commit is contained in:
Ayo Ayco 2025-03-27 09:39:32 +01:00
parent 7194eac159
commit 36a77bf477
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/astro.config.mjs
View file

@ -9,7 +9,7 @@ export default defineConfig({
},
integrations: [
starlight({
title: 'WCB',
title: 'WCB (alpha)',
social: {
npm: 'https://www.npmjs.com/package/web-component-base',
sourcehut: 'https://sr.ht/~ayoayco/wcb/',

7
docs/src/content/docs/guides/getting-started.mdx
View file

@ -3,9 +3,10 @@ title: Getting Started
slug: getting-started
---
import { Aside } from '@astrojs/starlight/components';
import { Aside, Badge } from '@astrojs/starlight/components';
**Web Component Base (WCB)** is a zero-dependency, tiny JS base class for creating reactive [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_custom_elements) easily.
**Web Component Base (WCB)**
<Badge text="alpha" variant="danger" /> is a zero-dependency, tiny JS base class for creating reactive [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_custom_elements) easily.
When you extend the WebComponent class for your component, you only have to define the template and properties. Any change in any property value will automatically cause just the component UI to render.
@ -13,7 +14,7 @@ The result is a reactive UI on property changes.
## Project Status
Treat it as an **alpha** product. Most examples are only useful for simple atomic use-cases at the moment. If you have a cool project using **WebComponent.io** we'd love to know! :)
Treat it as a **stable alpha** product. Though the public APIs are stable, most examples are only useful for simple atomic use-cases due to remaining work needed on the internals.
<Aside type="caution" title="Important">
For building advanced interactions, there is an in-progress work on smart diffing to prevent component children being wiped on interaction.