Repository navigation
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds the thesysdev/openui (@openuidev/a2ui) renderer to the ecosystem documentation. The feedback suggests moving this entry from the main 'Community Renderers' table to 'Related Projects' or 'Notable Mentions' because it uses OpenUI Lang statements instead of standard A2UI component JSON objects, which prevents out-of-the-box compatibility with standard A2UI agents.
| | **ChaliceForAuri/a2ui-svelte** (`svelte-a2ui`) | Svelte 5 (Web) | ❌ | ✅ | ✅ |   | [GitHub](https://github.com/ChaliceForAuri/a2ui-svelte) · [npm](https://www.npmjs.com/package/svelte-a2ui) · [Demo](https://chaliceforauri.github.io/a2ui-svelte/) | | ||
| | **Language-Lit/material3-expressive-a2ui** (`@language-lit/material3-expressive-a2ui`) | React + Material 3 Expressive (Web) | ❌ | ✅ | — |   | [GitHub](https://github.com/Language-Lit/material3-expressive-a2ui) · [npm](https://www.npmjs.com/package/@language-lit/material3-expressive-a2ui) · [Demo & Docs](https://m3e.language-lit.com/a2ui/) | | ||
| | **uny/a2ui-compose** (`dev.ynagai.a2ui:a2ui-material3`) | Compose Multiplatform (Android, iOS, desktop, macOS, web JS/wasmJs) | ❌ | ❌ | ✅ |   | [GitHub](https://github.com/uny/a2ui-compose) · [Maven Central](https://central.sonatype.com/namespace/dev.ynagai.a2ui) · [API docs](https://uny.github.io/a2ui-compose/) | | ||
| | **thesysdev/openui** (`@openuidev/a2ui`) | Framework-agnostic core + React adapter (Web) | ❌ | ❌ | ✅ |   | [GitHub](https://github.com/thesysdev/openui/tree/main/packages/a2ui) · [npm](https://www.npmjs.com/package/@openuidev/a2ui) · [Docs](https://www.openui.com/docs/api-reference/a2ui) | |
There was a problem hiding this comment.
Since @openuidev/a2ui uses OpenUI Lang statements instead of the standard A2UI component JSON objects (Basic Catalog), standard A2UI agents will not be compatible with it out of the box. Marking it as a fully compliant v1.0 or later renderer in the main table with a ✅ could be misleading to users who expect plug-and-play compatibility.
As you noted in the PR description, it would be more appropriate to list this under Related Projects or Notable Mentions rather than the main Community Renderers table, clearly highlighting that it is an experimental profile with a different component representation.
References
- When documenting protocol or specification versions, use 'version or later' (e.g., 'v1.0 or later') to ensure forward compatibility when describing feature availability or state.
|
Hi @vishxrad, Thank you for moving the entry to Related Projects. Could you please also update the version wording to v1.0 or later as noted in the bot comment reference? |
|
Thanks @Varun-S10! Updated the wording to 'v1.0 or later' in d949d53. |
Description
Adds thesysdev/openui (
@openuidev/a2ui) to the Related Projects table indocs/public/ecosystem/renderers.md.@openuidev/a2uiis an experimental A2UI v1.0 or later profile from the OpenUI project. It keeps the v1.0 or later lifecycle and envelopes intact (createSurface,updateDataModel,deleteSurface, actions, renderer/agent functions, errors, capabilities, data-model metadata) but representsupdateComponents.componentsas an array of OpenUI Lang statements instead of component JSON objects. The core client is framework-agnostic (it depends on@openuidev/lang-core, not React) and validates incoming messages with exported Zod schemas, so Vue, Svelte, Angular, native or server-side hosts can drive it and supply their own rendering adapter. A React adapter (@openuidev/a2ui/react) ships with the package and renders surfaces through@openuidev/react-lang. MIT licensed.Because the component representation differs from the Basic Catalog JSON shape, standard A2UI agents are not compatible with it out of the box, so it is listed under Related Projects rather than in the Community Renderers table, and the description says so.
Documentation-only change; no code or CHANGELOG affected.
Pre-launch Checklist
One time:
For this PR:
If you need help, consider asking for advice on the discussion board.