@ansible/ansible-ui-framework 0.0.294 → 0.0.296

package/cjs/BulkActionDialog.d.ts

@@ -1,5 +1,9 @@
 /// <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

@@ -97,6 +97,13 @@ var PageDialog_1 = require("./PageDialog");
 var PageTable_1 = require("./PageTable");
 var useFrameworkTranslations_1 = require("./useFrameworkTranslations");
 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 {Array(ITableColumn<T>)} actionColumns - The columns to display when processing the actions.
+ */
 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;
     var _a = __read((0, useFrameworkTranslations_1.useFrameworkTranslations)(), 1), translations = _a[0];

package/docs/BulkActionDialog.md

@@ -0,0 +1,10 @@
+## BulkActionDialog(title, items, keyFn, actionColumns)
+
+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. |

package/docs/PageHeader.md

@@ -0,0 +1,29 @@
+## PageHeader(breadcrumbs, title, titleHelpTitle, titleHelp, description, controls, headerActions)
+
+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.294",
+  "version": "0.0.296",
   "author": "Red Hat",
   "license": "MIT",
   "repository": {