Skip to content

chore(List): converted all examples to typescript #7550

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 1 commit into from
Jun 16, 2022
Merged

chore(List): converted all examples to typescript #7550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
82 changes: 10 additions & 72 deletions packages/react-core/src/components/List/examples/List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,97 +5,35 @@ cssPrefix: pf-c-list
propComponents: ['List', 'ListItem']
---

import BookOpen from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import Key from '@patternfly/react-icons/dist/esm/icons/key-icon';
import Desktop from '@patternfly/react-icons/dist/esm/icons/desktop-icon';
import BookOpenIcon from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import KeyIcon from '@patternfly/react-icons/dist/esm/icons/key-icon';
import DesktopIcon from '@patternfly/react-icons/dist/esm/icons/desktop-icon';

## Examples
### Basic
```js
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

<List>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
```ts file="./ListBasic.tsx"
```

### Inline
```js
import React from 'react';
import { List, ListItem, ListVariant } from '@patternfly/react-core';

<List variant={ListVariant.inline}>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
```ts file="./ListInline.tsx"
```

### Ordered
```js
import React from 'react';
import { List, ListItem, ListComponent, OrderType } from '@patternfly/react-core';

<List component={ListComponent.ol} type={OrderType.number}>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
```ts file="./ListOrdered.tsx"
```

### Plain
```js
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

<List isPlain>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
```ts file="./ListPlain.tsx"
```

### With horizontal rules
```js
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

<List isPlain isBordered>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
```ts file="./ListHorizontalRules.tsx"
```

### With icons
```js
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';
import BookOpen from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import Key from '@patternfly/react-icons/dist/esm/icons/key-icon';
import Desktop from '@patternfly/react-icons/dist/esm/icons/desktop-icon';

<List isPlain>
<ListItem icon={<BookOpen />}>First</ListItem>
<ListItem icon={<Key />}>Second</ListItem>
<ListItem icon={<Desktop />}>Third</ListItem>
</List>
```ts file="./ListIcons.tsx"
```

### With large icons
```js
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';
import BookOpen from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import Key from '@patternfly/react-icons/dist/esm/icons/key-icon';
import Desktop from '@patternfly/react-icons/dist/esm/icons/desktop-icon';

<List isPlain iconSize="large">
<ListItem icon={<BookOpen />}>First</ListItem>
<ListItem icon={<Key />}>Second</ListItem>
<ListItem icon={<Desktop />}>Third</ListItem>
</List>
```ts file="./ListLargeIcons.tsx"
```
10 changes: 10 additions & 0 deletions packages/react-core/src/components/List/examples/ListBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

export const ListBasic: React.FunctionComponent = () => (
<List>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/List/examples/ListHorizontalRules.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

export const ListHorizontalRules: React.FunctionComponent = () => (
<List isPlain isBordered>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
);
13 changes: 13 additions & 0 deletions packages/react-core/src/components/List/examples/ListIcons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';
import BookOpenIcon from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import KeyIcon from '@patternfly/react-icons/dist/esm/icons/key-icon';
import DesktopIcon from '@patternfly/react-icons/dist/esm/icons/desktop-icon';

export const ListIcons: React.FunctionComponent = () => (
<List isPlain>
<ListItem icon={<BookOpenIcon />}>First</ListItem>
<ListItem icon={<KeyIcon />}>Second</ListItem>
<ListItem icon={<DesktopIcon />}>Third</ListItem>
</List>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/List/examples/ListInline.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { List, ListItem, ListVariant } from '@patternfly/react-core';

export const ListInline: React.FunctionComponent = () => (
<List variant={ListVariant.inline}>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
);
13 changes: 13 additions & 0 deletions packages/react-core/src/components/List/examples/ListLargeIcons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';
import BookOpenIcon from '@patternfly/react-icons/dist/esm/icons/book-open-icon';
import KeyIcon from '@patternfly/react-icons/dist/esm/icons/key-icon';
import DesktopIcon from '@patternfly/react-icons/dist/esm/icons/desktop-icon';

export const ListLargeIcons: React.FunctionComponent = () => (
<List isPlain iconSize="large">
<ListItem icon={<BookOpenIcon />}>First</ListItem>
<ListItem icon={<KeyIcon />}>Second</ListItem>
<ListItem icon={<DesktopIcon />}>Third</ListItem>
</List>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/List/examples/ListOrdered.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { List, ListItem, ListComponent, OrderType } from '@patternfly/react-core';

export const ListOrdered: React.FunctionComponent = () => (
<List component={ListComponent.ol} type={OrderType.number}>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/List/examples/ListPlain.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import { List, ListItem } from '@patternfly/react-core';

export const ListPlain: React.FunctionComponent = () => (
<List isPlain>
<ListItem>First</ListItem>
<ListItem>Second</ListItem>
<ListItem>Third</ListItem>
</List>
);