Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
181 changes: 6 additions & 175 deletions packages/react-core/src/components/Text/examples/Text.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,201 +9,32 @@ propComponents: ['TextContent', 'Text', 'TextList', 'TextListItem']

### Headings

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants,
TextList,
TextListVariants,
TextListItem,
TextListItemVariants
} from '@patternfly/react-core';

<TextContent>
<Text component={TextVariants.h1}>Hello World</Text>
<Text component={TextVariants.h2}>Second level</Text>
<Text component={TextVariants.h3}>Third level</Text>
<Text component={TextVariants.h4}>Fourth level</Text>
<Text component={TextVariants.h5}>Fifth level</Text>
<Text component={TextVariants.h6}>Sixth level</Text>
</TextContent>;
```ts file="./TextHeadings.tsx"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the examples are using TextListVariants, I would add it to the documentation so it shows up in the props table. This can be done by adding it to the propComponents array on line 5 of this md file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TextListVariants does not render in the props table when added. This is likely because it is just an enum in TextList.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XiangyuShen you are correct! We do not currently have a way to document enums.

```

### Body

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants,
TextList,
TextListVariants,
TextListItem,
TextListItemVariants
} from '@patternfly/react-core';

<TextContent>
<Text component={TextVariants.p}>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla accumsan, metus ultrices eleifend gravida, nulla nunc
varius lectus, nec rutrum justo nibh eu lectus. Ut vulputate semper dui. Fusce erat odio, sollicitudin vel erat vel,
interdum mattis neque. Sub works as well!
</Text>
<Text component={TextVariants.p}>
Quisque ante lacus, malesuada ac auctor vitae, congue{' '}
<Text component={TextVariants.a} href="#">
non ante
</Text>
. Phasellus lacus ex, semper ac tortor nec, fringilla condimentum orci. Fusce eu rutrum tellus.
</Text>
<Text component={TextVariants.blockquote}>
Ut venenatis, nisl scelerisque sollicitudin fermentum, quam libero hendrerit ipsum, ut blandit est tellus sit amet
turpis.
</Text>
<Text component={TextVariants.small}>Sometimes you need small text to display things like date created</Text>
</TextContent>;
```ts file="./TextBody.tsx"
```

Text components such as Text, TextList, TextListItem need to be placed within a TextContent

### Unordered list

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants,
TextList,
TextListVariants,
TextListItem,
TextListItemVariants
} from '@patternfly/react-core';

<TextContent>
<TextList>
<TextListItem>In fermentum leo eu lectus mollis, quis dictum mi aliquet.</TextListItem>
<TextListItem>Morbi eu nulla lobortis, lobortis est in, fringilla felis.</TextListItem>
<TextListItem>
Aliquam nec felis in sapien venenatis viverra fermentum nec lectus.
<TextList>
<TextListItem>In fermentum leo eu lectus mollis, quis dictum mi aliquet.</TextListItem>
<TextListItem>Morbi eu nulla lobortis, lobortis est in, fringilla felis.</TextListItem>
</TextList>
</TextListItem>
<TextListItem>Ut non enim metus.</TextListItem>
</TextList>
</TextContent>;
```ts file="./TextUnorderedList.tsx"
```

### Ordered list

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants,
TextList,
TextListVariants,
TextListItem,
TextListItemVariants
} from '@patternfly/react-core';

<TextContent>
<TextList component={TextListVariants.ol}>
<TextListItem>Donec blandit a lorem id convallis.</TextListItem>
<TextListItem>Cras gravida arcu at diam gravida gravida.</TextListItem>
<TextListItem>Integer in volutpat libero.</TextListItem>
<TextListItem>Donec a diam tellus.</TextListItem>
<TextListItem>Aenean nec tortor orci.</TextListItem>
<TextListItem>Quisque aliquam cursus urna, non bibendum massa viverra eget.</TextListItem>
<TextListItem>Vivamus maximus ultricies pulvinar.</TextListItem>
</TextList>
</TextContent>;
```ts file="./TextOrderedList.tsx"
```

### Description list

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants,
TextList,
TextListVariants,
TextListItem,
TextListItemVariants
} from '@patternfly/react-core';

<TextContent>
<TextList component={TextListVariants.dl}>
<TextListItem component={TextListItemVariants.dt}>Web</TextListItem>
<TextListItem component={TextListItemVariants.dd}>
The part of the Internet that contains websites and web pages
</TextListItem>
<TextListItem component={TextListItemVariants.dt}>HTML</TextListItem>
<TextListItem component={TextListItemVariants.dd}>A markup language for creating web pages</TextListItem>
<TextListItem component={TextListItemVariants.dt}>CSS</TextListItem>
<TextListItem component={TextListItemVariants.dd}>A technology to make HTML look better</TextListItem>
</TextList>
</TextContent>;
```ts file="./TextDescriptionList.tsx"
```

### Visited

