Move overflow-ui in-repo as @workflowbuilder/ui + UI Library docs#40
Closed
librowski wants to merge 9 commits into
Closed
Move overflow-ui in-repo as @workflowbuilder/ui + UI Library docs#40librowski wants to merge 9 commits into
librowski wants to merge 9 commits into
Conversation
Move the Base UI rewrite of overflow-ui (packages/ui + packages/tokens) into the monorepo, renamed and published as @workflowbuilder/ui and @workflowbuilder/ui-tokens. The sdk, demo and ai-studio consume it via workspace:* and provide @base-ui/react. - packages/ui, packages/tokens: extend the root eslint/tsconfig, move shared deps onto the catalog, bump to React 19, add @base-ui/react (^1.4.0). Drop the legacy overflow-ui.js shim and add a ./index.css export. Preserve the multi-entry build and the CSS layer contract. - sdk, demo, ai-studio: rewrite imports to @workflowbuilder/ui, drop the LOCAL_OVERFLOW_UI vite aliases, the overflow-ui-css alias and dev:local. Fix the Switch onChange signature and the DatePicker date-fns valueFormat tokens against the new Base UI API. - build: tokens and ui dist build on install via prepare (topological); build:lib chains tokens, ui then sdk. - docs: point UI-library references at @workflowbuilder/ui.
Collaborator
Author
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.
Summary
Moves the overflow-ui component library (the Base UI rewrite) into this monorepo as the publishable
@workflowbuilder/uipackage, switches all consumers off the published@synergycodes/overflow-ui@1.0.0-beta.27(MUI) onto it, and builds a full UI Library documentation section (page-per-component, twin to the Overflow UI docs) with source-generated API tables and a Design Tokens pipeline page.Decisions taken with the maintainer: rename to
@workflowbuilder/ui(+@workflowbuilder/ui-tokens), keep it publishable to npm, consume builtdistviaworkspace:*.What's in here
Package move
packages/ui(@workflowbuilder/ui) +packages/tokens(@workflowbuilder/ui-tokens) brought in fromoverflow-ui@base-ui-migration, preserving the multi-entry build, the CSS@layercontract (ui.base/ui.component), andcombine-css-bundle. Dropped decision-logs, theoverflow-ui.jsback-compat shim, dead deps, and the preview app.catalog:, React 18→19,@base-ui/reactadded to the catalog.Consumers (sdk / demo / ai-studio)
@synergycodes/overflow-ui→@workflowbuilder/ui;workspace:*;@base-ui/reactadded; removed theLOCAL_OVERFLOW_UIvite aliases +overflow-ui-cssalias +dev:local; SDKindex.cssswitched to@workflowbuilder/ui/{tokens,index}.css.Switch.onChange(checked, event); DatePickerdate-fnsvalueFormat). Menu/Select/IconSwitch/Tooltip were already compatible.@base-ui/reactpinned to 1.4.1 (the version the library was validated against) - 1.6.0 changed Dialog transitions and broke the modal backdrop fade.Build
distbuilds onpnpm installviaprepare(topological: tokens → ui);build:libchainstokens → ui → sdk.Docs (
apps/docs, Starlight)scripts/generate-ui-api.mjs): TypeDoc extracts per-component props (type/required/default/description) from the library's prop types; CSS variables are extracted from the component stylesheets. Rendered inline viaPropsTable/CssVariablesTableAstro components - no hand-maintained tables.tokens.json(Figma) → style-dictionary →--ax-*CSS pipeline, theming, customization, and the known "missing token" gaps.Verification
pnpm installclean;build,build:lib,build:docs,build:ai-studiogreen;pnpm typecheck,pnpm lint,pnpm test(sdk 184 + execution-core 78) green.@synergycodes/overflow-uifrom npm or the old local dist path.Notes for reviewer
pnpm checkis red only on pre-existingastro checkerrors inapps/docshead.astro/sidebar.astro(untouched here; reproduces with this branch's changes stashed). All other gates pass.@workflowbuilder/sdk(consumes the in-repo UI).@workflowbuilder/uiis now a second publishable package, so the release tag scheme (v*) needs migrating to scoped tags before publishing it - flagged inCLAUDE.md/packages/sdk/RELEASE.md(maintainer, out of scope here).lint-staged.config.mjstopackages/uiandpackages/tokens(they were never committed through the hook before).Out of scope
No npm publish; no release-workflow / tag-scheme migration; the "Overflow" product upsell card (
overflow-card.astro) is left as-is (it advertises the commercial product, not the vendored library).