Skip to content

chore(pageheader): organize stories in storybook and add documentation in overview #19520

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

Conversation

annawen1
Copy link
Member

@annawen1 annawen1 commented May 29, 2025

Closes #19493

This PR exposes the PageHeader stories as experimental under the "Patterns" section of Storybook and adds technical documentation

Changelog

New

  • added some controls to the Default story

Changed

  • change the pageActions prop name in PageHeader.ContentPageActions to actions to make it less repetitive
  • use justify-content: flex-end as justify-content: end has been deprecated

Removed

  • remove unused components and imports
  • remove the Content, BreadcrumbBar, and TabBar stories in favor of variations of the PageHeader with some/all of zones together

Testing / Reviewing

Review the stories and let me know if I should remove/add any stories or controls

Review the documentation in the Overview section.

PR Checklist

As the author of this PR, before marking ready for review, confirm you:

  • Reviewed every line of the diff
  • Updated documentation and storybook examples
  • [ ] Wrote passing tests that cover this change
  • [ ] Addressed any impact on accessibility (a11y)
  • [ ] Tested for cross-browser consistency
  • Validated that this code is ready for review and status checks should pass

More details can be found in the pull request guide

This comment was marked as off-topic.

Copy link

netlify bot commented May 29, 2025

Deploy Preview for v11-carbon-react ready!

Name Link
🔨 Latest commit d7074b3
🔍 Latest deploy log https://app.netlify.com/projects/v11-carbon-react/deploys/683a0e829867e90008341501
😎 Deploy Preview https://deploy-preview-19520--v11-carbon-react.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.

Copy link

codecov bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.57%. Comparing base (f0c53fb) to head (d7074b3).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19520      +/-   ##
==========================================
+ Coverage   84.48%   84.57%   +0.09%     
==========================================
  Files         373      373              
  Lines       14645    14675      +30     
  Branches     4840     4804      -36     
==========================================
+ Hits        12373    12412      +39     
+ Misses       2125     2116       -9     
  Partials      147      147              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@annawen1 annawen1 changed the title Chore/pageheader storybook chore(pageheader): organize stories in storybook and add documentation in overview May 29, 2025
@annawen1 annawen1 marked this pull request as ready for review May 29, 2025 20:28
@annawen1 annawen1 requested review from a team as code owners May 29, 2025 20:28
Copy link
Member

@ariellalgilmore ariellalgilmore left a comment

Choose a reason for hiding this comment

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

LGTM!

@annawen1 annawen1 requested a review from a team as a code owner May 30, 2025 16:22
@annawen1 annawen1 requested a review from kennylam May 30, 2025 16:22
Copy link
Member

@kingtraceyj kingtraceyj left a comment

Choose a reason for hiding this comment

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

looks good! 💥

@kennylam kennylam added this pull request to the merge queue May 30, 2025
Merged via the queue into carbon-design-system:main with commit 9fff69c May 30, 2025
37 checks passed
@riddhybansal
Copy link
Contributor

Hey In overview page I can see undefined here in component api
image

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.

Pageheader: Organize stories in storybook and add documentation
5 participants