refactor(docs): Improve Api tables and add missing snapshots#139
Merged
michaelcozzolino merged 6 commits into2.xfrom Mar 8, 2026
Merged
refactor(docs): Improve Api tables and add missing snapshots#139michaelcozzolino merged 6 commits into2.xfrom
michaelcozzolino merged 6 commits into2.xfrom
Conversation
…yles for PropsApi.vue and SlotsApi.vue
Deploying flyonui-vue-v3 with
|
| Latest commit: |
213bc45
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5b77cf66.flyonui-vue-v3.pages.dev |
| Branch Preview URL: | https://refactor-components-api-tabl.flyonui-vue-v3.pages.dev |
Contributor
WalkthroughThis pull request introduces a new Vue component 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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. Comment |
Deploying flyonui-vue with
|
| Latest commit: |
213bc45
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://431425d9.flyonui-vue.pages.dev |
| Branch Preview URL: | https://refactor-components-api-tabl.flyonui-vue.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
packages/docs/Api/UI/PropsApi.vue (1)
49-51: Consider using visual indicators instead of raw boolean text.
prop.requiredis a boolean, so this will display as "TRUE" or "FALSE" (uppercased). For better UX readability, consider using a checkmark/cross icon or a more user-friendly label like "Yes"/"No".💡 Optional: Use conditional rendering for friendlier display
<FoTableColumn class="font-mono font-semibold text-error uppercase"> - {{ prop.required }} + {{ prop.required ? 'Yes' : 'No' }} </FoTableColumn>Or consider using icons for a cleaner visual representation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/docs/Api/UI/PropsApi.vue` around lines 49 - 51, The template currently renders the boolean prop.required directly inside <FoTableColumn>, producing "TRUE"/"FALSE" text; change this to conditional rendering inside the FoTableColumn in PropsApi.vue (e.g., use a checkmark or "Yes"/"No" for true and a cross or "No" for false) so the value is presented as a friendly visual indicator; update the FoTableColumn that references prop.required to render an icon or localized label based on prop.required instead of the raw boolean.packages/docs/playwright.config.ts (1)
18-18: Consider documenting the reason for the 5x timeout increase.The timeout increase from 120s to 600s (10 minutes) is substantial. While this may be necessary for longer local builds, it could also mask slow build issues. Consider adding a comment explaining why 10 minutes is needed, which helps future maintainers understand if this can be reduced.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/docs/playwright.config.ts` at line 18, Add a short inline comment next to the Playwright config timeout setting (the timeout property in playwright.config.ts where "timeout: 600 * 1000,") explaining why the value was increased to 600000 ms (10 minutes), e.g., referencing longer local build/CI steps or flakiness that required a 5x increase and any ticket/issue/PR number or benchmark that justifies it so future maintainers can assess whether it can be reduced.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@packages/docs/Api/UI/PropsApi.vue`:
- Around line 49-51: The template currently renders the boolean prop.required
directly inside <FoTableColumn>, producing "TRUE"/"FALSE" text; change this to
conditional rendering inside the FoTableColumn in PropsApi.vue (e.g., use a
checkmark or "Yes"/"No" for true and a cross or "No" for false) so the value is
presented as a friendly visual indicator; update the FoTableColumn that
references prop.required to render an icon or localized label based on
prop.required instead of the raw boolean.
In `@packages/docs/playwright.config.ts`:
- Line 18: Add a short inline comment next to the Playwright config timeout
setting (the timeout property in playwright.config.ts where "timeout: 600 *
1000,") explaining why the value was increased to 600000 ms (10 minutes), e.g.,
referencing longer local build/CI steps or flakiness that required a 5x increase
and any ticket/issue/PR number or benchmark that justifies it so future
maintainers can assess whether it can be reduced.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cba7b0d8-0684-43b5-b6eb-71a72fff5419
⛔ Files ignored due to path filters (80)
packages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-alert-FoAlert-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-alert-FoAlert-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-avatar-FoAvatar-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-avatar-FoAvatar-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-avatar-FoAvatarGroup-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-avatar-FoAvatarGroup-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-badge-FoBadge-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-badge-FoBadge-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-badge-FoDotStyleBadge-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-badge-FoDotStyleBadge-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-button-FoButton-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-button-FoButton-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-button-FoLoadingButton-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-button-FoLoadingButton-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-button-FoSocialButton-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-diff-FoDiff-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-list-group-FoListGroup-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-list-group-FoListGroup-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-list-group-FoListGroupItem-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-loading-FoLoading-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-radial-progress-FoRadialProgress-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-radial-progress-FoRadialProgress-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-skeleton-FoSkeleton-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-stats-FoStat-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-stats-FoStatDescription-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-stats-FoStatTitle-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-stats-FoStatValue-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-stats-FoStats-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-status-FoStatus-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-status-FoStatus-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/components-swap-FoSwap-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-block-quote-FoBlockQuote-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-block-quote-FoBlockQuote-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-divider-FoDivider-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-divider-FoDivider-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-heading-FoHeading-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-heading-FoHeading-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-keyboard-FoKeyboard-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-link-FoLink-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/content-link-FoLink-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-checkbox-FoCheckbox-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-checkbox-FoCheckboxGroup-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-input-file-FoInputFile-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-input-text-FoInputText-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-input-text-FoInputText-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-join-FoJoin-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-radio-FoImageRadio-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-radio-FoRadio-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-range-FoRange-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-range-FoRange-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-select-FoDatalist-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-select-FoSelect-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-switch-FoSwitch-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-switch-FoSwitchGroup-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/forms-textarea-FoTextarea-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-menu-FoMenu-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-menu-FoMenu-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-menu-FoMenuItem-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-pagination-FoPagination-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-tabs-FoTab-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-tabs-FoTabContent-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/navigations-tabs-FoTabs-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-modal-FoModal-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-modal-FoModal-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-modal-FoModalTitle-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-popover-FoPopover-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-popover-FoPopover-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-tooltip-FoTooltip-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/overlays-tooltip-FoTooltip-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-data-table-FoDataTable-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-data-table-FoDataTable-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTable-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTable-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableBody-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableColumn-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableColumn-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableHead-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableHeader-props-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableHeader-slots-chromium-linux.pngis excluded by!**/*.pngpackages/docs/tests/EndToEnd/Docs.browser.spec.ts-snapshots/tables-table-FoTableRow-slots-chromium-linux.pngis excluded by!**/*.png
📒 Files selected for processing (4)
packages/docs/Api/UI/LinkableApiName.vuepackages/docs/Api/UI/PropsApi.vuepackages/docs/Api/UI/SlotsApi.vuepackages/docs/playwright.config.ts
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
1 participant
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 by CodeRabbit
New Features
Style