Skip to content

Commit ed75671

Browse files
authored
Merge pull request #20 from fhlavac/main
fix(docs) Enhance ErrorState & ErrorBoundary docs
2 parents 85e6d53 + 64c9859 commit ed75671

22 files changed

+61
-24
lines changed

packages/module/patternfly-docs/content/extensions/component-groups/examples/ActionButtonsExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/ActionButtonsExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/ActionMenuExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/ActionMenuExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/ActionMenuGroupedExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/ActionMenuGroupedExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/BreadcrumbsExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/BreadcrumbsExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage.md renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/DetailsPage.md

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPageExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/DetailsPageExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPageHeaderExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/DetailsPageHeaderExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/component-groups/examples/HorizontalNavExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/DetailsPage/HorizontalNavExample.tsx

File renamed without changes.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# Sidenav top-level section
3+
# should be the same for all markdown files
4+
section: extensions
5+
subsection: Component groups
6+
# Sidenav secondary level section
7+
# should be the same for all markdown files
8+
id: ErrorBoundaryPage
9+
# Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
10+
source: react
11+
# If you use typescript, the name of the interface to display props for
12+
# These are found through the sourceProps function provided in patternfly-docs.source.js
13+
propComponents: ['ErrorBoundaryPage']
14+
---
15+
16+
import { ErrorBoundaryPage } from "@patternfly/react-component-groups";
17+
18+
## Components Usage
19+
20+
This component reuses the ErrorState component for an app error boundary.
21+
22+
### ErrorBoundaryPage Component
23+
24+
```js file="./ErrorBoundaryPageExample.tsx"
25+
26+
```
27+
28+
### ErrorBoundaryPage Component without error
29+
30+
```js file="./ErrorBoundaryPageNoExample.tsx"
31+
32+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import React from 'react';
2+
import { ErrorBoundaryPage } from '@patternfly/react-component-groups';
3+
4+
export const BasicExample: React.FunctionComponent = () => {
5+
const Surprise = () => {
6+
throw new Error('but a welcome one');
7+
};
8+
9+
return (<ErrorBoundaryPage headerTitle="My app header" errorTitle="Something wrong happened">
10+
<Surprise />
11+
</ErrorBoundaryPage>);
12+
}

0 commit comments

Comments
 (0)