Skip to content

feat(Modal): move description to separate component #3897

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
evwilkin merged 2 commits into from
Mar 10, 2020
Merged

feat(Modal): move description to separate component #3897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60dba43
feat(Modal): move description to separate component
kmcfaul Mar 10, 2020
0e5b1c8
feat(Modal): fix property descriptions
kmcfaul Mar 10, 2020
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
23 changes: 23 additions & 0 deletions packages/react-core/src/components/Modal/ModalBoxDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as React from 'react';
import { css } from '@patternfly/react-styles';
import styles from '@patternfly/react-styles/css/components/ModalBox/modal-box';

export interface ModalBoxDescriptionProps {
/** Content rendered inside the description */
children?: React.ReactNode;
/** Additional classes added to the description */
className?: string;
/** ID of the description */
id?: string;
}

export const ModalBoxDescription: React.FunctionComponent<ModalBoxDescriptionProps> = ({
children = null,
className = '',
id = '',
...props
}: ModalBoxDescriptionProps) => (
<div {...props} id={id} className={css(styles.modalBoxDescription, className)}>
{children}
</div>
);
8 changes: 2 additions & 6 deletions packages/react-core/src/components/Modal/ModalContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ const FocusTrap: any = require('focus-trap-react');

import styles from '@patternfly/react-styles/css/layouts/Bullseye/bullseye';
import titleStyles from '@patternfly/react-styles/css/components/Title/title';
import modalStyles from '@patternfly/react-styles/css/components/ModalBox/modal-box';
import { css } from '@patternfly/react-styles';

import { Backdrop } from '../Backdrop/Backdrop';
Expand All @@ -16,6 +15,7 @@ import { ModalBoxHeader } from './ModalBoxHeader';
import { ModalBoxCloseButton } from './ModalBoxCloseButton';
import { ModalBox } from './ModalBox';
import { ModalBoxFooter } from './ModalBoxFooter';
import { ModalBoxDescription } from './ModalBoxDescription';

export interface ModalContentProps {
/** Content rendered inside the Modal. */
Expand Down Expand Up @@ -104,11 +104,7 @@ export const ModalContent: React.FunctionComponent<ModalContentProps> = ({
>
{showClose && <ModalBoxCloseButton onClose={onClose} />}
{modalBoxHeader}
{description && (
<div className={css(modalStyles.modalBoxDescription)} id={id}>
{description}
</div>
)}
{description && <ModalBoxDescription id={id}>{description}</ModalBoxDescription>}
<ModalBoxBody {...props} {...(!description && { id })}>
{children}
</ModalBoxBody>
Expand Down
5 changes: 2 additions & 3 deletions packages/react-core/src/components/Modal/__tests__/__snapshots__/ModalContent.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,11 @@ exports[`Modal Content Test description 1`] = `
Test Modal Content title

</ModalBoxHeader>
<div
className="pf-c-modal-box__description"
<ModalBoxDescription
id="id"
>
This is a test description.
</div>
</ModalBoxDescription>
<ModalBoxBody>
This is a ModalBox header
</ModalBoxBody>
Expand Down