Skip to content

chore(AboutModal): convert examples to TypeScript/functional components #6714

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
nicolethoen merged 3 commits into from
Jan 7, 2022
Merged

chore(AboutModal): convert examples to TypeScript/functional components #6714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
866174d
chore(AboutModal): convert examples to TypeScript/functional components
wise-king-sullyman Dec 22, 2021
1e3f6e4
refactors extracted example names for consistency
wise-king-sullyman Jan 6, 2022
b08103d
explicitly types function component return values
wise-king-sullyman Jan 6, 2022
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
226 changes: 4 additions & 222 deletions packages/react-core/src/components/AboutModal/examples/AboutModal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,235 +9,17 @@ import bgImg from './patternfly-orb.svg';

## Examples
### Basic
```js
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './examples/brandImg.svg';

class SimpleAboutModal extends React.Component {
constructor(props) {
super(props);
this.state = {
isModalOpen: false
};
this.handleModalToggle = () => {
this.setState(({ isModalOpen }) => ({
isModalOpen: !isModalOpen
}));
};
}

render() {
const { isModalOpen } = this.state;

return (
<React.Fragment>
<Button variant="primary" onClick={this.handleModalToggle}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={this.handleModalToggle}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
productName="Product 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>
</AboutModal>
</React.Fragment>
);
}
}
```ts file="./AboutModalBasic.tsx"
```

### Without product name
```js
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './examples/brandImg.svg';

class SimpleAboutModal extends React.Component {
constructor(props) {
super(props);
this.state = {
isModalOpen: false
};
this.handleModalToggle = () => {
this.setState(({ isModalOpen }) => ({
isModalOpen: !isModalOpen
}));
};
}

render() {
const { isModalOpen } = this.state;

return (
<React.Fragment>
<Button variant="primary" onClick={this.handleModalToggle}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={this.handleModalToggle}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
>
<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>
</AboutModal>
</React.Fragment>
);
}
}
```ts file="./AboutModalWithoutProductName.tsx"
```

### Complex user positioned content
```js
import React from 'react';
import { AboutModal, Alert, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './examples/brandImg.svg';

class ContentRichAboutModal extends React.Component {
constructor(props) {
super(props);
this.state = {
isModalOpen: false
};
this.handleModalToggle = () => {
this.setState(({ isModalOpen }) => ({
isModalOpen: !isModalOpen
}));
};
}

render() {
const { isModalOpen } = this.state;

return (
<React.Fragment>
<Button variant="primary" onClick={this.handleModalToggle}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={this.handleModalToggle}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
noAboutModalBoxContentContainer={true}
productName="Product Name"
>
<TextContent id="test1" className="pf-u-py-xl">
<h4>About</h4>
<p>Content here</p>
</TextContent>
<Alert variant="info" title="Updates available" />
<TextContent id="test2" className="pf-u-py-xl">
<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>
</AboutModal>
</React.Fragment>
);
}
}
```ts file="./AboutModalComplexUserPositionedContent.tsx"
```

### Custom background image
```js
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './examples/brandImg.svg';
import bgImg from './examples/patternfly-orb.svg';

class SimpleAboutModal extends React.Component {
constructor(props) {
super(props);
this.state = {
isModalOpen: false
};
this.handleModalToggle = () => {
this.setState(({ isModalOpen }) => ({
isModalOpen: !isModalOpen
}));
};
}

render() {
const { isModalOpen } = this.state;

return (
<React.Fragment>
<Button variant="primary" onClick={this.handleModalToggle}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={this.handleModalToggle}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
backgroundImageSrc={bgImg}
>
<TextContent>
<TextList component="dl">
<TextListItem component="dt">CFME Version</TextListItem>
<TextListItem component="dd">5.5.3.4.20102789036450</TextListItem>
</TextList>
</TextContent>
</AboutModal>
</React.Fragment>
);
}
}
```ts file="./AboutModalCustomBackgroundImage.tsx"
```
46 changes: 46 additions & 0 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
@@ -0,0 +1,46 @@
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './brandImg.svg';

export const AboutModalBasic: React.FunctionComponent = () => {
const [isModalOpen, setIsModalOpen] = React.useState(false);

const toggleModal = () => {
setIsModalOpen(!isModalOpen);
};

return (
<React.Fragment>
<Button variant="primary" onClick={toggleModal}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={toggleModal}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
productName="Product 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>
</AboutModal>
</React.Fragment>
);
};
52 changes: 52 additions & 0 deletions .../react-core/src/components/AboutModal/examples/AboutModalComplexUserPositionedContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import React from 'react';
import { AboutModal, Alert, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './brandImg.svg';

export const AboutModalComplexUserPositionedContent: React.FunctionComponent = () => {
const [isModalOpen, setIsModalOpen] = React.useState(false);

const toggleModal = () => {
setIsModalOpen(!isModalOpen);
};

return (
<React.Fragment>
<Button variant="primary" onClick={toggleModal}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={toggleModal}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
noAboutModalBoxContentContainer={true}
productName="Product Name"
>
<TextContent id="test1" className="pf-u-py-xl">
<h4>About</h4>
<p>Content here</p>
</TextContent>
<Alert variant="info" title="Updates available" />
<TextContent id="test2" className="pf-u-py-xl">
<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>
</AboutModal>
</React.Fragment>
);
};
35 changes: 35 additions & 0 deletions packages/react-core/src/components/AboutModal/examples/AboutModalCustomBackgroundImage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import React from 'react';
import { AboutModal, Button, TextContent, TextList, TextListItem } from '@patternfly/react-core';
import brandImg from './brandImg.svg';
import bgImg from './patternfly-orb.svg';

export const AboutModalCustomBackgroundImage: React.FunctionComponent = () => {
const [isModalOpen, setIsModalOpen] = React.useState(false);

const toggleModal = () => {
setIsModalOpen(!isModalOpen);
};

return (
<React.Fragment>
<Button variant="primary" onClick={toggleModal}>
Show about modal
</Button>
<AboutModal
isOpen={isModalOpen}
onClose={toggleModal}
trademark="Trademark and copyright information here"
brandImageSrc={brandImg}
brandImageAlt="Patternfly Logo"
backgroundImageSrc={bgImg}
>
<TextContent>
<TextList component="dl">
<TextListItem component="dt">CFME Version</TextListItem>
<TextListItem component="dd">5.5.3.4.20102789036450</TextListItem>
</TextList>
</TextContent>
</AboutModal>
</React.Fragment>
);
};
Loading