-
Notifications
You must be signed in to change notification settings - Fork 0
Add Storybook stories for all 14 plugin packages #252
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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
e78a064
Initial plan
Copilot 215a097
Add Storybook stories for plugin components (9 of 14 plugins)
Copilot 62c31e5
Complete Storybook stories for all 14 plugin components
Copilot 8dda86b
Fix Storybook build: Add Vite aliases for plugin packages to avoid ciโฆ
Copilot 98be70a
Merge branch 'main' into copilot/add-stories-for-missing-components
hotlong 6339652
Add Storybook configuration and stories for all components and plugins
hotlong 8fbf6ad
Add missing Storybook stories and update configuration for improved oโฆ
hotlong 7a1b06d
Fix Tailwind source path in index.css and add postcss configuration file
hotlong ddec15f
refactor: update story titles to follow new schema categorization
hotlong 0707e4f
Add Storybook test runner and Playwright dependencies
hotlong 7dc3a83
feat: add CI workflow for Storybook tests and update package scripts
hotlong f23fdb2
fix: update Storybook test timeout and improve data handling in compoโฆ
hotlong 95dcd10
fix: memoize data configuration in ObjectGantt to prevent infinite loops
hotlong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: Storybook Tests | ||
| on: | ||
| push: | ||
| branches: [main, develop] | ||
| pull_request: | ||
| branches: [main, develop] | ||
|
|
||
| jobs: | ||
| test-storybook: | ||
| timeout-minutes: 60 | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '20' | ||
| - name: Setup pnpm | ||
| uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 10 | ||
| - name: Install dependencies | ||
| run: pnpm install | ||
| - name: Install Playwright Browsers | ||
| run: pnpm exec playwright install --with-deps | ||
| - name: Run Storybook tests | ||
| run: pnpm test:storybook:ci |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ node_modules | |
| dist | ||
| build | ||
| out | ||
| storybook-static | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import type { StorybookConfig } from "@storybook/react-vite"; | ||
| import { mergeConfig } from 'vite'; | ||
| import path from 'path'; | ||
|
|
||
| const config: StorybookConfig = { | ||
| stories: ["../packages/**/src/**/*.mdx", "../packages/**/src/**/*.stories.@(js|jsx|mjs|ts|tsx)"], | ||
| addons: [ | ||
| "@storybook/addon-links", | ||
| "@storybook/addon-essentials", | ||
| "@storybook/addon-interactions", | ||
| ], | ||
| framework: { | ||
| name: "@storybook/react-vite", | ||
| options: {}, | ||
| }, | ||
| docs: { | ||
| autodocs: "tag", | ||
| }, | ||
| async viteFinal(config) { | ||
| return mergeConfig(config, { | ||
| resolve: { | ||
| alias: { | ||
| // Alias components package to source to avoid circular dependency during build | ||
| '@object-ui/core': path.resolve(__dirname, '../packages/core/src/index.ts'), | ||
| '@object-ui/react': path.resolve(__dirname, '../packages/react/src/index.ts'), | ||
| '@object-ui/components': path.resolve(__dirname, '../packages/components/src/index.ts'), | ||
| '@object-ui/fields': path.resolve(__dirname, '../packages/fields/src/index.tsx'), | ||
| '@object-ui/layout': path.resolve(__dirname, '../packages/layout/src/index.ts'), | ||
| // Alias plugin packages for Storybook to resolve them from workspace | ||
| '@object-ui/plugin-aggrid': path.resolve(__dirname, '../packages/plugin-aggrid/src/index.tsx'), | ||
| '@object-ui/plugin-calendar': path.resolve(__dirname, '../packages/plugin-calendar/src/index.tsx'), | ||
| '@object-ui/plugin-charts': path.resolve(__dirname, '../packages/plugin-charts/src/index.tsx'), | ||
| '@object-ui/plugin-chatbot': path.resolve(__dirname, '../packages/plugin-chatbot/src/index.tsx'), | ||
| '@object-ui/plugin-dashboard': path.resolve(__dirname, '../packages/plugin-dashboard/src/index.tsx'), | ||
| '@object-ui/plugin-editor': path.resolve(__dirname, '../packages/plugin-editor/src/index.tsx'), | ||
| '@object-ui/plugin-form': path.resolve(__dirname, '../packages/plugin-form/src/index.tsx'), | ||
| '@object-ui/plugin-gantt': path.resolve(__dirname, '../packages/plugin-gantt/src/index.tsx'), | ||
| '@object-ui/plugin-grid': path.resolve(__dirname, '../packages/plugin-grid/src/index.tsx'), | ||
| '@object-ui/plugin-kanban': path.resolve(__dirname, '../packages/plugin-kanban/src/index.tsx'), | ||
| '@object-ui/plugin-map': path.resolve(__dirname, '../packages/plugin-map/src/index.tsx'), | ||
| '@object-ui/plugin-markdown': path.resolve(__dirname, '../packages/plugin-markdown/src/index.tsx'), | ||
| '@object-ui/plugin-timeline': path.resolve(__dirname, '../packages/plugin-timeline/src/index.tsx'), | ||
| '@object-ui/plugin-view': path.resolve(__dirname, '../packages/plugin-view/src/index.tsx'), | ||
| }, | ||
| }, | ||
| }); | ||
| }, | ||
| }; | ||
| export default config; | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import type { Preview } from '@storybook/react-vite' | ||
| import '../packages/components/src/index.css'; | ||
| import { ComponentRegistry } from '@object-ui/core'; | ||
| import * as components from '../packages/components/src/index'; | ||
|
|
||
| // Register all base components for Storybook | ||
| Object.values(components); | ||
|
|
||
| // Import and register all plugin components for Storybook | ||
| // This ensures plugin components are available for the plugin stories | ||
| import '@object-ui/plugin-aggrid'; | ||
| import '@object-ui/plugin-calendar'; | ||
| import '@object-ui/plugin-charts'; | ||
| import '@object-ui/plugin-chatbot'; | ||
| import '@object-ui/plugin-dashboard'; | ||
| import '@object-ui/plugin-editor'; | ||
| import '@object-ui/plugin-form'; | ||
| import '@object-ui/plugin-gantt'; | ||
| import '@object-ui/plugin-grid'; | ||
| import '@object-ui/plugin-kanban'; | ||
| import '@object-ui/plugin-map'; | ||
| import '@object-ui/plugin-markdown'; | ||
| import '@object-ui/plugin-timeline'; | ||
| import '@object-ui/plugin-view'; | ||
|
|
||
| const preview: Preview = { | ||
| parameters: { | ||
| options: { | ||
| storySort: { | ||
| method: 'alphabetical', | ||
| order: [ | ||
| 'Introduction', | ||
| 'Guide', | ||
| 'Primitives', | ||
| 'Schema', | ||
| ['Actions', 'Inputs', 'Layout', 'Data Display', 'Navigation', 'Feedback', 'Plugins'] | ||
| ], | ||
| }, | ||
| }, | ||
| controls: { | ||
| matchers: { | ||
| color: /(background|color)$/i, | ||
| date: /Date$/i, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export default preview; |
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,7 +1,7 @@ | ||||||
| @import 'tailwindcss'; | ||||||
|
|
||||||
| /* Scan sources for Tailwind classes */ | ||||||
| @source './src/**/*.{ts,tsx}'; | ||||||
| @source '../src/**/*.{ts,tsx}'; | ||||||
|
||||||
| @source '../src/**/*.{ts,tsx}'; | |
| @source './**/*.{ts,tsx}'; |
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
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -8,7 +8,7 @@ | |||||||||
|
|
||||||||||
| import { ComponentRegistry } from '@object-ui/core'; | ||||||||||
| import type { ToggleSchema } from '@object-ui/types'; | ||||||||||
| import { Toggle, ToggleGroup, ToggleGroupItem } from '../../ui'; | ||||||||||
| import { Toggle } from '../../ui'; | ||||||||||
| import { renderChildren } from '../../lib/utils'; | ||||||||||
|
|
||||||||||
| ComponentRegistry.register('toggle', | ||||||||||
|
|
@@ -28,9 +28,9 @@ ComponentRegistry.register('toggle', | |||||||||
| inputs: [ | ||||||||||
| { name: 'label', type: 'string', label: 'Label' }, | ||||||||||
| { name: 'pressed', type: 'boolean', label: 'Pressed' }, | ||||||||||
| { name: 'variant', type: 'enum', enum: ['default', 'outline'], defaultValue: 'default', label: 'Variant' }, | ||||||||||
| { name: 'size', type: 'enum', enum: ['default', 'sm', 'lg'], defaultValue: 'default', label: 'Size' }, | ||||||||||
| { name: 'ariaLabel', type: 'string', label: 'Aria Label' } | ||||||||||
| { name: 'variant', type: 'enum', index: ['default', 'outline'], defaultValue: 'default', label: 'Variant' }, | ||||||||||
| { name: 'size', type: 'enum', index: ['default', 'sm', 'lg'], defaultValue: 'default', label: 'Size' }, | ||||||||||
|
Comment on lines
+31
to
+32
|
||||||||||
| { name: 'variant', type: 'enum', index: ['default', 'outline'], defaultValue: 'default', label: 'Variant' }, | |
| { name: 'size', type: 'enum', index: ['default', 'sm', 'lg'], defaultValue: 'default', label: 'Size' }, | |
| { name: 'variant', type: 'enum', enum: ['default', 'outline'], defaultValue: 'default', label: 'Variant' }, | |
| { name: 'size', type: 'enum', enum: ['default', 'sm', 'lg'], defaultValue: 'default', label: 'Size' }, |
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
According to Guideline #2 (Documentation Driven Development), any feature implemented or refactored must include corresponding documentation updates. This PR adds:
However, there are no documentation updates in content/docs/guide/ to explain:
Consider adding documentation in content/docs/guide/ or updating the relevant package README files to reflect the new Storybook setup and usage patterns.