Skip to content

chore: describe component props in their source - #1014

Open
rohanchkrabrty wants to merge 1 commit into
feat/docs-props-generatorfrom
chore/props-jsdoc
Open

rohanchkrabrty wants to merge 1 commit into
feat/docs-props-generatorfrom
chore/props-jsdoc

Conversation

@rohanchkrabrty

@rohanchkrabrty rohanchkrabrty commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Write a one-line JSDoc for each prop in the component source, with
`@default` where the component sets one, so the docs tables can read the
types in place of the hand-written props.ts files.

Parts that pass fixed props to Flex, Text, IconButton or Select.Trigger
redeclare those props in a local interface with their own `@default`, for
example Dialog.Header `justify` and `align`. Props that only a union
branch or a wrapped library declares get an Apsara declaration, and
data-view exports `ViewSpec`. Types and comments only, no runtime change.
@vercel

vercel Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
apsara Ready Ready Preview Nov 17, 2026 9:50am UTC

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Too many files!

This PR contains 153 files, which is 53 over the limit of 100.

To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry.

Check out review usage here.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8ccf7fb4-1baa-403a-b165-aaad027edbcc
Commits

Reviewing files that changed from the base of the PR and between 7ce6394 and e11c2be.

Files selected for processing: 153

  • packages/react/components/accordion/accordion-root.tsx
  • packages/react/components/alert-dialog/alert-dialog-content.tsx
  • packages/react/components/alert-dialog/alert-dialog-misc.tsx
  • packages/react/components/announcement-bar/announcement-bar.tsx
  • packages/react/components/avatar/avatar.tsx
  • packages/react/components/avatar/utils.tsx
  • packages/react/components/badge/badge.tsx
  • packages/react/components/breadcrumb/breadcrumb-item.tsx
  • packages/react/components/breadcrumb/breadcrumb-misc.tsx
  • packages/react/components/breadcrumb/breadcrumb-root.tsx
  • packages/react/components/calendar-preview/calendar-preview-body.tsx
  • packages/react/components/calendar-preview/calendar-preview-caption.tsx
  • packages/react/components/calendar-preview/calendar-preview-context.tsx
  • packages/react/components/calendar-preview/calendar-preview-days.tsx
  • packages/react/components/calendar-preview/calendar-preview-footer.tsx
  • packages/react/components/calendar-preview/calendar-preview-grid.tsx
  • packages/react/components/calendar-preview/calendar-preview-input.tsx
  • packages/react/components/calendar-preview/calendar-preview-reset.tsx
  • packages/react/components/calendar-preview/calendar-preview-root.tsx
  • packages/react/components/calendar-preview/calendar-preview-scales.tsx
  • packages/react/components/calendar-preview/calendar-preview-trigger.tsx
  • packages/react/components/calendar-preview/use-calendar.tsx
  • packages/react/components/calendar/calendar.tsx
  • packages/react/components/calendar/date-picker.tsx
  • packages/react/components/calendar/range-picker.tsx
  • packages/react/components/callout/callout.tsx
  • packages/react/components/chat-panel/chat-panel-root.tsx
  • packages/react/components/chat-panel/chat-panel-trigger.tsx
  • packages/react/components/chat/chat-messages.tsx
  • packages/react/components/checkbox/checkbox.tsx
  • packages/react/components/chip/chip.tsx
  • packages/react/components/code-block/code-block-code.tsx
  • packages/react/components/code-block/code-block-language-select.tsx
  • packages/react/components/code-block/code-block-misc.tsx
  • packages/react/components/code-block/code-block-root.tsx
  • packages/react/components/color-picker/color-picker-mode.tsx
  • packages/react/components/color-picker/color-picker-root.tsx
  • packages/react/components/combobox/combobox-content.tsx
  • packages/react/components/combobox/combobox-item.tsx
  • packages/react/components/combobox/combobox-misc.tsx
  • packages/react/components/combobox/combobox-root.tsx
  • packages/react/components/command/command-dialog.tsx
  • packages/react/components/command/command-input.tsx
  • packages/react/components/command/command-item.tsx
  • packages/react/components/command/command-root.tsx
  • packages/react/components/container/container.tsx
  • packages/react/components/context-menu/context-menu-content.tsx
  • packages/react/components/context-menu/context-menu-item.tsx
  • packages/react/components/context-menu/context-menu-root.tsx
  • packages/react/components/context-menu/context-menu-trigger.tsx
  • packages/react/components/copy-button/copy-button.tsx
  • packages/react/components/data-view/components/clear-filters.tsx
  • packages/react/components/data-view/components/display-controls.tsx
  • packages/react/components/data-view/components/filters.tsx
  • packages/react/components/data-view/data-view.types.tsx
  • packages/react/components/dialog/dialog-content.tsx
  • packages/react/components/dialog/dialog-misc.tsx
  • packages/react/components/drawer/drawer-content.tsx
  • packages/react/components/drawer/drawer-root.tsx
  • packages/react/components/editor/core/mention-registry.ts
  • packages/react/components/editor/core/mention.ts
  • packages/react/components/editor/editor-block-button.tsx
  • packages/react/components/editor/editor-control.tsx
  • packages/react/components/editor/editor-floating-toolbar.tsx
  • packages/react/components/editor/editor-history-button.tsx
  • packages/react/components/editor/editor-link-button.tsx
  • packages/react/components/editor/editor-list-menu.tsx
  • packages/react/components/editor/editor-mark-button.tsx
  • packages/react/components/editor/editor-mentions.tsx
  • packages/react/components/editor/editor-root.tsx
  • packages/react/components/editor/editor-slash-menu.tsx
  • packages/react/components/editor/editor-toolbar.tsx
  • packages/react/components/editor/editor-types.ts
  • packages/react/components/editor/markdown/index.ts
  • packages/react/components/empty-state/empty-state.tsx
  • packages/react/components/field/field-root.tsx
  • packages/react/components/fieldset/fieldset.tsx
  • packages/react/components/filter-chip/filter-chip.tsx
  • packages/react/components/flex/flex.tsx
  • packages/react/components/grid/grid-item.tsx
  • packages/react/components/grid/grid.tsx
  • packages/react/components/headline/headline.tsx
  • packages/react/components/icon-button/icon-button.tsx
  • packages/react/components/image/image.tsx
  • packages/react/components/indicator/indicator.tsx
  • packages/react/components/input/input.tsx
  • packages/react/components/kbd/kbd.tsx
  • packages/react/components/label/label.tsx
  • packages/react/components/link/link.tsx
  • packages/react/components/list/list.tsx
  • packages/react/components/menu/cell.tsx
  • packages/react/components/menu/menu-checkbox-item.tsx
  • packages/react/components/menu/menu-content.tsx
  • packages/react/components/menu/menu-item.tsx
  • packages/react/components/menu/menu-link-item.tsx
  • packages/react/components/menu/menu-misc.tsx
  • packages/react/components/menu/menu-radio.tsx
  • packages/react/components/menu/menu-root.tsx
  • packages/react/components/menu/menu-trigger.tsx
  • packages/react/components/meter/meter-misc.tsx
  • packages/react/components/meter/meter-root.tsx
  • packages/react/components/navbar/navbar-root.tsx
  • packages/react/components/navbar/navbar-sections.tsx
  • packages/react/components/number-field/number-field.tsx
  • packages/react/components/popover/popover.tsx
  • packages/react/components/preview-card/preview-card.tsx
  • packages/react/components/progress/progress-misc.tsx
  • packages/react/components/progress/progress-root.tsx
  • packages/react/components/prompt-input/prompt-input-context.tsx
  • packages/react/components/prompt-input/prompt-input-editor.tsx
  • packages/react/components/prompt-input/prompt-input-root.tsx
  • packages/react/components/prompt-input/prompt-input-submit.tsx
  • packages/react/components/prompt-input/prompt-input-textarea.tsx
  • packages/react/components/radio/radio.tsx
  • packages/react/components/reasoning/reasoning.tsx
  • packages/react/components/scroll-area/scroll-area.tsx
  • packages/react/components/search/search.tsx
  • packages/react/components/select/select-content.tsx
  • packages/react/components/select/select-item.tsx
  • packages/react/components/select/select-misc.tsx
  • packages/react/components/select/select-root.tsx
  • packages/react/components/select/select-trigger.tsx
  • packages/react/components/select/select-value.tsx
  • packages/react/components/separator/separator.tsx
  • packages/react/components/side-panel/side-panel.tsx
  • packages/react/components/sidebar/sidebar-group.tsx
  • packages/react/components/sidebar/sidebar-item.tsx
  • packages/react/components/sidebar/sidebar-more.tsx
  • packages/react/components/sidebar/sidebar-root.tsx
  • packages/react/components/skeleton/skeleton.tsx
  • packages/react/components/slider/slider.tsx
  • packages/react/components/spinner/spinner.tsx
  • packages/react/components/switch/switch.tsx
  • packages/react/components/table/table.tsx
  • packages/react/components/tabs/tabs.tsx
  • packages/react/components/text-area/text-area.tsx
  • packages/react/components/text/text.tsx
  • packages/react/components/theme/settings.ts
  • packages/react/components/theme/switcher.tsx
  • packages/react/components/theme/theme.tsx
  • packages/react/components/toast/toast-manager.ts
  • packages/react/components/toast/toast-provider.tsx
  • packages/react/components/toast/toast-root.tsx
  • packages/react/components/toggle/toggle.tsx
  • packages/react/components/toolbar/toolbar.tsx
  • packages/react/components/tooltip/tooltip-content.tsx
  • packages/react/components/tooltip/tooltip-misc.tsx
  • packages/react/components/tour/tour-content.tsx
  • packages/react/components/tour/tour-parts.tsx
  • packages/react/components/tour/tour-root.tsx
  • packages/react/components/tour/types.ts
  • packages/react/icons/create-icon.tsx
  • packages/react/index.tsx

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@pkg-pr-new

pkg-pr-new Bot commented Nov 17, 2026

Copy link
Copy Markdown

Open in StackBlitz

pnpm add https://pkg.pr.new/@raystack/apsara@1014

commit: e11c2be

This branch was successfully deployed

1 active deployment
Preview — e11c2be3 Deployed Nov 17, 2026 by vercel[bot]
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.

1 participant