Skip to content

Conversation

@ktravers
Copy link
Contributor

@ktravers ktravers commented Aug 7, 2024

The Banner "overview" docs mention the ability to hide the title visibly (see https://primer.style/components/banner#title), but how to actually implement this in the React component isn't documented. This change adds the correct prop, hideTitle, to the documented props for the Banner React component.

Changelog

Adds documentation for Banner.hideTitle prop.

New

Documentation for Banner.hideTitle prop.

Changed

React Banner component documentation.

Removed

Nothing.

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

N/A

Merge checklist

The Banner "overview" docs mention the ability to hide the title visibly (see https://primer.style/components/banner#title), but how to actually implement this in the React component isn't documented. This change adds the correct prop, `hideTitle`, to the documented props for Banner.
@ktravers ktravers self-assigned this Aug 7, 2024
@ktravers ktravers requested a review from a team as a code owner August 7, 2024 20:45
@ktravers ktravers requested a review from mperrotti August 7, 2024 20:45
@changeset-bot
Copy link

changeset-bot bot commented Aug 7, 2024

⚠️ No Changeset found

Latest commit: 5ed3f42

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 7, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 96 KB (0%)
packages/react/dist/browser.umd.js 96.31 KB (0%)

@joshblack joshblack added this pull request to the merge queue Aug 8, 2024
@joshblack
Copy link
Member

Thanks for this!

Merged via the queue into main with commit c043cdc Aug 8, 2024
@joshblack joshblack deleted the ktravers-patch-1 branch August 8, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changeset This change does not need a changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants