Skip to content

Commit df0796a

Browse files
committed
chore: clean up the docs
1 parent c0a4415 commit df0796a

21 files changed

+247
-238
lines changed

packages/module/patternfly-docs/content/extensions/data-view/about-data-view.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

packages/module/patternfly-docs/content/extensions/data-view/examples/Components/Components.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

packages/module/patternfly-docs/content/extensions/data-view/examples/Layout/AbstractLayoutExample.tsx renamed to packages/module/patternfly-docs/content/extensions/data-view/examples/DataView/AbstractLayoutExample.tsx

File renamed without changes.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
section: extensions
3+
subsection: Data view
4+
id: Data view
5+
propComponents: ['DataView']
6+
sortValue: 1
7+
sourceLink: https://github.com/patternfly/react-data-view/blob/main/packages/module/patternfly-docs/content/extensions/data-view/examples/DataView/DataView.md
8+
---
9+
import { useState, useEffect, useRef, useMemo } from 'react';
10+
import { Drawer, DrawerContent, DrawerContentBody } from '@patternfly/react-core';
11+
import { useDataViewPagination, useDataViewSelection } from '@patternfly/react-data-view/dist/dynamic/Hooks';
12+
import { BulkSelect, BulkSelectValue } from '@patternfly/react-component-groups/dist/dynamic/BulkSelect';
13+
import { DataView } from '@patternfly/react-data-view/dist/dynamic/DataView';
14+
import { DataViewToolbar } from '@patternfly/react-data-view/dist/dynamic/DataViewToolbar';
15+
import { DataViewTable } from '@patternfly/react-data-view/dist/dynamic/DataViewTable';
16+
import { useDataViewEventsContext, DataViewEventsContext, DataViewEventsProvider, EventTypes } from '@patternfly/react-data-view/dist/dynamic/DataViewEventsContext';
17+
18+
## Core concepts
19+
20+
The **data view** extension helps you display datasets in organized layouts containing data representation and toolbars allowing interactions like selection or pagination.
21+
22+
Sub-components for displaying the data (card view, table) and toolbars (top and bottom) are always passed as `children` to the `DataView` component.
23+
24+
---
25+
26+
**Note:** Data view lives in its own package [`@patternfly/react-data-view`](https://www.npmjs.com/package/@patternfly/react-data-view)
27+
28+
If you notice a bug, or if you have a suggestion for improving the data view extension or its documentation, please file an issue in [the react-data-view repository](https://github.com/patternfly/react-data-view/issues). Before doing so, please make sure there is not already a pre-existing issue.
29+
30+
---
31+
32+
### Layout
33+
34+
Data view is expected to consist of header, data representation part and footer stacked below each other. The layout is implemented using PatternFly [stack](/layouts/stack).
35+
36+
```js file="./AbstractLayoutExample.tsx"
37+
38+
```
39+
40+
### Modularity
41+
42+
The extension's modular architecture lets you efficiently create consistent data views by using predefined sub-components and hooks or defining your own. You can choose the tools that suit your needs and easily replace any part with a custom implementation.
43+
44+
For the toolbar, you can make use of the predefined `DataViewToolbar` component, which extends the PatternFly [toolbar](/components/toolbar) with the most common use cases. For more details, please refer to the [Toolbar](/extensions/data-view/toolbar) section. In case it does not fit your needs, you can also use your custom toolbar component.
45+
46+
Data can be presented using the predefined `DataViewTable` component, which is an abstraction above the PatternFly [table](/components/table). For more details, please refer to the [Table](/extensions/data-view/table) docs section. In the near future, we are also planning to introduce a predefined Card view component. If you have more specific needs to display data, you can pass your custom implementation as a `DataView` child.
47+
48+
```js file="./PredefinedLayoutExample.tsx"
49+
50+
```
51+
52+
## Advanced concepts
53+
54+
This section contains advanced features related to the `DataView` wrapping component and information to better understand how the data view works under the hood.
55+
56+
### Data view context
57+
58+
The **data view internal context** provides shared state to all sub-components. It lives inside the `DataView` component to store callbacks for the data selection (`onSelect`, `isSelected`, `isSelectDisabled`), internally computed `isSelectable` flag based on selection callbacks passed, and `activeState` of the data view (loading, error, etc.). Its values are set up through props of the `DataView` component.
59+
60+
### Events context
61+
62+
The **data view events context** provides a way of listening to the data view events from the outside of the component through the `DataViewEventsContext`.
63+
64+
In order to give your components an access to the shared context, wrap them and your data view with the `DataViewEventsProvider`.
65+
66+
### Row click subscription example
67+
This example illustrates how to set up a layout that listens for row click events and displays detailed information about the selected row in a [drawer component](/components/drawer).
68+
69+
70+
```js file="./EventsExample.tsx"
71+
72+
```

packages/module/patternfly-docs/content/extensions/data-view/examples/EventsContext/EventsExample.tsx renamed to packages/module/patternfly-docs/content/extensions/data-view/examples/DataView/EventsExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/data-view/examples/Layout/PredefinedLayoutExample.tsx renamed to packages/module/patternfly-docs/content/extensions/data-view/examples/DataView/PredefinedLayoutExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/data-view/examples/EventsContext/EventsContext.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

packages/module/patternfly-docs/content/extensions/data-view/examples/Layout/Layout.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

packages/module/patternfly-docs/content/extensions/data-view/examples/Components/DataViewTableEmptyExample.tsx renamed to packages/module/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableEmptyExample.tsx

File renamed without changes.

packages/module/patternfly-docs/content/extensions/data-view/examples/Components/DataViewTableErrorExample.tsx renamed to packages/module/patternfly-docs/content/extensions/data-view/examples/Table/DataViewTableErrorExample.tsx

File renamed without changes.

0 commit comments

Comments
 (0)