Uh oh!
There was an error while loading. Please reload this page.
docs(swingset): document Collapsible headless primitive - #8809
Conversation
Add an overview page for the @clerk/headless Collapsible primitive in swingset, along with the supporting setup to document headless primitives: resolve @clerk/headless from source (next.config + tsconfig alias), and an overview-only registry pattern (a single unstyled live demo, no interactive knob canvas). Disable Prettier embedded-code formatting for *.mdx so fenced code samples keep their authored style (no auto-added trailing semicolons).
🦋 Changeset detectedLatest commit: 74cfe1e The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR integrates the ChangesHeadless Collapsible Integration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/swingset/src/stories/collapsible.stories.tsx (1)
17-17: ⚡ Quick winAdd an explicit return type to
Default.Line 17 should declare a return type to match the repo’s TypeScript rule for function signatures.
Proposed diff
-export function Default() {+export function Default(): React.JSX.Element {As per coding guidelines: “Always define explicit return types for functions, especially public APIs.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/swingset/src/stories/collapsible.stories.tsx` at line 17, The function export Default lacks an explicit TypeScript return type; update its signature (the function named Default) to include an explicit React return type such as (): JSX.Element or (): React.ReactElement (matching project conventions) so the signature becomes export function Default(): JSX.Element { ... } and satisfies the repo rule requiring explicit function return types.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/swingset/src/stories/collapsible.stories.tsx`:
- Line 17: The function export Default lacks an explicit TypeScript return type;
update its signature (the function named Default) to include an explicit React
return type such as (): JSX.Element or (): React.ReactElement (matching project
conventions) so the signature becomes export function Default(): JSX.Element {
... } and satisfies the repo rule requiring explicit function return types.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 2f1e817e-19f1-45e2-9aa1-fef7ff6d112a
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (12)
.changeset/document-headless-collapsible.mdpackages/swingset/next.config.mjspackages/swingset/package.jsonpackages/swingset/src/app/layout.tsxpackages/swingset/src/components/DocsViewer.tsxpackages/swingset/src/components/StoryCanvas.tsxpackages/swingset/src/lib/registry.tspackages/swingset/src/stories/button.mdxpackages/swingset/src/stories/collapsible.mdxpackages/swingset/src/stories/collapsible.stories.tsxpackages/swingset/tsconfig.jsonprettier.config.mjs
Uh oh!
There was an error while loading. Please reload this page.
TLDR
This fixes a few bugs with swingset and adds our first headless "primitive" to the list. If this one is approved, I'll prepare a PR with the remainder.
The decisions here were:
Description
Documents the
@clerk/headlessCollapsible primitive in the swingset component explorer and adds the supporting setup to document headless primitives going forward:@clerk/headlessis now resolved from source via anext.config.mjs+tsconfig.jsonalias (mirroring how Mosaic is consumed), and primitives use an overview-only pattern — a single unstyled live demo plus prose/props docs, with no interactive knob canvas — so the docs faithfully reflect the unstyled, behavior-only nature of headless components. A Prettieroverridesentry disables embedded-code formatting for*.mdxso fenced code samples keep their authored style (no auto-added trailing semicolons), and the existing Button sample was updated to match. The diff also includes small pre-existing swingset cleanups (layout.tsxwraps the dev<Script>in<head>,StoryCanvas.tsxeffect-deps comment). To test: runpnpm dev --filter @clerk/swingsetand open/components/collapsibleto see the overview and live demo.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Chores