Skip to content

Commit fa457a0

Browse files
committed
Capitalizes Compass for consistency
1 parent 93020a1 commit fa457a0

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import compassBackgroundImageLight from '@patternfly/react-tokens/dist/esm/c_com
66
import compassBackgroundImageDark from '@patternfly/react-tokens/dist/esm/c_compass_BackgroundImage_dark';
77

88
export interface CompassProps extends React.HTMLProps<HTMLDivElement> {
9-
/** Additional classes added to the compass. */
9+
/** Additional classes added to the Compass. */
1010
className?: string;
1111
/** Content placed at the top of the layout */
1212
header?: React.ReactNode;
@@ -30,9 +30,9 @@ export interface CompassProps extends React.HTMLProps<HTMLDivElement> {
3030
drawerContent?: React.ReactNode;
3131
/** Additional props passed to the drawer */
3232
drawerProps?: DrawerProps;
33-
/** Light theme background image path of the compass */
33+
/** Light theme background image path of the Compass */
3434
backgroundSrcLight?: string;
35-
/** Dark theme background image path of the compass */
35+
/** Dark theme background image path of the Compass */
3636
backgroundSrcDark?: string;
3737
}
3838

packages/react-core/src/components/Compass/CompassContent.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import styles from '@patternfly/react-styles/css/components/Compass/compass';
33
import { css } from '@patternfly/react-styles';
44

55
export interface CompassContentProps extends React.HTMLProps<HTMLDivElement> {
6-
/** Content of the main compass area. Typically one or more CompassPanel components. */
6+
/** Content of the main Compass area. Typically one or more CompassPanel components. */
77
children: React.ReactNode;
88
/** Additional classes added to the CompassContent */
99
className?: string;

packages/react-core/src/components/Compass/CompassMainHeader.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import { CompassMainHeaderToolbar } from './CompassMainHeaderToolbar';
55
import styles from '@patternfly/react-styles/css/components/Compass/compass';
66
import { css } from '@patternfly/react-styles';
77

8-
/** The wrapper component for header content in the main compass area. When building out a custom implementation,
9-
* you should ensure any content within the main header is rendered inside a compass panel and main header content wrappers.
8+
/** The wrapper component for header content in the main Compass area. When building out a custom implementation,
9+
* you should ensure any content within the main header is rendered inside a Compass panel and main header content wrappers.
1010
*/
1111

1212
export interface CompassMainHeaderProps extends Omit<React.HTMLProps<HTMLDivElement>, 'title'> {
@@ -18,8 +18,8 @@ export interface CompassMainHeaderProps extends Omit<React.HTMLProps<HTMLDivElem
1818
title?: React.ReactNode;
1919
/** Styled toolbar. If title or toolbar is provided, the children will be ignored. */
2020
toolbar?: React.ReactNode;
21-
/** Additional props passed to the compass panel that wraps the main header content when using the title or toolbar props. When using the
22-
* children prop, you should pass your own compass panel.
21+
/** Additional props passed to the Compass panel that wraps the main header content when using the title or toolbar props. When using the
22+
* children prop, you should pass your own Compass panel.
2323
*/
2424
compassPanelProps?: Omit<CompassPanelProps, 'children'>;
2525
}

packages/react-core/src/components/Compass/CompassMainHeaderContent.tsx

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

4-
/** A wrapper component to be passed as custom content for the compass main header. This should also be wrapped
5-
* in a compass panel component.
4+
/** A wrapper component to be passed as custom content for the Compass main header. This should also be wrapped
5+
* in a Compass panel component.
66
*/
77

88
export interface CompassMainHeaderContentProps extends React.HTMLProps<HTMLDivElement> {

packages/react-core/src/components/Compass/CompassMainHeaderTitle.tsx

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

4-
/** A wrapper component for custom title content to be passed into a compass main header. This should also be wrapped
5-
* by a compass main header content component.
4+
/** A wrapper component for custom title content to be passed into a Compass main header. This should also be wrapped
5+
* by a Compass main header content component.
66
*/
77

88
export interface CompassMainHeaderTitleProps extends React.HTMLProps<HTMLDivElement> {

packages/react-core/src/components/Compass/CompassMainHeaderToolbar.tsx

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

4-
/** A wrapper component for custom toolbar content to be passed into a compass main header. This should also be wrapped
5-
* by a compass main header content component.
4+
/** A wrapper component for custom toolbar content to be passed into a Compass main header. This should also be wrapped
5+
* by a Compass main header content component.
66
*/
77

88
export interface CompassMainHeaderToolbarProps extends React.HTMLProps<HTMLDivElement> {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import './compass.css';
2828

2929
### Basic
3030

31-
In a basic compass layout, content can be passed to the following props to populate different areas of the page:
31+
In a basic Compass layout, content can be passed to the following props to populate different areas of the page:
3232

3333
- `header`: Content rendered at the top of the page, typically including a `<CompassHeader>` component that divides the header into 3 areas, with a logo or brand, middle navigation, and profile.
3434
- `sidebarStart`: Content rendered at the horizontal start of the page (by default, the left side).
@@ -52,7 +52,7 @@ When `footer` is used, its content will fill the width of the screen. By default
5252

5353
## Composable structure
5454

55-
When building a more custom implementation with compass components, there are some intended or expected structures that must remain present.
55+
When building a more custom implementation with Compass components, there are some intended or expected structures that must remain present.
5656

5757
### CompassMainHeader structure
5858

0 commit comments

Comments
 (0)