-
Notifications
You must be signed in to change notification settings - Fork 50.7k
docs: Add component specification for N8nLoading with API definition and usage examples #22055
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
…and usage examples
BundleMonUnchanged files (2)
No change in files bundle size Groups updated (2)
Final result: ✅ View report in BundleMon website ➡️ |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 issue found across 1 file
Prompt for AI agents (all 1 issues)
Understand the root cause of the following 1 issues and fix them.
<file name="packages/frontend/@n8n/design-system/src/v2/components/Loading/component-loading.md">
<violation number="1" location="packages/frontend/@n8n/design-system/src/v2/components/Loading/component-loading.md:162">
Example claims column layout honors `variant`, but the component ignores `variant` when `cols` is set, so the documented behavior cannot be achieved.</violation>
</file>
Reply to cubic to teach it or ask questions. Re-run a review with @cubic-dev-ai review this PR
|
|
||
| <template> | ||
| <!-- Renders 4 columns instead of rows --> | ||
| <N8nLoading :cols="4" variant="rect" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example claims column layout honors variant, but the component ignores variant when cols is set, so the documented behavior cannot be achieved.
Prompt for AI agents
Address the following comment on packages/frontend/@n8n/design-system/src/v2/components/Loading/component-loading.md at line 162:
<comment>Example claims column layout honors `variant`, but the component ignores `variant` when `cols` is set, so the documented behavior cannot be achieved.</comment>
<file context>
@@ -0,0 +1,189 @@
+
+<template>
+ <!-- Renders 4 columns instead of rows -->
+ <N8nLoading :cols="4" variant="rect" />
+</template>
+```
</file context>
Summary
Add API specification for N8nLoading migration from Element+ to Reka UI, documenting all 6 props currently used in the codebase (including animated, loading, rows, cols, shrinkLast, and variant with 9 possible values) with 8 usage examples and implementation notes for backward compatibility
Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/DS-309/write-loader-api-specs
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)Note
Add documentation/spec for
N8nLoadingskeleton component, defining props and showcasing usage patterns.packages/frontend/@n8n/design-system/src/v2/components/Loading/component-loading.mdforN8nLoading.animated,loading,rows,cols,shrinkLast,variant(with supported values), plus notes on no events/slots.Written by Cursor Bugbot for commit a19ae81. This will update automatically on new commits. Configure here.