Skip to content

Conversation

@francinelucca
Copy link
Member

Closes https://github.com/github/primer/issues/6085

Changelog

New

  • "With Description" NavList story
  • export ActionList.Description as a NavList subcomponent

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

@francinelucca francinelucca requested a review from a team as a code owner November 13, 2025 19:34
@changeset-bot
Copy link

changeset-bot bot commented Nov 13, 2025

🦋 Changeset detected

Latest commit: d81a127

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the staff Author is a staff member label Nov 13, 2025
@github-actions
Copy link
Contributor

👋 Hi, this pull request contains changes to the source code that github/github-ui depends on. If you are GitHub staff, test these changes with github/github-ui using the integration workflow. Or, apply the integration-tests: skipped manually label to skip these checks.

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Nov 13, 2025
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 PR adds support for inline and block descriptions in NavList by exporting ActionList.Description as a NavList subcomponent. This enables NavList items to display additional descriptive text in two variants: inline (beside primary text) or block (below primary text).

  • Exported ActionList.Description as NavList.Description
  • Added new "With Description" story demonstrating both inline and block variants
  • Documented the Description component with its props in the docs.json file

Reviewed Changes

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

Show a summary per file
File Description
packages/react/src/NavList/NavList.tsx Exports ActionList.Description as NavList.Description subcomponent
packages/react/src/NavList/NavList.features.stories.tsx Adds comprehensive story showcasing inline and block description variants
packages/react/src/NavList/NavList.docs.json Documents NavList.Description props and adds story reference
e2e/components/NavList.test.ts Adds e2e test entry for the new description feature
.changeset/happy-clocks-cover.md Documents the feature addition as a minor version change

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions bot requested a deployment to storybook-preview-7194 November 13, 2025 19:39 Abandoned
@francinelucca francinelucca added the update snapshots 🤖 Command that updates VRT snapshots on the pull request label Nov 13, 2025
@github-actions github-actions bot temporarily deployed to storybook-preview-7194 November 13, 2025 19:50 Inactive
@primer primer bot requested a review from a team as a code owner November 13, 2025 19:55
@primer primer bot requested a review from langermank November 13, 2025 19:55
@github-actions github-actions bot removed the update snapshots 🤖 Command that updates VRT snapshots on the pull request label Nov 13, 2025
Copy link
Contributor

@liuliu-dev liuliu-dev left a comment

Choose a reason for hiding this comment

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

@primer-integration
Copy link

👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/6883

@github-actions github-actions bot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Nov 14, 2025
@primer-integration
Copy link

🟢 ci completed with status success.

@francinelucca francinelucca added this pull request to the merge queue Nov 14, 2025
Merged via the queue into main with commit 32cdcfc Nov 14, 2025
51 checks passed
@francinelucca francinelucca deleted the feat/add-description-support-to-navlist branch November 14, 2025 03:08
@primer primer bot mentioned this pull request Nov 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants