@ansible/ansible-ui-framework 0.0.295 → 0.0.297

package/cjs/BulkActionDialog.d.ts

@@ -1,9 +1,5 @@
 /// <reference types="react" />
 import { ITableColumn } from './PageTable';
-/**
- * BulkActionDialogProps
- * @typedef {Object} BulkActionDialogProps
- */
 export interface BulkActionDialogProps<T extends object> {
     /** The title of the model.
      * @link https://www.patternfly.org/v4/components/modal/design-guidelines#confirmation-dialogs

package/cjs/BulkActionDialog.js

@@ -101,8 +101,13 @@ var useTableItems_1 = require("./useTableItems");
  * BulkActionDialog
  * @param {string} title - The title of the model.
  * @param {Array(T)} items - The items to confirm for the bulk action.
- * @param {function(T) : (string | number)} keyFn - A function that gets a unique key for each item.
+ * @param {function} keyFn - A function that gets a unique key for each item.
  * @param {Array(ITableColumn<T>)} actionColumns - The columns to display when processing the actions.
+ * @param {function} actionFn - The action function to perform on each item
+ * @param {function=} onComplete - Callback when all the actions are complete. Returns the successful items.
+ * @param {function=} onClose - Callback called when the dialog closes.
+ * @param {string=} processingText - The text to show for each item when the action is happening.
+ * @param {boolean=} isDanger - Indicates if this is a destructive operation.
  */
 function BulkActionDialog(props) {
     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;

package/docs/BulkActionDialog.md

@@ -0,0 +1,15 @@
+# BulkActionDialog
+
+BulkActionDialog
+
+| Param            | Type                     | Description                                                               |
+| ---------------- | ------------------------ | ------------------------------------------------------------------------- |
+| title            | `string`                 | The title of the model.                                                   |
+| items            | `Array(T)`               | The items to confirm for the bulk action.                                 |
+| keyFn            | `function`               | A function that gets a unique key for each item.                          |
+| actionColumns    | `Array(ITableColumn<T>)` | The columns to display when processing the actions.                       |
+| actionFn         | `function`               | The action function to perform on each item                               |
+| [onComplete]     | `function`               | Callback when all the actions are complete. Returns the successful items. |
+| [onClose]        | `function`               | Callback called when the dialog closes.                                   |
+| [processingText] | `string`                 | The text to show for each item when the action is happening.              |
+| [isDanger]       | `boolean`                | Indicates if this is a destructive operation.                             |

package/docs/PageHeader.md

@@ -0,0 +1,29 @@
+# PageHeader
+
+PageHeader enables the responsive layout of the header.
+
+| Param          | Type                 | Description                       |
+| -------------- | -------------------- | --------------------------------- |
+| breadcrumbs    | `Array.<Breadcrumb>` | The breadcrumbs for the page.     |
+| title          | `string`             | The title of the page.            |
+| titleHelpTitle | `string`             | The title of help popover.        |
+| titleHelp      | `ReactNode`          | The content for the help popover. |
+| description    | `string`             | The description of the page.      |
+| controls       | `ReactNode`          | Support for extra page controls.  |
+| headerActions  | `ReactNode`          | The actions for the page.         |
+
+## Example
+
+```js
+<Page>
+  <PageLayout>
+    <PageHeader
+      breadcrumbs={[{ label: 'Home', to: '/home' }, { label: 'Page title' }]}
+      title='Page title'
+      description='Page description'
+      headerActions={<PageActions actions={actions} />}
+    />
+    <PageBody />...</PageBody>
+  </PageLayout>
+<Page>
+```

package/docs/PageLayout.md

@@ -0,0 +1,14 @@
+# PageLayout
+
+PageLayout enables the layout of the page to be responsive.
+
+## Example
+
+```js
+<Page>
+  <PageLayout>
+    <PageHeader />
+    <PageBody />...</PageBody>
+  </PageLayout>
+<Page>
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ansible/ansible-ui-framework",
   "description": "Framework for building consistent responsive web applications using PatternFly.",
-  "version": "0.0.295",
+  "version": "0.0.297",
   "author": "Red Hat",
   "license": "MIT",
   "repository": {