Skip to content

Commit

Permalink
document "hideTitle" prop (#4826)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ktravers authored Aug 8, 2024
1 parent b85d505 commit c043cdc
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions packages/react/src/Banner/Banner.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
"type": "React.ReactNode",
"description": "Provide an optional description for the Banner. This should provide supplemental information about the Banner"
},
{
"name": "hideTitle",
"type": "boolean",
"description": "Whether to hide the title visually."
},
{
"name": "icon",
"type": "React.ReactNode",
Expand Down

0 comments on commit c043cdc

Please sign in to comment.