@ansible/ansible-ui-framework 0.0.294 → 0.0.296

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.
@@ -1,5 +1,9 @@
1
1
  /// <reference types="react" />
2
2
  import { ITableColumn } from './PageTable';
3
+ /**
4
+ * BulkActionDialogProps
5
+ * @typedef {Object} BulkActionDialogProps
6
+ */
3
7
  export interface BulkActionDialogProps<T extends object> {
4
8
  /** The title of the model.
5
9
  * @link https://www.patternfly.org/v4/components/modal/design-guidelines#confirmation-dialogs
@@ -97,6 +97,13 @@ var PageDialog_1 = require("./PageDialog");
97
97
  var PageTable_1 = require("./PageTable");
98
98
  var useFrameworkTranslations_1 = require("./useFrameworkTranslations");
99
99
  var useTableItems_1 = require("./useTableItems");
100
+ /**
101
+ * BulkActionDialog
102
+ * @param {string} title - The title of the model.
103
+ * @param {Array(T)} items - The items to confirm for the bulk action.
104
+ * @param {function(T) : (string | number)} keyFn - A function that gets a unique key for each item.
105
+ * @param {Array(ITableColumn<T>)} actionColumns - The columns to display when processing the actions.
106
+ */
100
107
  function BulkActionDialog(props) {
101
108
  var title = props.title, items = props.items, keyFn = props.keyFn, actionColumns = props.actionColumns, actionFn = props.actionFn, onComplete = props.onComplete, onClose = props.onClose, processingText = props.processingText, isDanger = props.isDanger;
102
109
  var _a = __read((0, useFrameworkTranslations_1.useFrameworkTranslations)(), 1), translations = _a[0];
@@ -0,0 +1,10 @@
1
+ ## BulkActionDialog(title, items, keyFn, actionColumns)
2
+
3
+ BulkActionDialog
4
+
5
+ | Param | Type | Description |
6
+ | ------------- | ------------------------ | --------------------------------------------------- |
7
+ | title | `string` | The title of the model. |
8
+ | items | `Array(T)` | The items to confirm for the bulk action. |
9
+ | keyFn | `function` | A function that gets a unique key for each item. |
10
+ | actionColumns | `Array(ITableColumn<T>)` | The columns to display when processing the actions. |
@@ -0,0 +1,29 @@
1
+ ## PageHeader(breadcrumbs, title, titleHelpTitle, titleHelp, description, controls, headerActions)
2
+
3
+ PageHeader enables the responsive layout of the header.
4
+
5
+ | Param | Type | Description |
6
+ | -------------- | -------------------- | --------------------------------- |
7
+ | breadcrumbs | `Array.<Breadcrumb>` | The breadcrumbs for the page. |
8
+ | title | `string` | The title of the page. |
9
+ | titleHelpTitle | `string` | The title of help popover. |
10
+ | titleHelp | `ReactNode` | The content for the help popover. |
11
+ | description | `string` | The description of the page. |
12
+ | controls | `ReactNode` | Support for extra page controls. |
13
+ | headerActions | `ReactNode` | The actions for the page. |
14
+
15
+ **Example**
16
+
17
+ ```js
18
+ <Page>
19
+ <PageLayout>
20
+ <PageHeader
21
+ breadcrumbs={[{ label: 'Home', to: '/home' }, { label: 'Page title' }]}
22
+ title='Page title'
23
+ description='Page description'
24
+ headerActions={<PageActions actions={actions} />}
25
+ />
26
+ <PageBody />...</PageBody>
27
+ </PageLayout>
28
+ <Page>
29
+ ```
@@ -0,0 +1,14 @@
1
+ ## PageLayout()
2
+
3
+ PageLayout enables the layout of the page to be responsive.
4
+
5
+ **Example**
6
+
7
+ ```js
8
+ <Page>
9
+ <PageLayout>
10
+ <PageHeader />
11
+ <PageBody />...</PageBody>
12
+ </PageLayout>
13
+ <Page>
14
+ ```
File without changes
File without changes
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@ansible/ansible-ui-framework",
3
3
  "description": "Framework for building consistent responsive web applications using PatternFly.",
4
- "version": "0.0.294",
4
+ "version": "0.0.296",
5
5
  "author": "Red Hat",
6
6
  "license": "MIT",
7
7
  "repository": {