Skip to content

Commit 67425a1

Browse files
committed
Button: update jsdoc
1 parent 7e7c1ab commit 67425a1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

client/common/Button.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,10 @@ const StyledInlineButton = styled.button`
174174
`;
175175

176176
/**
177-
* A Button performs an primary action
177+
* Renders a component with a button appearance, but which is:
178+
* - External anchor link if passed a `href`
179+
* - Internal React Router link if passed a `to`
180+
* - Default: Native Button
178181
*/
179182
export const Button = ({
180183
children = null,

0 commit comments

Comments
 (0)