Skip to content

Commit 37e7498

Browse files
hectahertzCopilotjoshblack
authored
Fix buttonbase props documentation (#5959)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Josh Black <[email protected]>
1 parent c1ea6cf commit 37e7498

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

packages/react/src/Button/types.ts

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,28 @@ type ButtonA11yProps =
2323

2424
export type ButtonBaseProps = {
2525
/**
26-
* Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'
26+
* Determines the styles on a button, one of 'default' | 'primary' | 'invisible' | 'danger' | 'link'
2727
*/
2828
variant?: VariantType
2929
/**
30-
* Size of button and fontSize of text in button
30+
* Size of the button and fontSize of the text in the button
3131
*/
3232
size?: Size
3333
/**
34-
* Avoid disabling buttons because it will make them inaccessible to users who rely on keyboard navigation. that are disabled can not be clicked, selected, or navigated through.
34+
* Disables a button. Avoid disabling buttons because it will make them inaccessible to users
35+
* who rely on keyboard navigation. Buttons that are disabled cannot be clicked, selected, or navigated through.
3536
*/
3637
disabled?: boolean
3738
/**
38-
* Allow button width to fill its container.
39+
* Allow a button to fill its container horizontally
3940
*/
4041
block?: boolean
4142
/**
42-
* When true, the button is in a loading state.
43+
* Specify whether the button is in a loading state
4344
*/
4445
loading?: boolean
4546
/**
46-
* The content to announce to screen readers when loading.
47+
* The content to announce to screen readers when loading
4748
*/
4849
loadingAnnouncement?: string
4950
/*
@@ -52,7 +53,7 @@ export type ButtonBaseProps = {
5253
*/
5354
inactive?: boolean
5455
/**
55-
* Whether the button label should wrap to multiple lines of it is longer than the button width.
56+
* Whether the button label should wrap to multiple lines if it is longer than the button width
5657
*/
5758
labelWrap?: boolean
5859
} & SxProp &
@@ -80,7 +81,8 @@ export type ButtonProps = {
8081
trailingVisual?: React.ElementType | React.ReactElement | null
8182

8283
/**
83-
* Trailing action appears to the right of the trailing visual and is always locked to the end
84+
* Trailing action which comes after the trailing visual and is always the last element
85+
* in the button
8486
*/
8587
trailingAction?: React.ElementType | null
8688

0 commit comments

Comments
 (0)