@ansible/ansible-ui-framework 0.0.347 → 0.0.349

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,7 +52,19 @@ export type PageTableProps<T extends object> = {
52
52
  defaultCardSubtitle?: ReactNode;
53
53
  };
54
54
  /**
55
- * PageTable
55
+ * The PageTable component is used for adding a table to a page.
56
+ *
57
+ * See the [Table Guide](docs/guides/PageTableGuide.md).
58
+ *
59
+ * @example
60
+ * ```tsx
61
+ * <Page>
62
+ * <PageLayout>
63
+ * <PageHeader ... />
64
+ * <PageTable ... />
65
+ * </PageLayout>
66
+ * </Page>
67
+ * ```
56
68
  */
57
69
  export declare function PageTable<T extends object>(props: PageTableProps<T>): JSX.Element;
58
70
  type CellFn<T extends object> = (item: T) => ReactNode;
package/cjs/PageTable.js CHANGED
@@ -55,7 +55,19 @@ function TablePage(props) {
55
55
  }
56
56
  exports.TablePage = TablePage;
57
57
  /**
58
- * PageTable
58
+ * The PageTable component is used for adding a table to a page.
59
+ *
60
+ * See the [Table Guide](docs/guides/PageTableGuide.md).
61
+ *
62
+ * @example
63
+ * ```tsx
64
+ * <Page>
65
+ * <PageLayout>
66
+ * <PageHeader ... />
67
+ * <PageTable ... />
68
+ * </PageLayout>
69
+ * </Page>
70
+ * ```
59
71
  */
60
72
  function PageTable(props) {
61
73
  var _a;
@@ -2,8 +2,8 @@
2
2
 
3
3
  # Ansible UI Components
4
4
 
5
- - [BulkActionDialog](BulkActionDialog.md)
6
- - [PageFramework](PageFramework.md)
7
- - [PageHeader](PageHeader.md)
8
- - [PageLayout](PageLayout.md)
9
- - [PageTable](PageTable.md)
5
+ - [BulkActionDialog](components/BulkActionDialog.md)
6
+ - [PageFramework](components/PageFramework.md)
7
+ - [PageHeader](components/PageHeader.md)
8
+ - [PageLayout](components/PageLayout.md)
9
+ - [PageTable](components/PageTable.md)
package/docs/Framework.md CHANGED
@@ -4,7 +4,7 @@ Ansible UI Framework
4
4
 
5
5
  A framework for building applications using [PatternFly](https://www.patternfly.org).
6
6
 
7
- - [Getting Started](GettingStarted.md)
7
+ - [Getting Started](guides/GettingStarted.md)
8
8
  - [Guides](Guides.md)
9
9
  - [Components](Components.md)
10
10
 
package/docs/Guides.md CHANGED
@@ -2,5 +2,5 @@
2
2
 
3
3
  # Ansible UI Guides
4
4
 
5
- - [Getting Started](GettingStarted.md)
6
- - [PageTable Guide](PageTableGuide.md)
5
+ - [Getting Started](guides/GettingStarted.md)
6
+ - [PageTable Guide](guides/PageTableGuide.md)
@@ -2,4 +2,16 @@
2
2
 
3
3
  # PageTable
4
4
 
5
- PageTable
5
+ The PageTable component is used for adding a table to a page.
6
+ See the <a href="docs/guides/PageTableGuide.md">Table Guide</a>.
7
+
8
+ **Example**
9
+
10
+ ```tsx
11
+ <Page>
12
+ <PageLayout>
13
+ <PageHeader ... />
14
+ <PageTable ... />
15
+ </PageLayout>
16
+ </Page>
17
+ ```
@@ -1,4 +1,4 @@
1
- [Ansible UI Framework](Framework.md) ▸ [Guides](Guides.md) ▸ Getting Started
1
+ [Ansible UI Framework](../Framework.md) ▸ [Guides](../Guides.md) ▸ Getting Started
2
2
 
3
3
  # Getting Started
4
4
 
@@ -1,4 +1,4 @@
1
- [Ansible UI Framework](Framework.md) ▸ [Guides](Guides.md) ▸ PageTable
1
+ [Ansible UI Framework](../Framework.md) ▸ [Guides](../Guides.md) ▸ PageTable
2
2
 
3
3
  # PageTable Guide
4
4
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ansible/ansible-ui-framework",
3
3
  "description": "A framework for building applications using PatternFly.",
4
- "version": "0.0.347",
4
+ "version": "0.0.349",
5
5
  "author": "Red Hat",
6
6
  "license": "MIT",
7
7
  "repository": {