Skip to content

fix(react-card): improve description for card props #26614

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

Merged
marcosmoura merged 5 commits into from
Feb 6, 2023
Merged

fix(react-card): improve description for card props #26614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
221f69e
fix(react-card): improve description for card props
marcosmoura Feb 2, 2023
b99aa0a
fix: add missing changefile
marcosmoura Feb 2, 2023
24a0eed
fix(react-card): add all selectable props to description
marcosmoura Feb 2, 2023
a0f66d9
Merge branch 'master' into docs/improve-card-api-description
marcosmoura Feb 6, 2023
97cdbc6
fix: update change file with correct prefix
marcosmoura Feb 6, 2023
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-card-71e624d4-844c-4bc2-a76e-0b4a2197b530.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "docs: improve API documentation of card props",
"packageName": "@fluentui/react-card",
"email": "[email protected]",
"dependentChangeType": "patch"
}
5 changes: 3 additions & 2 deletions packages/react-components/react-card/src/components/Card/Card.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ 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
* `selected`, `defaultSelected`, and `onSelectionChange` props
*/
floatingAction?: Slot<'div'>;

Expand Down Expand Up @@ -71,7 +72,7 @@ export type CardProps = ComponentProps<CardSlots> & {
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.
Expand Down