Skip to content

Conversation

@pkosiec
Copy link
Member

@pkosiec pkosiec commented Jan 8, 2026

The documentation website now has live preview of the UI components. How it works?

How it works

During docs site build:

  1. We generate API reference for appkit exports and appkit-ui ones too (discovering props automatically)
  2. Then the prepared examples (docs: introduce UI components examples #45) are synchronized into the website content (as the examples.gen.ts file), together with the appkit-ui built styles. (appkit-ui/styles.gen.css)

On the docs website, we display components in iframes for styles isolation, and we do some tweaks to ensure even dynamic styles and content aren't leaking to the parent. See the IframePreview component to see all those hacks.

Resolves https://databricks.atlassian.net/browse/LKB-8139

Demo

ui-components-docs.mp4

@pkosiec pkosiec force-pushed the pkosiec/docs-ui-components-examples branch from 54bd34b to c9e6e1d Compare January 8, 2026 22:23
@pkosiec pkosiec changed the base branch from pkosiec/docs-api-reference-ui-components to pkosiec/ui-components-examples January 8, 2026 22:27
@pkosiec pkosiec marked this pull request as ready for review January 8, 2026 22:39
@pkosiec pkosiec requested review from MarioCadenas and ditadi and removed request for MarioCadenas January 8, 2026 22:41
@pkosiec pkosiec force-pushed the pkosiec/ui-components-examples branch from d6c82ee to 853d694 Compare January 9, 2026 11:54
@pkosiec pkosiec force-pushed the pkosiec/docs-ui-components-examples branch 2 times, most recently from cb2da99 to 29698e4 Compare January 9, 2026 13:41
@pkosiec
Copy link
Member Author

pkosiec commented Jan 9, 2026

JFYI @ditadi Rebased on top of the new examples: I needed to modify docusaurus config to fix the imports:

Other than that, there are no other changes AFAIK 👍

Base automatically changed from pkosiec/ui-components-examples to main January 13, 2026 08:35
@pkosiec pkosiec force-pushed the pkosiec/docs-ui-components-examples branch from 29698e4 to e0c68a5 Compare January 13, 2026 08:36
@pkosiec pkosiec merged commit 1793718 into main Jan 13, 2026
4 checks passed
@pkosiec pkosiec deleted the pkosiec/docs-ui-components-examples branch January 13, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants