Skip to content

Conversation

@twestos
Copy link
Contributor

@twestos twestos commented May 15, 2025

This pull request introduces Storybook integration into the admin-ui-components package, along with new components and their associated stories and styles. It also updates dependencies and configurations to support Storybook and improve development workflows.

Storybook Integration and Configuration:

  • Added Storybook configuration files (main.ts, preview.ts, manager.ts, theme.ts) to enable Storybook in the admin-ui-components package. These include custom theming and essential addons for improved developer experience. [1] [2] [3] [4]
  • Updated .eslintrc.cjs to include the Storybook plugin for linting Storybook-specific files.
  • Added storybook and build-storybook scripts to package.json for running and building Storybook, respectively.
  • Updated package.json dependencies and devDependencies to include Storybook-related packages and other required libraries. [1] [2] [3]

Component Stories and Documentation:

  • Added MDX and story files for Alert, Button, and Card components to document their usage, properties, and examples in Storybook. These include interactive controls and guidelines for accessibility. [1] [2] [3] [4] [5] [6]

New Card Component:

  • Implemented a Card component with support for title, description, and customizable content. Added styles for consistent visual appearance. [1] [2] [3]

Miscellaneous:

  • Updated .gitignore to exclude *storybook.log files generated during Storybook usage.
  • Added a global CSS file (main.css) for consistent styling across Storybook stories.

@twestos twestos requested a review from Copilot May 15, 2025 07:26
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request integrates Storybook into the admin-ui-components package and introduces new component stories and configurations to enhance development workflows. Key changes include:

  • Adding Storybook configuration files (.storybook/main.ts, preview.ts, manager.ts, theme.ts) and updating ESLint to support Storybook.
  • Creating MDX and Story files for components including ComboBox, Checkbox, Card, Button, and Alert.
  • Updating package.json with new Storybook-related scripts and dependencies.

Reviewed Changes

Copilot reviewed 111 out of 111 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/packages/admin-ui-components/src/combo-box/combo-box.mdx Added MDX documentation and example usage for ComboBox.
src/packages/admin-ui-components/src/checkbox/checkbox.stories.tsx Introduced multiple Storybook stories for the Checkbox component.
src/packages/admin-ui-components/src/checkbox/checkbox.mdx Provided MDX documentation for the Checkbox component.
src/packages/admin-ui-components/src/card/styles.module.css Defined styling for the new Card component.
src/packages/admin-ui-components/src/card/index.ts Re-exported the Card component.
src/packages/admin-ui-components/src/card/component.tsx Implemented the Card component with title, description, and children.
src/packages/admin-ui-components/src/card/card.stories.tsx Added several Storybook stories demonstrating various Card component states.
src/packages/admin-ui-components/src/card/card.mdx Created MDX documentation for the Card component.
src/packages/admin-ui-components/src/button/button.stories.tsx Provided Storybook stories for the Button component.
src/packages/admin-ui-components/src/button/button.mdx Added MDX documentation and examples for the Button component.
src/packages/admin-ui-components/src/alert/alert.stories.ts Introduced Storybook stories for the Alert component.
src/packages/admin-ui-components/src/alert/alert.mdx Created MDX documentation and usage guidelines for the Alert component.
src/packages/admin-ui-components/package.json Updated scripts and dependencies for Storybook integration.
src/packages/admin-ui-components/.storybook/theme.ts Configured a custom dark theme for Storybook.
src/packages/admin-ui-components/.storybook/preview.ts Set global preview parameters and imported main CSS for Storybook.
src/packages/admin-ui-components/.storybook/manager.ts Configured the Storybook manager to use the custom theme.
src/packages/admin-ui-components/.storybook/main.ts Defined Storybook configuration with story and addon paths.
src/packages/admin-ui-components/.storybook/main.css Added global CSS for consistent Storybook styling.
src/packages/admin-ui-components/.eslintrc.cjs Extended ESLint configuration to include the Storybook plugin.
src/.gitignore Updated to exclude Storybook log files.

@twestos twestos marked this pull request as ready for review May 19, 2025 04:17
@twestos twestos requested a review from thekevinbrown May 19, 2025 04:17
Copy link
Member

@thekevinbrown thekevinbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing we definitely need to align on is the change to the onChange handler, but other than that this is looking great!

@netlify
Copy link

netlify bot commented May 19, 2025

Deploy Preview for graphweaver-storybook-staging failed. Why did it fail? →

Name Link
🔨 Latest commit 0de2c5b
🔍 Latest deploy log https://app.netlify.com/projects/graphweaver-storybook-staging/deploys/682bdc8db4776b000809d444

@netlify
Copy link

netlify bot commented May 20, 2025

Deploy Preview for graphweaver-storybook-staging ready!

Name Link
🔨 Latest commit 0d39706
🔍 Latest deploy log https://app.netlify.com/projects/graphweaver-storybook-staging/deploys/68428b687570110008da0a76
😎 Deploy Preview https://deploy-preview-1800--graphweaver-storybook-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@twestos twestos requested a review from thekevinbrown June 6, 2025 06:00
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 6, 2025

@twestos twestos dismissed thekevinbrown’s stale review June 6, 2025 06:46

Have changes, this prompt for requested changes doesn't seem to be going away. Either that or I'm a github boomer.

@twestos twestos merged commit 16bb0d4 into main Jun 6, 2025
21 checks passed
@twestos twestos deleted the feature/docs-website branch June 6, 2025 06:59
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.

3 participants