Skip to content

feat(misc): Replace Text, TextContent, TextList and TextListItem with Content - PART 2 #10643

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
wise-king-sullyman merged 18 commits into from
Jul 22, 2024
Merged

feat(misc): Replace Text, TextContent, TextList and TextListItem with Content - PART 2 #10643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c676e2f
feat(Text): move to Content folder
adamviktora Jun 13, 2024
8c22024
refactor(Text examples): update names to Content
adamviktora Jun 13, 2024
558d587
docs(Text): fix link
adamviktora Jun 20, 2024
dc6c42d
feat(Text): rename component to Content
adamviktora Jun 20, 2024
86a3771
feat(misc): replace Text, TextContent, TextList, TextListItem with Co…
adamviktora Jun 20, 2024
50a22a2
test(Content): update test
adamviktora Jun 24, 2024
110b40e
feat(misc): delete TextContent, TextList, TextListItem
adamviktora Jun 24, 2024
d2ea05b
test(Content): update snapshot
adamviktora Jun 24, 2024
55d6063
docs(Text): prop components update
adamviktora Jun 26, 2024
ffe178a
fix rebase issue
tlabaj Jul 17, 2024
be118b6
additional updates to replace text with content
tlabaj Jul 17, 2024
b103922
fixes from pr reviews
tlabaj Jul 18, 2024
1b5c02f
fix lint errors
tlabaj Jul 18, 2024
d51645c
update example
tlabaj Jul 19, 2024
6dfe684
docs(Content): get rid of TextContent occurences
adamviktora Jul 22, 2024
7d4ac79
chore(docs): temporarily pin react-core version of react-docs
wise-king-sullyman Jul 22, 2024
fdbcacf
chore(docs): Temporarily disable docs build from release CI
wise-king-sullyman Jul 22, 2024
bdd318b
chore(docs): Undo changes to icons.js
wise-king-sullyman Jul 22, 2024
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
11 changes: 6 additions & 5 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ jobs:
name: CI
uses: ./.github/workflows/main.yml

docs:
name: Documentation
uses: ./.github/workflows/documentation.yml
secrets: inherit
# docs:
# name: Documentation
# uses: ./.github/workflows/documentation.yml
# secrets: inherit

deploy:
name: Deploy release
runs-on: ubuntu-latest
needs: [ci, docs]
# needs: [ci, docs]
needs: [ci]
steps:
- name: Check out project
uses: actions/checkout@v4
Expand Down
38 changes: 19 additions & 19 deletions packages/react-core/src/components/AboutModal/examples/AboutModalBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import { AboutModal, Button, Content } from '@patternfly/react-core';
import brandImg from '../../assets/PF-IconLogo.svg';

