Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(button): update types hasIconOnly & kind !== danger #17272

Merged
merged 4 commits into from
Sep 12, 2024
Merged

fix(button): update types hasIconOnly & kind !== danger #17272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
860da92
fix(button): update types hasIconOnly & kind !== danger
ariellalgilmore Aug 26, 2024
eea0399
Merge branch 'main' into fix/button-conditional-kind-hasicononly-types
ariellalgilmore Aug 26, 2024
e05f54a
Merge branch 'main' into fix/button-conditional-kind-hasicononly-types
tay1orjones Sep 11, 2024
02e9df4
Merge branch 'main' into fix/button-conditional-kind-hasicononly-types
ariellalgilmore Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,21 +420,7 @@ Map {
"isSelected": Object {
"type": "bool",
},
"kind": Object {
"args": Array [
Array [
"primary",
"secondary",
"danger",
"ghost",
"danger--primary",
"danger--ghost",
"danger--tertiary",
"tertiary",
],
],
"type": "oneOf",
},
"kind": [Function],
"onBlur": Object {
"type": "func",
},
Expand Down
26 changes: 22 additions & 4 deletions packages/react/src/components/Button/Button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import PropTypes from 'prop-types';
import React, { useRef } from 'react';
import { IconButton, IconButtonKind } from '../IconButton';
import { IconButton, IconButtonKind, IconButtonKinds } from '../IconButton';
import { composeEventHandlers } from '../../tools/events';
import { PolymorphicProps } from '../../types/common';
import { PopoverAlignment } from '../Popover';
Expand Down Expand Up @@ -74,7 +74,9 @@
/**
* Specify the kind of Button you want to create
*/
kind?: ButtonKind;
kind?: ButtonBaseProps['hasIconOnly'] extends true
? IconButtonKind
: ButtonKind;

/**
* Optional prop to allow overriding the icon rendering.
Expand Down Expand Up @@ -266,8 +268,24 @@
/**
* Specify the kind of Button you want to create
*/
// TODO: this should be either ButtonKinds or IconButtonKinds based on the value of "hasIconOnly"
kind: PropTypes.oneOf(ButtonKinds),
kind: (props, propName, componentName) => {
const { hasIconOnly } = props;
const validKinds = hasIconOnly ? IconButtonKinds : ButtonKinds;

if (props[propName] === undefined) {
return null;
}

if (!validKinds.includes(props[propName])) {
return new Error(

Check warning on line 280 in packages/react/src/components/Button/Button.tsx

View check run for this annotation

Codecov / codecov/patch

packages/react/src/components/Button/Button.tsx#L280 

Added line #L280 was not covered by tests
`Invalid prop \`${propName}\` supplied to \`${componentName}\`. Expected one of ${validKinds.join(
', '
)}.`
);
}

return null;
},

/**
* Provide an optional function to be called when the button element
Expand Down
Loading