Adds 'as' and 'href' to Button+IconButton prop docs #6361
Conversation
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the as and href props to both Button and IconButton components to address missing prop documentation. The changes ensure that developers have proper documentation for these existing props that allow buttons to be rendered as anchor elements.
- Adds
asprop documentation to IconButton showing it accepts React.ElementType with default value 'button' - Adds
hrefprop documentation to both Button and IconButton with clear usage constraints - Documents the relationship between
asandhrefprops with proper validation requirements
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/react/src/Button/IconButton.docs.json | Adds documentation for both as and href props |
| packages/react/src/Button/Button.docs.json | Adds documentation for href prop (as prop already existed) |
| { | ||
| "name": "as", | ||
| "type": "React.ElementType", | ||
| "defaultValue": "'button'" |
There was a problem hiding this comment.
Consider adding a description for the 'as' prop to explain its purpose, similar to how other props in the documentation include descriptions.
| "defaultValue": "'button'" | |
| "defaultValue": "'button'", | |
| "description": "Specifies the HTML element or custom component to render. For example, set `as` to 'a' to render an anchor tag instead of a button." |
Copilot uses AI. Check for mistakes.
size-limit report 📦
|
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Closes https://github.com/github/primer/issues/5469
Changelog
New
Changed
Removed
Rollout strategy
This is just a docs update - not actually a change to the package.
Testing & Reviewing
Merge checklist