export const AboutModalBasic: React.FunctionComponent = () => {
Expand All @@ -23,24 +23,24 @@ export const AboutModalBasic: React.FunctionComponent = () => {
backgroundImageSrc="/assets/images/pf-background.svg"
productName="name"
>
<TextContent>
<TextList component="dl">
<TextListItem component="dt">CFME version</TextListItem>
<TextListItem component="dd">5.5.3.4.20102789036450</TextListItem>
<TextListItem component="dt">Cloudforms Version</TextListItem>
<TextListItem component="dd">4.1</TextListItem>
<TextListItem component="dt">Server name</TextListItem>
<TextListItem component="dd">40DemoMaster</TextListItem>
<TextListItem component="dt">User name</TextListItem>
<TextListItem component="dd">Administrator</TextListItem>
<TextListItem component="dt">User role</TextListItem>
<TextListItem component="dd">EvmRole-super_administrator</TextListItem>
<TextListItem component="dt">Browser version</TextListItem>
<TextListItem component="dd">601.2</TextListItem>
<TextListItem component="dt">Browser OS</TextListItem>
<TextListItem component="dd">Mac</TextListItem>
</TextList>
</TextContent>
<Content>
<dl>
<dt>CFME version</dt>
<dd>5.5.3.4.20102789036450</dd>
<dt>Cloudforms Version</dt>
<dd>4.1</dd>
<dt>Server name</dt>
<dd>40DemoMaster</dd>
<dt>User name</dt>
<dd>Administrator</dd>
<dt>User role</dt>
<dd>EvmRole-super_administrator</dd>
<dt>Browser version</dt>
<dd>601.2</dd>
<dt>Browser OS</dt>
<dd>Mac</dd>
</dl>
</Content>
</AboutModal>
</React.Fragment>
);
Expand Down
42 changes: 21 additions & 21 deletions .../react-core/src/components/AboutModal/examples/AboutModalComplexUserPositionedContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { AboutModal, Alert, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import { AboutModal, Alert, Button, Content } from '@patternfly/react-core';
import brandImg from '../../assets/PF-IconLogo.svg';
import spacing from '@patternfly/react-styles/css/utilities/Spacing/spacing';

Expand All @@ -25,29 +25,29 @@ export const AboutModalComplexUserPositionedContent: React.FunctionComponent = (
hasNoContentContainer={true}
productName="Product name"
>
<TextContent id="test1" className={spacing.pyXl}>
<Content id="test1" className={spacing.pyXl}>
<h4>About</h4>
<p>Content here</p>
</TextContent>
</Content>
<Alert variant="info" title="Updates available" />
<TextContent id="test2" className={spacing.pyXl}>
<TextList component="dl">
<TextListItem component="dt">CFME version</TextListItem>
<TextListItem component="dd">5.5.3.4.20102789036450</TextListItem>
<TextListItem component="dt">Cloudforms version</TextListItem>
<TextListItem component="dd">4.1</TextListItem>
<TextListItem component="dt">Server name</TextListItem>
<TextListItem component="dd">40DemoMaster</TextListItem>
<TextListItem component="dt">User name</TextListItem>
<TextListItem component="dd">Administrator</TextListItem>
<TextListItem component="dt">User role</TextListItem>
<TextListItem component="dd">EvmRole-super_administrator</TextListItem>
<TextListItem component="dt">Browser version</TextListItem>
<TextListItem component="dd">601.2</TextListItem>
<TextListItem component="dt">Browser OS</TextListItem>
<TextListItem component="dd">Mac</TextListItem>
</TextList>
</TextContent>
<Content id="test2" className={spacing.pyXl}>
<dl>
<dt>CFME version</dt>
<dd>5.5.3.4.20102789036450</dd>
<dt>Cloudforms version</dt>
<dd>4.1</dd>
<dt>Server name</dt>
<dd>40DemoMaster</dd>
<dt>User name</dt>
<dd>Administrator</dd>
<dt>User role</dt>
<dd>EvmRole-super_administrator</dd>
<dt>Browser version</dt>
<dd>601.2</dd>
<dt>Browser OS</dt>
<dd>Mac</dd>
</dl>
</Content>
</AboutModal>
</React.Fragment>
);
Expand Down
38 changes: 19 additions & 19 deletions packages/react-core/src/components/AboutModal/examples/AboutModalWithoutProductName.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import { AboutModal, Button, Content } from '@patternfly/react-core';
import brandImg from '../../assets/PF-IconLogo.svg';

export const AboutModalWithoutProductName: React.FunctionComponent = () => {
Expand All @@ -23,24 +23,24 @@ export const AboutModalWithoutProductName: React.FunctionComponent = () => {
backgroundImageSrc="/assets/images/pf-background.svg"
aria-label="No product name about modal"
>
<TextContent>
<TextList component="dl">
<TextListItem component="dt">CFME version</TextListItem>
<TextListItem component="dd">5.5.3.4.20102789036450</TextListItem>
<TextListItem component="dt">Cloudforms version</TextListItem>
<TextListItem component="dd">4.1</TextListItem>
<TextListItem component="dt">Server name</TextListItem>
<TextListItem component="dd">40DemoMaster</TextListItem>
<TextListItem component="dt">User name</TextListItem>
<TextListItem component="dd">Administrator</TextListItem>
<TextListItem component="dt">User role</TextListItem>
<TextListItem component="dd">EvmRole-super_administrator</TextListItem>
<TextListItem component="dt">Browser version</TextListItem>
<TextListItem component="dd">601.2</TextListItem>
<TextListItem component="dt">Browser OS</TextListItem>
<TextListItem component="dd">Mac</TextListItem>
</TextList>
</TextContent>
<Content>
<dl>
<dt>CFME version</dt>
<dd>5.5.3.4.20102789036450</dd>
<dt>Cloudforms version</dt>
<dd>4.1</dd>
<dt>Server name</dt>
<dd>40DemoMaster</dd>
<dt>User name</dt>
<dd>Administrator</dd>
<dt>User role</dt>
<dd>EvmRole-super_administrator</dd>
<dt>Browser version</dt>
<dd>601.2</dd>
<dt>Browser OS</dt>
<dd>Mac</dd>
</dl>
</Content>
</AboutModal>
</React.Fragment>
);
Expand Down
12 changes: 6 additions & 6 deletions packages/react-core/src/components/Content/Content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { css } from '@patternfly/react-styles';
import styles from '@patternfly/react-styles/css/components/Content/content';
import { useOUIAProps, OUIAProps } from '../../helpers';

export enum TextVariants {
export enum ContentVariants {
h1 = 'h1',
h2 = 'h2',
h3 = 'h3',
Expand All @@ -24,7 +24,7 @@ export enum TextVariants {
dd = 'dd'
}

export interface TextProps extends React.HTMLProps<HTMLElement>, OUIAProps {
export interface ContentProps extends React.HTMLProps<HTMLElement>, OUIAProps {
/** The content component. If none provided, it will be a 'div' and styling will be applied to all its child components. */
component?:
| 'h1'
Expand Down Expand Up @@ -81,7 +81,7 @@ const componentStyles = {
dd: styles.contentDd
};

export const Text: React.FunctionComponent<TextProps> = ({
export const Content: React.FunctionComponent<ContentProps> = ({
children,
className = '',
component,
Expand All @@ -90,10 +90,10 @@ export const Text: React.FunctionComponent<TextProps> = ({
ouiaId,
ouiaSafe = true,
...props
}: TextProps) => {
}: ContentProps) => {
const wrappingComponent = component ?? 'div';
const Component: any = wrappingComponent;
const ouiaProps = useOUIAProps(Text.displayName, ouiaId, ouiaSafe);
const ouiaProps = useOUIAProps(Content.displayName, ouiaId, ouiaSafe);

const isList = ['ul', 'ol', 'dl'].includes(wrappingComponent);

Expand All @@ -113,4 +113,4 @@ export const Text: React.FunctionComponent<TextProps> = ({
</Component>
);
};
Text.displayName = 'Text';
Content.displayName = 'Content';
25 changes: 0 additions & 25 deletions packages/react-core/src/components/Content/TextContent.tsx
View file
Open in desktop

This file was deleted.

43 changes: 0 additions & 43 deletions packages/react-core/src/components/Content/TextList.tsx
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions packages/react-core/src/components/Content/TextListItem.tsx
View file
Open in desktop

This file was deleted.

Loading