@availity/mui-page-header 0.2.19 → 0.2.21

package/CHANGELOG.md

@@ -2,52 +2,67 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.2.21](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.20...@availity/mui-page-header@0.2.21) (2024-02-15)
+
+## [0.2.20](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.19...@availity/mui-page-header@0.2.20) (2024-02-06)
+
+### Dependency Updates
+
+- `mui-feedback` updated to version `0.1.19`
+
 ## [0.2.19](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.18...@availity/mui-page-header@0.2.19) (2024-01-31)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.18`
+- `mui-feedback` updated to version `0.1.18`
+
 ## [0.2.18](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.17...@availity/mui-page-header@0.2.18) (2024-01-25)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.17`
+- `mui-feedback` updated to version `0.1.17`
+
 ## [0.2.17](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.16...@availity/mui-page-header@0.2.17) (2024-01-12)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.16`
-* `mui-button` updated to version `0.6.1`
+- `mui-feedback` updated to version `0.1.16`
+- `mui-button` updated to version `0.6.1`
+
 ## [0.2.16](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.15...@availity/mui-page-header@0.2.16) (2024-01-12)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.15`
+- `mui-feedback` updated to version `0.1.15`
+
 ## [0.2.15](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.14...@availity/mui-page-header@0.2.15) (2024-01-09)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.14`
+- `mui-feedback` updated to version `0.1.14`
+
 ## [0.2.14](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.13...@availity/mui-page-header@0.2.14) (2024-01-03)
 
 ### Dependency Updates
 
-* `mui-breadcrumbs` updated to version `0.2.1`
+- `mui-breadcrumbs` updated to version `0.2.1`
+
 ## [0.2.13](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.12...@availity/mui-page-header@0.2.13) (2023-12-27)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.13`
+- `mui-feedback` updated to version `0.1.13`
 
 ### Bug Fixes
 
-* **mui-block-ui:** merge main branch ([8ec0ca6](https://github.com/Availity/element/commit/8ec0ca617a5b279f3657122e2c7c6b20281e3ebc))
+- **mui-block-ui:** merge main branch ([8ec0ca6](https://github.com/Availity/element/commit/8ec0ca617a5b279f3657122e2c7c6b20281e3ebc))
 
 ## [0.2.12](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.11...@availity/mui-page-header@0.2.12) (2023-12-21)
 
 ### Dependency Updates
 
-* `mui-feedback` updated to version `0.1.12`
+- `mui-feedback` updated to version `0.1.12`
+
 ## [0.2.11](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.10...@availity/mui-page-header@0.2.11) (2023-12-15)
 
 ### Dependency Updates

package/dist/index.d.ts

@@ -5,12 +5,24 @@ interface ButtonsProps extends Omit<ButtonProps, 'size' | 'height' | 'color'> {
     key: string;
 }
 interface PageHeaderProps {
+    /** Render breadcrumbs above the header */
     breadcrumbs: BreadcrumbsProps;
+    /** Renders buttons in the right side of the header */
     buttons?: ButtonsProps[];
+    /** If true, the Give Feedback button displays
+     * @default false
+     */
     feedback?: boolean;
+    /** The text that displays in the header  */
     headerText: string;
+    /** The name that displays in the help text
+     * @example "This App"
+     * @returns Need Help? Watch a demo for This App
+     */
+    helpAppName?: string;
+    /** The URL to the Help Demo */
     helpLink?: string;
 }
-declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpLink, }: PageHeaderProps) => JSX.Element;
+declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpAppName, helpLink, }: PageHeaderProps) => JSX.Element;
 
 export { ButtonsProps, PageHeader, PageHeaderProps };

package/dist/index.js

@@ -38,6 +38,7 @@ var PageHeader = ({
   buttons,
   feedback = false,
   headerText,
+  helpAppName,
   helpLink
 }) => {
   return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_material.Grid, {
@@ -71,7 +72,9 @@ var PageHeader = ({
                   href: helpLink,
                   target: "_blank",
                   children: "Watch a demo"
-                })
+                }),
+                " ",
+                helpAppName ? `for ${helpAppName}` : null
               ]
             })
           })

package/dist/index.mjs

@@ -12,6 +12,7 @@ var PageHeader = ({
   buttons,
   feedback = false,
   headerText,
+  helpAppName,
   helpLink
 }) => {
   return /* @__PURE__ */ jsxs(Grid, {
@@ -45,7 +46,9 @@ var PageHeader = ({
                   href: helpLink,
                   target: "_blank",
                   children: "Watch a demo"
-                })
+                }),
+                " ",
+                helpAppName ? `for ${helpAppName}` : null
               ]
             })
           })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/mui-page-header",
-  "version": "0.2.19",
+  "version": "0.2.21",
   "description": "Availity MUI PageHeader Component - part of the @availity/element design system",
   "keywords": [
     "react",
@@ -56,6 +56,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@availity/mui-feedback": "^0.1.18"
+    "@availity/mui-feedback": "^0.1.19"
   }
 }

package/src/lib/PageHeader.stories.tsx

@@ -7,6 +7,12 @@ const meta: Meta<typeof PageHeader> = {
   title: 'Components/PageHeader/PageHeader',
   component: PageHeader,
   tags: ['autodocs'],
+  argTypes: {
+    helpAppName: {
+      if: { global: 'theme', eq: 'legacyBS' },
+    },
+  },
+  args: { helpAppName: 'This App' },
 };
 
 export default meta;

package/src/lib/PageHeader.tsx

@@ -11,10 +11,22 @@ export interface ButtonsProps extends Omit<ButtonProps, 'size' | 'height' | 'col
 }
 
 export interface PageHeaderProps {
+  /** Render breadcrumbs above the header */
   breadcrumbs: BreadcrumbsProps;
+  /** Renders buttons in the right side of the header */
   buttons?: ButtonsProps[];
+  /** If true, the Give Feedback button displays
+   * @default false
+   */
   feedback?: boolean;
+  /** The text that displays in the header  */
   headerText: string;
+  /** The name that displays in the help text
+   * @example "This App"
+   * @returns Need Help? Watch a demo for This App
+   */
+  helpAppName?: string;
+  /** The URL to the Help Demo */
   helpLink?: string;
 }
 
@@ -23,6 +35,7 @@ export const PageHeader = ({
   buttons,
   feedback = false,
   headerText,
+  helpAppName,
   helpLink,
 }: PageHeaderProps): JSX.Element => {
   return (
@@ -37,7 +50,8 @@ export const PageHeader = ({
           {helpLink && (
             <Grid item marginLeft={2}>
               <Typography variant="body1">
-                Need help? <Link href={helpLink} target="_blank" children="Watch a demo" />
+                Need help? <Link href={helpLink} target="_blank" children="Watch a demo" />{' '}
+                {helpAppName ? `for ${helpAppName}` : null}
               </Typography>
             </Grid>
           )}