v0.3.0: registerSidebarSection — document the sidebar-panel surface - #1
Open
dylanworrall wants to merge 1 commit into
Open
v0.3.0: registerSidebarSection — document the sidebar-panel surface#1dylanworrall wants to merge 1 commit into
dylanworrall wants to merge 1 commit into
Conversation
Sync the npm typings to the app's plugin API surface (the repo was ahead of published 0.2.0). Documents the sidebar-section contribution point that already ships in the app: - Add PluginSidebarSection interface (id/title/order/viewport/render) and ui.registerSidebarSection() to FrootsPluginApi. - Add the typed registerDomEvent<WindowEventMap> overload and minor doc fixes (kb.read path form, registerInterval return) to match src types. - README: sidebar section in the API table + a worked "Sidebar sections" guide (viewport scoping, order, render/cleanup rules). - Bump 0.2.0 -> 0.3.0. Ref: "Plugin views" design doc §1 (current plugin API surface).
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
2 participants
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
Sync the published
froots-apitypings to the plugin API surface the Froots app already ships. The repo was ahead of npm 0.2.0:registerSidebarSectionexists in the app'ssrc/lib/extensions/types.tsbut was never published, so plugin authors get no types for it.Ref: Plugin views — catalog, now-vs-bridge split design doc §1 ("Current plugin API surface").
Changes
froots.d.tsPluginSidebarSection(id/title?/order?/viewport?/render).ui.registerSidebarSection(section): () => voidtoFrootsPluginApi.registerDomEvent<K extends keyof WindowEventMap>overload; minor doc fixes (kb.readpath form,registerIntervalreturn) to match the source.README.md— sidebar section in the API table + a worked "Sidebar sections" guide (viewport scoping,order, render/cleanup rules).package.json—0.2.0→0.3.0(additive minor).Verification
tsc --noEmit --strict --lib es2020,dom froots.d.ts— clean (exit 0).froots.d.tsFrootsPluginApinow matches the app'stypes.tssurface.Publish (Dylan)
This PR does the bump + docs only.
npm publish(npm credentials / registry deploy) is left for a maintainer — merge, thennpm publishfrommain.