```js
import React from 'react';
import {
TextContent,
Text,
TextVariants
} from '@patternfly/react-core';

TextVisited = () => {
return (
<>
<TextContent>
<Text component={TextVariants.h3}>Visited link example</Text>
<Text component={TextVariants.p}>
<Text
component={TextVariants.a}
isVisitedLink
href="#">
Visited link
</Text>
</Text>
</TextContent>
<br />
<TextContent isVisited>
<Text component={TextVariants.h3}>Visited content example</Text>
<Text component={TextVariants.p}>
<Text
component={TextVariants.a}
href="#">
content link 1
</Text>
</Text>
<Text component={TextVariants.p}>
<Text
component={TextVariants.a}
href="#">
content link 2
</Text>
</Text>
<Text component={TextVariants.p}>
<Text
component={TextVariants.a}
href="#">
content link 3
</Text>
</Text>
</TextContent>
</>
);

};
```ts file="./TextVisited.tsx"
```
24 changes: 24 additions & 0 deletions packages/react-core/src/components/Text/examples/TextBody.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import React from 'react';
import { TextContent, Text, TextVariants } from '@patternfly/react-core';

export const TextBody: React.FunctionComponent = () => (
<TextContent>
<Text component={TextVariants.p}>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla accumsan, metus ultrices eleifend gravida, nulla
nunc varius lectus, nec rutrum justo nibh eu lectus. Ut vulputate semper dui. Fusce erat odio, sollicitudin vel
erat vel, interdum mattis neque. Sub works as well!
</Text>
<Text component={TextVariants.p}>
Quisque ante lacus, malesuada ac auctor vitae, congue{' '}
<Text component={TextVariants.a} href="#">
non ante
</Text>
. Phasellus lacus ex, semper ac tortor nec, fringilla condimentum orci. Fusce eu rutrum tellus.
</Text>
<Text component={TextVariants.blockquote}>
Ut venenatis, nisl scelerisque sollicitudin fermentum, quam libero hendrerit ipsum, ut blandit est tellus sit amet
turpis.
</Text>
<Text component={TextVariants.small}>Sometimes you need small text to display things like date created</Text>
</TextContent>
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import React from 'react';
import { TextContent, TextList, TextListVariants, TextListItem, TextListItemVariants } from '@patternfly/react-core';

export const TextDescriptionList: React.FunctionComponent = () => (
<TextContent>
<TextList component={TextListVariants.dl}>
<TextListItem component={TextListItemVariants.dt}>Web</TextListItem>
<TextListItem component={TextListItemVariants.dd}>
The part of the Internet that contains websites and web pages
</TextListItem>
<TextListItem component={TextListItemVariants.dt}>HTML</TextListItem>
<TextListItem component={TextListItemVariants.dd}>A markup language for creating web pages</TextListItem>
<TextListItem component={TextListItemVariants.dt}>CSS</TextListItem>
<TextListItem component={TextListItemVariants.dd}>A technology to make HTML look better</TextListItem>
</TextList>
</TextContent>
);
13 changes: 13 additions & 0 deletions packages/react-core/src/components/Text/examples/TextHeadings.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react';
import { TextContent, Text, TextVariants } from '@patternfly/react-core';

export const TextHeadings: React.FunctionComponent = () => (
<TextContent>
<Text component={TextVariants.h1}>Hello World</Text>
<Text component={TextVariants.h2}>Second level</Text>
<Text component={TextVariants.h3}>Third level</Text>
<Text component={TextVariants.h4}>Fourth level</Text>
<Text component={TextVariants.h5}>Fifth level</Text>
<Text component={TextVariants.h6}>Sixth level</Text>
</TextContent>
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import React from 'react';
import { TextContent, TextList, TextListVariants, TextListItem } from '@patternfly/react-core';

export const TextOrderedList: React.FunctionComponent = () => (
<TextContent>
<TextList component={TextListVariants.ol}>
<TextListItem>Donec blandit a lorem id convallis.</TextListItem>
<TextListItem>Cras gravida arcu at diam gravida gravida.</TextListItem>
<TextListItem>Integer in volutpat libero.</TextListItem>
<TextListItem>Donec a diam tellus.</TextListItem>
<TextListItem>Aenean nec tortor orci.</TextListItem>
<TextListItem>Quisque aliquam cursus urna, non bibendum massa viverra eget.</TextListItem>
<TextListItem>Vivamus maximus ultricies pulvinar.</TextListItem>
</TextList>
</TextContent>
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import React from 'react';
import { TextContent, TextList, TextListItem } from '@patternfly/react-core';

export const TextUnorderedList: React.FunctionComponent = () => (
<TextContent>
<TextList>
<TextListItem>In fermentum leo eu lectus mollis, quis dictum mi aliquet.</TextListItem>
<TextListItem>Morbi eu nulla lobortis, lobortis est in, fringilla felis.</TextListItem>
<TextListItem>
Aliquam nec felis in sapien venenatis viverra fermentum nec lectus.
<TextList>
<TextListItem>In fermentum leo eu lectus mollis, quis dictum mi aliquet.</TextListItem>
<TextListItem>Morbi eu nulla lobortis, lobortis est in, fringilla felis.</TextListItem>
</TextList>
</TextListItem>
<TextListItem>Ut non enim metus.</TextListItem>
</TextList>
</TextContent>
);
34 changes: 34 additions & 0 deletions packages/react-core/src/components/Text/examples/TextVisited.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react';
import { TextContent, Text, TextVariants } from '@patternfly/react-core';

export const TextVisited: React.FunctionComponent = () => (
<>
<TextContent>
<Text component={TextVariants.h3}>Visited link example</Text>
<Text component={TextVariants.p}>
<Text component={TextVariants.a} isVisitedLink href="#">
Visited link
</Text>
</Text>
</TextContent>
<br />
<TextContent isVisited>
<Text component={TextVariants.h3}>Visited content example</Text>
<Text component={TextVariants.p}>
<Text component={TextVariants.a} href="#">
content link 1
</Text>
</Text>
<Text component={TextVariants.p}>
<Text component={TextVariants.a} href="#">
content link 2
</Text>
</Text>
<Text component={TextVariants.p}>
<Text component={TextVariants.a} href="#">
content link 3
</Text>
</Text>
</TextContent>
</>
);