From 221f69eb03af0661f2699e34e3335b76bb56c70b Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Thu, 2 Feb 2023 20:39:51 +0100 Subject: [PATCH 1/4] fix(react-card): improve description for card props --- .../react-card/src/components/Card/Card.types.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/react-components/react-card/src/components/Card/Card.types.ts b/packages/react-components/react-card/src/components/Card/Card.types.ts index c96c986536b42..25861972115b1 100644 --- a/packages/react-components/react-card/src/components/Card/Card.types.ts +++ b/packages/react-components/react-card/src/components/Card/Card.types.ts @@ -37,7 +37,7 @@ export type CardSlots = { root: Slot<'div'>; /** - * Select element represents a checkbox. + * Floating action that can be rendered on the top-right of a card. Often used together with `selectable` prop. */ floatingAction?: Slot<'div'>; @@ -71,7 +71,7 @@ export type CardProps = ComponentProps & { appearance?: 'filled' | 'filled-alternative' | 'outline' | 'subtle'; /** - * Sets the focus behavior for the card. If `true`, the card will use the `noTab` focus behavior. + * Sets the focus behavior for the card. * * `off` * The card will not focusable. From b99aa0a2400d7cb292348a1ec1e23f204ab9ed01 Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Thu, 2 Feb 2023 20:41:29 +0100 Subject: [PATCH 2/4] fix: add missing changefile --- ...ui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json diff --git a/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json b/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json new file mode 100644 index 0000000000000..40de4742027d0 --- /dev/null +++ b/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json @@ -0,0 +1,7 @@ +{ + "type": "prerelease", + "comment": "fix: improve API documentation of card props", + "packageName": "@fluentui/react-card", + "email": "marcosvmmoura@gmail.com", + "dependentChangeType": "patch" +} From 24a0eed3a8609463b0f6aa39ff695a8310aa95d5 Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Thu, 2 Feb 2023 20:43:23 +0100 Subject: [PATCH 3/4] fix(react-card): add all selectable props to description --- .../react-card/src/components/Card/Card.types.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/react-components/react-card/src/components/Card/Card.types.ts b/packages/react-components/react-card/src/components/Card/Card.types.ts index 25861972115b1..18ee8b4eae446 100644 --- a/packages/react-components/react-card/src/components/Card/Card.types.ts +++ b/packages/react-components/react-card/src/components/Card/Card.types.ts @@ -37,7 +37,8 @@ export type CardSlots = { root: Slot<'div'>; /** - * Floating action that can be rendered on the top-right of a card. Often used together with `selectable` prop. + * Floating action that can be rendered on the top-right of a card. Often used together with + * `selected`, `defaultSelected`, and `onSelectionChange` props */ floatingAction?: Slot<'div'>; From 97cdbc68470cec5f30fd897497536e23c32d5d45 Mon Sep 17 00:00:00 2001 From: Marcos Moura Date: Mon, 6 Feb 2023 14:45:07 +0100 Subject: [PATCH 4/4] fix: update change file with correct prefix Co-authored-by: Martin Hochel --- ...luentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json b/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json index 40de4742027d0..da768793c26b7 100644 --- a/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json +++ b/change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json @@ -1,6 +1,6 @@ { "type": "prerelease", - "comment": "fix: improve API documentation of card props", + "comment": "docs: improve API documentation of card props", "packageName": "@fluentui/react-card", "email": "marcosvmmoura@gmail.com", "dependentChangeType": "patch"