-
Notifications
You must be signed in to change notification settings - Fork 373
Adds CardDescription component #12105
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.
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
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
3c8460f
feat: Added card description component to card.
dlabaj e8fe86f
Added tests for card description.
dlabaj 66f6aa9
Updated with core changes.
dlabaj aab74f2
Fixed missing export for CardSubtitle.
dlabaj d741b63
Updated yarn.lock file.
dlabaj 4502646
Fixed card demo.
dlabaj ec12c9d
Updated with review comments.
dlabaj 590d1d9
Added snapshot.
dlabaj 3be9e82
Updated to have a react node instead of a card title.
dlabaj ab025fb
Updated to have a react node instead of a card title.
dlabaj 125d8af
Updated to have a react node instead of a card title.
dlabaj 2df4228
Removed Card class test.
dlabaj ffce543
Added isBeta flag.
dlabaj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { css } from '@patternfly/react-styles'; | ||
| import styles from '@patternfly/react-styles/css/components/Card/card'; | ||
|
|
||
| export interface CardSubtitleProps { | ||
| /** Content rendered inside the description. */ | ||
| children?: React.ReactNode; | ||
| /** Id of the description. */ | ||
| id?: string; | ||
| } | ||
|
|
||
| export const CardSubtitle: React.FunctionComponent<CardSubtitleProps> = ({ | ||
| children = null, | ||
| id = '', | ||
| ...props | ||
| }: CardSubtitleProps) => ( | ||
| <div {...props} id={id} className={css(styles.cardSubtitle)}> | ||
| {children} | ||
| </div> | ||
| ); | ||
| CardSubtitle.displayName = 'CardSubtitle'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
packages/react-core/src/components/Card/__tests__/CardSubtitle.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import { render, screen } from '@testing-library/react'; | ||
| import { CardSubtitle } from '../CardSubtitle'; | ||
|
|
||
| describe('CardSubtitle', () => { | ||
| test('renders with PatternFly Core styles', () => { | ||
| const { asFragment } = render(<CardSubtitle>text</CardSubtitle>); | ||
| expect(asFragment()).toMatchSnapshot(); | ||
| }); | ||
|
|
||
| test('extra props are spread to the root element', () => { | ||
| const testId = 'card-subtitle'; | ||
|
|
||
| render(<CardSubtitle data-testid={testId} />); | ||
| expect(screen.getByTestId(testId)).toBeInTheDocument(); | ||
| }); | ||
| }); |
12 changes: 12 additions & 0 deletions
12
packages/react-core/src/components/Card/__tests__/__snapshots__/CardSubtitle.test.tsx.snap
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`CardSubtitle renders with PatternFly Core styles 1`] = ` | ||
| <DocumentFragment> | ||
| <div | ||
| class="pf-v6-c-card__subtitle" | ||
| id="" | ||
| > | ||
| text | ||
| </div> | ||
| </DocumentFragment> | ||
| `; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
packages/react-core/src/components/Card/examples/CardSubtitle.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { Card, CardTitle, CardBody, CardFooter } from '@patternfly/react-core'; | ||
|
|
||
| export const CardSubtitle: React.FunctionComponent = () => ( | ||
| <Card ouiaId="CardSubtitle"> | ||
| <CardTitle subtitle="Subtitle">Title</CardTitle> | ||
| <CardBody>Body</CardBody> | ||
| <CardFooter>Footer</CardFooter> | ||
| </Card> | ||
| ); |
107 changes: 107 additions & 0 deletions
107
packages/react-core/src/components/Card/examples/CardSubtitleActions.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import { useState } from 'react'; | ||
| import { | ||
| Brand, | ||
| Card, | ||
| CardHeader, | ||
| CardTitle, | ||
| CardBody, | ||
| CardFooter, | ||
| Checkbox, | ||
| Dropdown, | ||
| DropdownList, | ||
| DropdownItem, | ||
| MenuToggle, | ||
| MenuToggleElement, | ||
| Divider | ||
| } from '@patternfly/react-core'; | ||
| import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon'; | ||
| import pfLogo from '../../assets/PF-HorizontalLogo-Color.svg'; | ||
|
|
||
| export const CardWithImageAndActions: React.FunctionComponent = () => { | ||
| const [isOpen, setIsOpen] = useState<boolean>(false); | ||
| const [isChecked, setIsChecked] = useState<boolean>(false); | ||
| const [hasNoOffset, setHasNoOffset] = useState<boolean>(false); | ||
|
|
||
| const onSelect = () => { | ||
| setIsOpen(!isOpen); | ||
| }; | ||
| const onClick = (checked: boolean) => { | ||
| setIsChecked(checked); | ||
| }; | ||
| const toggleOffset = (checked: boolean) => { | ||
| setHasNoOffset(checked); | ||
| }; | ||
|
|
||
| const dropdownItems = ( | ||
| <> | ||
| <DropdownItem key="action">Action</DropdownItem> | ||
| {/* Prevent default onClick functionality for example purposes */} | ||
| <DropdownItem key="link" to="#" onClick={(event: any) => event.preventDefault()}> | ||
| Link | ||
| </DropdownItem> | ||
| <DropdownItem key="disabled action" isDisabled> | ||
| Disabled Action | ||
| </DropdownItem> | ||
| <DropdownItem key="disabled link" isDisabled to="#" onClick={(event: any) => event.preventDefault()}> | ||
| Disabled Link | ||
| </DropdownItem> | ||
| <Divider component="li" key="separator" /> | ||
| <DropdownItem key="separated action">Separated Action</DropdownItem> | ||
| <DropdownItem key="separated link" to="#" onClick={(event: any) => event.preventDefault()}> | ||
| Separated Link | ||
| </DropdownItem> | ||
| </> | ||
| ); | ||
|
|
||
| const headerActions = ( | ||
| <> | ||
| <Dropdown | ||
| onSelect={onSelect} | ||
| toggle={(toggleRef: React.Ref<MenuToggleElement>) => ( | ||
| <MenuToggle | ||
| ref={toggleRef} | ||
| isExpanded={isOpen} | ||
| onClick={() => setIsOpen(!isOpen)} | ||
| variant="plain" | ||
| aria-label="Card header images and actions example kebab toggle" | ||
| icon={<EllipsisVIcon />} | ||
| /> | ||
| )} | ||
| isOpen={isOpen} | ||
| onOpenChange={(isOpen: boolean) => setIsOpen(isOpen)} | ||
| > | ||
| <DropdownList>{dropdownItems}</DropdownList> | ||
| </Dropdown> | ||
| <Checkbox | ||
| isChecked={isChecked} | ||
| onChange={(_event, checked) => onClick(checked)} | ||
| aria-label="card checkbox example" | ||
| id="check-1" | ||
| name="check1" | ||
| /> | ||
| </> | ||
| ); | ||
|
|
||
| return ( | ||
| <> | ||
| <Checkbox | ||
| label="actions hasNoOffset" | ||
| isChecked={hasNoOffset} | ||
| onChange={(_event, checked) => toggleOffset(checked)} | ||
| aria-label="remove actions offset" | ||
| id="toggle-actions-offset" | ||
| name="toggle-actions-offset" | ||
| /> | ||
| <div style={{ marginTop: '15px' }}> | ||
| <Card> | ||
| <CardHeader actions={{ actions: headerActions, hasNoOffset }}> | ||
| <Brand src={pfLogo} alt="PatternFly logo" style={{ width: '300px' }} /> | ||
| </CardHeader> | ||
| <CardTitle subtitle="Subtitle">Title</CardTitle> | ||
| <CardBody>Body</CardBody> | ||
| <CardFooter>Footer</CardFooter> | ||
| </Card> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mcoker Added subtitle and actions that is similar to what is in core.