README.zh.md

openElement

English | 简体中文

以 Web Components 为原生组件契约、static-first 的应用框架。 Custom Elements 是可长期保存的应用组件模型；JSX 与 Basic Element 是作者层； Declarative Shadow DOM 是默认服务端表示；交互区域按需升级。

已发布包线为 0.41.0-alpha.19（v0.41.0-alpha.19）。项目继续使用 alpha 命名，直到五包产品与外部采用证据充分成熟；已放弃的 beta 命名不再是当前版本线。

当前产品

OpenElement = Web Components-native fullstack application framework
current proven scope = static-first applications with fullstack output paths
official build path = Vite + Nitro

当前消费者包图为五包：

包	角色
@openelement/element	Custom Elements、JSX、DSD、hydration 与 signals
@openelement/app	页面、路由、islands 与 request/render 语义
@openelement/adapter-vite	Vite、content、静态构建与 Nitro 输出
@openelement/create	已安装 starter 与零上下文入口
@openelement/ui	可选、经过证明的通用 primitives

旧的 core、signal、router、protocol、content 与 ssg 是实现历史， 不再是受支持的消费者导入。

为什么使用 openElement

当一个标准 Custom Element 应同时服务于独立组件库和完整应用时，OpenElement 提供统一契约。它把原生元素作者体验、路由、静态生成、DSD、选择性升级和可部署 输出组合在一起，而不把某个框架专有 virtual DOM 变成长期 UI 模型。

“WC 全栈第一”是明确的战略目标，必须通过 WC SSR 兼容性、第三方元素互操作、 可移植部署与外部采用来证明；当前不将其表述为已取得的市场结论。

当前发布状态

五包收敛已作为 0.41.0-alpha.19 发布。npm beta.1 至 beta.3 仍是已撤回的 不完整历史产物，不构成兼容基线。外部 adopter pilot #390 仍是作出稳定性承诺前 最重要的仓库外条件。Alpha.18 已完成第二轮审计清扫（ADR-0117）。

只有后续 alpha 不再需要架构、公开接口或采用工作时，才发布 stable 0.41.0。 request-time data、forms、sessions 与 cache 仍是后续产品工作；当前承诺是具有 fullstack 输出路径的 static-first 应用，不是泛全栈能力对等宣称。

1.0.0 路径是在 Application Loop、WC SSR、Production Runtime 与外部采用证据完成后， 形成稳定的五包产品。

开始使用

deno run -A npm:@openelement/create my-app
cd my-app
deno task dev

生成项目提供 dev、check、test、build 和 preview。

文档

主题	链接
指南	openelement.org/guide/getting-started
API 参考	openelement.org/apilist
架构	openelement.org/architecture/architecture
路线图	docs/roadmap/ROADMAP.md
当前状态	docs/status/STATUS.md

强制项目流程见 docs/governance/PROJECT_WORKFLOW.md。

贡献

参见 CONTRIBUTING.md。架构决策在 docs/adr/； 历史 release 与 audit 记录保留为证据，不再作为当前产品文档。

许可

MIT