Skip to content

chore(flex): convert examples to typescript part-2 #12059

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
rebeccaalpert merged 3 commits into from
Oct 23, 2025
Merged

chore(flex): convert examples to typescript part-2 #12059

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
5f282d7
chore(flex): convert examples to typescript part-2
Mash707 Oct 14, 2025
eb4b8e2
converted examples
Mash707 Oct 14, 2025
13ec41e
converted examples
Mash707 Oct 14, 2025
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
244 changes: 18 additions & 226 deletions packages/react-core/src/layouts/Flex/examples/Flex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,322 +325,114 @@ import { Flex, FlexItem } from '@patternfly/react-core';

### Switching between direction column and row

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexSwitchingColumnRow.tsx"

<Flex direction={{ default: 'column', lg: 'row' }}>
<Flex>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Controlling width of text

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexControlTextWidth.tsx"

<Flex direction={{ default: 'column', lg: 'row' }}>
<Flex flex={{ default: 'flex_1' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>
Lorem ipsum dolor sit amet consectetur adipisicing elit. Est animi modi temporibus, alias qui obcaecati ullam
dolor nam, nulla magni iste rem praesentium numquam provident amet ut nesciunt harum accusamus.
</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

## Flex alignment

### Aligning right

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAligningRight.tsx"

<Flex className="example-border">
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem align={{ default: 'alignRight' }}>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>;
```

### Align right on single item

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignRightSingleItem.tsx"

<Flex className="example-border">
<FlexItem align={{ default: 'alignRight' }}>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>;
```

### Align right on multiple groups

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignRightMultipleGroups.tsx"

<Flex>
<Flex>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex align={{ default: 'alignRight' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex align={{ default: 'alignRight' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Align adjacent content

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignAdjacentContent.tsx"

<Flex>
<Flex flex={{ default: 'flex_1' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Align self flex end

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignSelfFlexEnd.tsx"

<Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }} alignSelf={{ default: 'alignSelfFlexEnd' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Align self center

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignSelfCenter.tsx"

<Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }} alignSelf={{ default: 'alignSelfCenter' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Align self baseline

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignSelfBaseline.tsx"

<Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }} alignSelf={{ default: 'alignSelfBaseline' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

### Align self stretch

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlignSelfStretch.tsx"

<Flex>
<Flex direction={{ default: 'column' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex direction={{ default: 'column' }} alignSelf={{ default: 'alignSelfStretch' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>;
```

## Flex justification

### Justify content flex end

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexJustifyContentEnd.tsx"

<Flex className="example-border" justifyContent={{ default: 'justifyContentFlexEnd' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>;
```

### Justify content space between

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexJustifyContentSpaceBetween.tsx"

<Flex className="example-border" justifyContent={{ default: 'justifyContentSpaceBetween' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>;
```

### Justify content flex start

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexJustifyContentFlexStart.tsx"

<Flex className="example-border" justifyContent={{ default: 'justifyContentFlexStart' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>;
```

## Flex item order

### First last ordering

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexFirstLastOrder.tsx"

<Flex className="example-border">
<FlexItem spacer={{ default: 'spacerNone' }} order={{ default: '2' }}>
Item A
</FlexItem>
<FlexItem>Item B</FlexItem>
<FlexItem spacer={{ default: 'spacerMd' }} order={{ default: '-1' }}>
Item C
</FlexItem>
</Flex>;
```

### Responsive first last ordering

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexResponsiveFirstLastOrder.tsx"

<Flex className="example-border">
<FlexItem spacer={{ lg: 'spacerNone' }} order={{ lg: '2' }}>
Item A
</FlexItem>
<FlexItem spacer={{ md: 'spacerNone', lg: 'spacerMd' }} order={{ default: '-1', md: '1' }}>
Item B
</FlexItem>
<FlexItem spacer={{ default: 'spacerMd' }} order={{ md: '-1' }}>
Item C
</FlexItem>
</Flex>;
```

### Ordering

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexOrdering.tsx"

<Flex className="example-border">
<Flex spacer={{ default: 'spacerNone' }} order={{ lg: '1' }} className="example-border">
<FlexItem order={{ md: '2' }}>Set 1, Item A</FlexItem>
<FlexItem order={{ md: '-1' }}>Set 1, Item B</FlexItem>
<FlexItem order={{ xl: '1' }}>Set 1, Item C</FlexItem>
<FlexItem spacer={{ xl: 'spacerNone' }} order={{ xl: '1' }}>
Set 1, Item D
</FlexItem>
</Flex>
<Flex spacer={{ lg: 'spacerMd' }} className="example-border">
<FlexItem spacer={{ default: 'spacerNone' }} order={{ default: '3' }}>
Set 2, Item A
</FlexItem>
<FlexItem order={{ default: '1' }}>Set 2, Item B</FlexItem>
<FlexItem>Set 2, Item C</FlexItem>
<FlexItem spacer={{ default: 'spacerMd' }} order={{ default: '2' }}>
Set 2, Item D
</FlexItem>
</Flex>
</Flex>;
```

### Responsive ordering

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexResponsiveOrdering.tsx"

<Flex className="example-border">
<Flex spacer={{ default: 'spacerNone' }} order={{ default: '1' }} className="example-border">
<FlexItem spacer={{ default: 'spacerNone' }} order={{ default: '3' }}>
Set 1, Item A
</FlexItem>
<FlexItem order={{ default: '1' }}>Set 1, Item B</FlexItem>
<FlexItem>Set 1, Item C</FlexItem>
<FlexItem spacer={{ default: 'spacerMd' }}>Set 1, Item D</FlexItem>
</Flex>

<Flex spacer={{ default: 'spacerMd' }} className="example-border">
<FlexItem spacer={{ default: 'spacerNone' }} order={{ default: '3' }}>
Set 2, Item A
</FlexItem>
<FlexItem order={{ lg: '1' }}>Set 2, Item B</FlexItem>
<FlexItem>Set 2, Item C</FlexItem>
<FlexItem spacer={{ default: 'spacerMd' }} order={{ default: '2' }}>
Set 2, Item D
</FlexItem>
</Flex>
</Flex>;
```

### Alternative components

```js
import { Flex, FlexItem } from '@patternfly/react-core';
```ts file="FlexAlternative.tsx"

<Flex component="ul">
<FlexItem component="li">Flex item</FlexItem>
<FlexItem component="li">Flex item</FlexItem>
<FlexItem component="li">Flex item</FlexItem>
<FlexItem component="li">Flex item</FlexItem>
<FlexItem component="li">Flex item</FlexItem>
</Flex>;
```
16 changes: 16 additions & 0 deletions packages/react-core/src/layouts/Flex/examples/FlexAlignAdjacentContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { Flex, FlexItem } from '@patternfly/react-core';

export const FlexAlignAdjacentContent: React.FunctionComponent = () => (
<Flex>
<Flex flex={{ default: 'flex_1' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>
);
18 changes: 18 additions & 0 deletions packages/react-core/src/layouts/Flex/examples/FlexAlignRightMultipleGroups.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Flex, FlexItem } from '@patternfly/react-core';

export const FlexAlignRightMultipleGroups: React.FunctionComponent = () => (
<Flex>
<Flex>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex align={{ default: 'alignRight' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
<Flex align={{ default: 'alignRight' }}>
<FlexItem>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
</Flex>
);
8 changes: 8 additions & 0 deletions packages/react-core/src/layouts/Flex/examples/FlexAlignRightSingleItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { Flex, FlexItem } from '@patternfly/react-core';

export const FlexAlignRightSingleItem: React.FunctionComponent = () => (
<Flex className="example-border">
<FlexItem align={{ default: 'alignRight' }}>Flex item</FlexItem>
<FlexItem>Flex item</FlexItem>
</Flex>
);
Loading
Loading