Skip to content

Commit

Permalink
Button: Restore descriptions for isPrimary, isSecondary, isTertiary, …
Browse files Browse the repository at this point in the history
…isLink but mark them as deprecated (#37690)
  • Loading branch information
BreadGuy007 committed Dec 20, 2023
1 parent a6125bc commit cbba8aa
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions packages/components/src/button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,14 @@ Renders a red text-based button style to indicate destructive behavior.

- Required: No

#### `isLink`: `boolean`

Deprecated: Renders a button with an anchor style.
Use `variant` prop with `link` value instead.

- Required: No
- Default: `false`

#### `isPressed`: `boolean`

Renders a pressed button style.
Expand All @@ -184,6 +192,22 @@ If the native `aria-pressed` attribute is also set, it will take precedence.

- Required: No

#### `isPrimary`: `boolean`

Deprecated: Renders a primary button style.
Use `variant` prop with `primary` value instead.

- Required: No
- Default: `false`

#### `isSecondary`: `boolean`

Deprecated: Renders a default button style.
Use `variant` prop with `secondary` value instead.

- Required: No
- Default: `false`

#### `isSmall`: `boolean`

Decreases the size of the button.
Expand All @@ -192,6 +216,14 @@ Deprecated in favor of the `size` prop. If both props are defined, the `size` pr

- Required: No

#### `isTertiary`: `boolean`

Deprecated: Renders a text-based button style.
Use `variant` prop with `tertiary` value instead.

- Required: No
- Default: `false`

#### `label`: `string`

Sets the `aria-label` of the component, if none is provided. Sets the Tooltip content if `showTooltip` is provided.
Expand Down

0 comments on commit cbba8aa

Please sign in to comment.