Repository navigation
docs(extensibility): add plugin UI component catalog candidate - #183
Merged
Merged
Conversation
…date Catalogue the reusable plugin UI composition patterns requested by bitty#2114 as documented recipes over the accepted v1 scene nodes: edge band, pill row, tooltip/detail fallback, modal sheet, and status strip. Each entry states its surface status first, then a scene shape, style hooks, interaction and accessibility notes, a budget note, and a headed Lua example. Availability is explicit: the band, pill row, and status strip use only accepted v1 fields; the detail fallback is partially available; the modal sheet is marked not available because plugin API v1 carries no modal authority. The bar plugin mapping records which pinned bar element matches which recipe and states that no shared implementation exists yet, so no dogfood claim is made.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this adds
New candidate page
extensibility/ui-component-catalog-candidate.md, indexed inextensibility/README.md: five named composition recipes over the acceptedPlugin API v1 declarative surface, plus the bar plugin mapping.
Each entry states its surface status first, then scene shape, style hooks,
interaction, accessibility notes, budget note, and a headed Lua example.
Availability is stated, not assumed
Text/Row/Column/List,fg/bg/bold, andon_click/on_scrollwithregion.bitty.notifyare accepted; the presentation-only overlay (ui.present) iscurrent host fact and is explicitly not in the accepted RFC; anchored tooltips
do not exist.
authority,
ui.presentadmits only a non-modal surface, andregister_panel/PanelProviderstay excluded from v1. The page documents thesubstitutes and their limits instead of sketching a sheet.
No entry adds a node kind, slot, field, capability, budget, or error code, and no
candidate direction is presented as a contract.
Bar mapping
The bar plugin mapping records which pinned bar element matches which recipe
(band root row, capsules, marks, detail notification fallback, per-module
omission). It states explicitly that the bar does not import these recipes as
code, so no dogfood proof of shared implementation is claimed.
Verification
just checkcannot complete in the authoring environment:bun/bunxsegfault (signal 11) on every invocation, so the
fmt-checkrecipe dies withexit 139 before the remaining gates run. Every gate was therefore run through the
pinned equivalents, all green:
prettier@3.9.6 --check . --ignore-unknown(0 issues)markdownlint-cli2@0.23.1(0 issues, 106 files)check-docs.mjs links|metadata|language|agents|hygiene(each 0)xmllintsvg gate andactionlint 1.7.12(0)Issue
Related #2114, not Closes. Checklist item 1 (catalog the band, pill row,
tooltip/detail fallback, modal sheet, and status strip with contracts) and item 2
(scene shape, style hooks, accessibility notes, and a headed example per entry)
are covered by this page. Item 3, "Bar migrated onto catalog entries (dogfood
proof)", is not: this PR maps the bar's pinned behaviour but does not migrate the
bar plugin, which lives in its own repository.