Skip to content

chore(panel): move examples to separate files #12036

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
thatblindgeye merged 1 commit into from
Oct 23, 2025
Merged

chore(panel): move examples to separate files #12036

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
169 changes: 10 additions & 159 deletions packages/react-core/src/components/Panel/examples/Panel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,199 +9,50 @@ propComponents: [Panel, PanelMain, PanelMainBody, PanelHeader, PanelFooter]

### Basic

```js
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

const BasicPanel = () => (
<Panel>
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelBasic.tsx"
```

### Header

```js
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider } from '@patternfly/react-core';

const HeaderPanel = () => (
<Panel>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelHeaderExample.tsx"
```

### Footer

```js
import { Panel, PanelMain, PanelMainBody, PanelFooter } from '@patternfly/react-core';

const FooterPanel = () => (
<Panel>
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
```ts file="PanelFooterExample.tsx"
```

### Header and footer

```js
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider, PanelFooter } from '@patternfly/react-core';

const HeaderFooterPanel = () => (
<Panel>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
```ts file="PanelHeaderFooter.tsx"
```

### No body

```js
import { Panel, PanelMain } from '@patternfly/react-core';

const NoBodyPanel = () => (
<Panel>
<PanelMain>Main content</PanelMain>
</Panel>
);
```ts file="PanelNoBody.tsx"
```

### Raised

```js
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

const RaisedPanel = () => (
<Panel variant="raised">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelRaised.tsx"
```

### Bordered

```js
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

const BorderedPanel = () => (
<Panel variant="bordered">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelBordered.tsx"
```

### Secondary variant

```js
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

const PanelSecondaryVariant = () => (
<Panel variant="secondary">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelSecondaryVariant.tsx"
```

### Scrollable

```js
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

const ScrollablePanel = () => (
<Panel isScrollable>
<PanelMain tabIndex={0}>
<PanelMainBody>
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
</PanelMainBody>
</PanelMain>
</Panel>
);
```ts file="PanelScrollable.tsx"
```

### Scrollable with header and footer

```js
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider, PanelFooter } from '@patternfly/react-core';

const ScrollableHeaderFooterPanel = () => (
<Panel isScrollable>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain tabIndex={0}>
<PanelMainBody>
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
```ts file="PanelScrollableHeaderFooter.tsx"
```
9 changes: 9 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

export const PanelBasic: React.FunctionComponent = () => (
<Panel>
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
9 changes: 9 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelBordered.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

export const PanelBordered: React.FunctionComponent = () => (
<Panel variant="bordered">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
10 changes: 10 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelFooterExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { Panel, PanelMain, PanelMainBody, PanelFooter } from '@patternfly/react-core';

export const PanelFooterExample: React.FunctionComponent = () => (
<Panel>
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
11 changes: 11 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelHeaderExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider } from '@patternfly/react-core';

export const PanelHeaderExample: React.FunctionComponent = () => (
<Panel>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
12 changes: 12 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelHeaderFooter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider, PanelFooter } from '@patternfly/react-core';

export const PanelHeaderFooter: React.FunctionComponent = () => (
<Panel>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
7 changes: 7 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelNoBody.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Panel, PanelMain } from '@patternfly/react-core';

export const PanelNoBody: React.FunctionComponent = () => (
<Panel>
<PanelMain>Main content</PanelMain>
</Panel>
);
9 changes: 9 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelRaised.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

export const PanelRaised: React.FunctionComponent = () => (
<Panel variant="raised">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
35 changes: 35 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelScrollable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

export const PanelScrollable: React.FunctionComponent = () => (
<Panel isScrollable>
<PanelMain tabIndex={0}>
<PanelMainBody>
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
</PanelMainBody>
</PanelMain>
</Panel>
);
38 changes: 38 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelScrollableHeaderFooter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { Panel, PanelMain, PanelMainBody, PanelHeader, Divider, PanelFooter } from '@patternfly/react-core';

export const PanelScrollableHeaderFooter: React.FunctionComponent = () => (
<Panel isScrollable>
<PanelHeader>Header content</PanelHeader>
<Divider />
<PanelMain tabIndex={0}>
<PanelMainBody>
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
<br />
<br />
Main content
</PanelMainBody>
</PanelMain>
<PanelFooter>Footer content</PanelFooter>
</Panel>
);
9 changes: 9 additions & 0 deletions packages/react-core/src/components/Panel/examples/PanelSecondaryVariant.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Panel, PanelMain, PanelMainBody } from '@patternfly/react-core';

export const PanelSecondaryVariant: React.FunctionComponent = () => (
<Panel variant="secondary">
<PanelMain>
<PanelMainBody>Main content</PanelMainBody>
</PanelMain>
</Panel>
);
Loading