Skip to content

Commit a938afd

Browse files
committed
update wording on prop, update to footer
1 parent 50e5e72 commit a938afd

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

packages/react-core/src/components/Page/Page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export interface PageProps extends React.HTMLProps<HTMLDivElement> {
118118
breadcrumbProps?: PageBreadcrumbProps;
119119
/** Enables children to fill the available vertical space. Child page sections or groups that should fill should be passed the isFilled property. */
120120
isContentFilled?: boolean;
121-
/** Flag indicating the page has non-PatternFly elements for header and footer and should be rendered plainly. Use PageHeader and PageFooter to wrap custom header and footer content to ensure the layout is maintained. */
121+
/** Flag indicating the page should render without the content area background and overflow scroll. */
122122
isPlain?: boolean;
123123
/** Content rendered inside the page footer */
124124
footer?: React.ReactNode;

packages/react-core/src/components/Page/PageFooter.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ import styles from '@patternfly/react-styles/css/components/Page/page';
22
import { css } from '@patternfly/react-styles';
33

44
export interface PageFooterProps extends React.HTMLProps<HTMLElement> {
5-
/** Content rendered inside the page header. This should be custom header content, rather than the PatternFly Masthead. */
5+
/** Content rendered inside the footer */
66
children?: React.ReactNode;
7-
/** Additional classes added to the page header */
7+
/** Additional classes added to the footer */
88
className?: string;
9-
/** Sets the base component to render. Defaults to header */
9+
/** Sets the base component to render. Defaults to footer */
1010
component?: keyof React.JSX.IntrinsicElements;
1111
}
1212

packages/react-core/src/components/Page/__tests__/PageFooter.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ test(`Renders with class ${styles.pageFooter} by default`, () => {
1212
expect(screen.getByText('Footer content')).toHaveClass(styles.pageFooter, { exact: true });
1313
});
1414

15-
test('Renders as a div by default', () => {
15+
test('Renders as a footer by default', () => {
1616
render(<PageFooter>Footer content</PageFooter>);
1717
expect(screen.getByText('Footer content').tagName).toBe('FOOTER');
1818
});

packages/react-core/src/components/Page/examples/Page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To use a page header instead of passing a [masthead](/components/masthead) direc
3939

4040
`<PageFooter>` can be passed to the `footer` property, and should be used to wrap custom footer content.
4141

42-
When using custom a `<PageHeader>` and `<PageFooter>`, the `isPlain` flag should be passed to `<Page>`. This will remove styling on the main container, the height constraints on the page wrapper (so it can grow beyond the viewport), and removes the scroll management from the content section so the window will be what scrolls.
42+
When using a custom `<PageHeader>` and `<PageFooter>`, the `isPlain` flag should be passed to `<Page>`. This will remove styling on the main container, the height constraints on the page wrapper (so it can grow beyond the viewport), and removes the scroll management from the content section so the window will be what scrolls.
4343

4444
```ts file="./PageHeaderAndFooterContent.tsx"
4545

0 commit comments

Comments
 (0)