@availity/mui-page-header 0.2.20 → 0.2.21

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.
Files changed (7) hide show
  1. package/CHANGELOG.md +21 -11
  2. package/dist/index.d.ts +13 -1
  3. package/dist/index.js +4 -1
  4. package/dist/index.mjs +4 -1
  5. package/package.json +1 -1
  6. package/src/lib/PageHeader.stories.tsx +6 -0
  7. package/src/lib/PageHeader.tsx +15 -1
package/CHANGELOG.md CHANGED
@@ -2,57 +2,67 @@
2
2
 
3
3
  This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
4
4
 
5
+ ## [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)
6
+
5
7
  ## [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)
6
8
 
7
9
  ### Dependency Updates
8
10
 
9
- * `mui-feedback` updated to version `0.1.19`
11
+ - `mui-feedback` updated to version `0.1.19`
12
+
10
13
  ## [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)
11
14
 
12
15
  ### Dependency Updates
13
16
 
14
- * `mui-feedback` updated to version `0.1.18`
17
+ - `mui-feedback` updated to version `0.1.18`
18
+
15
19
  ## [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)
16
20
 
17
21
  ### Dependency Updates
18
22
 
19
- * `mui-feedback` updated to version `0.1.17`
23
+ - `mui-feedback` updated to version `0.1.17`
24
+
20
25
  ## [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)
21
26
 
22
27
  ### Dependency Updates
23
28
 
24
- * `mui-feedback` updated to version `0.1.16`
25
- * `mui-button` updated to version `0.6.1`
29
+ - `mui-feedback` updated to version `0.1.16`
30
+ - `mui-button` updated to version `0.6.1`
31
+
26
32
  ## [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)
27
33
 
28
34
  ### Dependency Updates
29
35
 
30
- * `mui-feedback` updated to version `0.1.15`
36
+ - `mui-feedback` updated to version `0.1.15`
37
+
31
38
  ## [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)
32
39
 
33
40
  ### Dependency Updates
34
41
 
35
- * `mui-feedback` updated to version `0.1.14`
42
+ - `mui-feedback` updated to version `0.1.14`
43
+
36
44
  ## [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)
37
45
 
38
46
  ### Dependency Updates
39
47
 
40
- * `mui-breadcrumbs` updated to version `0.2.1`
48
+ - `mui-breadcrumbs` updated to version `0.2.1`
49
+
41
50
  ## [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)
42
51
 
43
52
  ### Dependency Updates
44
53
 
45
- * `mui-feedback` updated to version `0.1.13`
54
+ - `mui-feedback` updated to version `0.1.13`
46
55
 
47
56
  ### Bug Fixes
48
57
 
49
- * **mui-block-ui:** merge main branch ([8ec0ca6](https://github.com/Availity/element/commit/8ec0ca617a5b279f3657122e2c7c6b20281e3ebc))
58
+ - **mui-block-ui:** merge main branch ([8ec0ca6](https://github.com/Availity/element/commit/8ec0ca617a5b279f3657122e2c7c6b20281e3ebc))
50
59
 
51
60
  ## [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)
52
61
 
53
62
  ### Dependency Updates
54
63
 
55
- * `mui-feedback` updated to version `0.1.12`
64
+ - `mui-feedback` updated to version `0.1.12`
65
+
56
66
  ## [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)
57
67
 
58
68
  ### Dependency Updates
package/dist/index.d.ts CHANGED
@@ -5,12 +5,24 @@ interface ButtonsProps extends Omit<ButtonProps, 'size' | 'height' | 'color'> {
5
5
  key: string;
6
6
  }
7
7
  interface PageHeaderProps {
8
+ /** Render breadcrumbs above the header */
8
9
  breadcrumbs: BreadcrumbsProps;
10
+ /** Renders buttons in the right side of the header */
9
11
  buttons?: ButtonsProps[];
12
+ /** If true, the Give Feedback button displays
13
+ * @default false
14
+ */
10
15
  feedback?: boolean;
16
+ /** The text that displays in the header */
11
17
  headerText: string;
18
+ /** The name that displays in the help text
19
+ * @example "This App"
20
+ * @returns Need Help? Watch a demo for This App
21
+ */
22
+ helpAppName?: string;
23
+ /** The URL to the Help Demo */
12
24
  helpLink?: string;
13
25
  }
14
- declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpLink, }: PageHeaderProps) => JSX.Element;
26
+ declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpAppName, helpLink, }: PageHeaderProps) => JSX.Element;
15
27
 
16
28
  export { ButtonsProps, PageHeader, PageHeaderProps };
package/dist/index.js CHANGED
@@ -38,6 +38,7 @@ var PageHeader = ({
38
38
  buttons,
39
39
  feedback = false,
40
40
  headerText,
41
+ helpAppName,
41
42
  helpLink
42
43
  }) => {
43
44
  return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_material.Grid, {
@@ -71,7 +72,9 @@ var PageHeader = ({
71
72
  href: helpLink,
72
73
  target: "_blank",
73
74
  children: "Watch a demo"
74
- })
75
+ }),
76
+ " ",
77
+ helpAppName ? `for ${helpAppName}` : null
75
78
  ]
76
79
  })
77
80
  })
package/dist/index.mjs CHANGED
@@ -12,6 +12,7 @@ var PageHeader = ({
12
12
  buttons,
13
13
  feedback = false,
14
14
  headerText,
15
+ helpAppName,
15
16
  helpLink
16
17
  }) => {
17
18
  return /* @__PURE__ */ jsxs(Grid, {
@@ -45,7 +46,9 @@ var PageHeader = ({
45
46
  href: helpLink,
46
47
  target: "_blank",
47
48
  children: "Watch a demo"
48
- })
49
+ }),
50
+ " ",
51
+ helpAppName ? `for ${helpAppName}` : null
49
52
  ]
50
53
  })
51
54
  })
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@availity/mui-page-header",
3
- "version": "0.2.20",
3
+ "version": "0.2.21",
4
4
  "description": "Availity MUI PageHeader Component - part of the @availity/element design system",
5
5
  "keywords": [
6
6
  "react",
package/src/lib/PageHeader.stories.tsx CHANGED
@@ -7,6 +7,12 @@ const meta: Meta<typeof PageHeader> = {
7
7
  title: 'Components/PageHeader/PageHeader',
8
8
  component: PageHeader,
9
9
  tags: ['autodocs'],
10
+ argTypes: {
11
+ helpAppName: {
12
+ if: { global: 'theme', eq: 'legacyBS' },
13
+ },
14
+ },
15
+ args: { helpAppName: 'This App' },
10
16
  };
11
17
 
12
18
  export default meta;
package/src/lib/PageHeader.tsx CHANGED
@@ -11,10 +11,22 @@ export interface ButtonsProps extends Omit<ButtonProps, 'size' | 'height' | 'col
11
11
  }
12
12
 
13
13
  export interface PageHeaderProps {
14
+ /** Render breadcrumbs above the header */
14
15
  breadcrumbs: BreadcrumbsProps;
16
+ /** Renders buttons in the right side of the header */
15
17
  buttons?: ButtonsProps[];
18
+ /** If true, the Give Feedback button displays
19
+ * @default false
20
+ */
16
21
  feedback?: boolean;
22
+ /** The text that displays in the header */
17
23
  headerText: string;
24
+ /** The name that displays in the help text
25
+ * @example "This App"
26
+ * @returns Need Help? Watch a demo for This App
27
+ */
28
+ helpAppName?: string;
29
+ /** The URL to the Help Demo */
18
30
  helpLink?: string;
19
31
  }
20
32
 
@@ -23,6 +35,7 @@ export const PageHeader = ({
23
35
  buttons,
24
36
  feedback = false,
25
37
  headerText,
38
+ helpAppName,
26
39
  helpLink,
27
40
  }: PageHeaderProps): JSX.Element => {
28
41
  return (
@@ -37,7 +50,8 @@ export const PageHeader = ({
37
50
  {helpLink && (
38
51
  <Grid item marginLeft={2}>
39
52
  <Typography variant="body1">
40
- Need help? <Link href={helpLink} target="_blank" children="Watch a demo" />
53
+ Need help? <Link href={helpLink} target="_blank" children="Watch a demo" />{' '}
54
+ {helpAppName ? `for ${helpAppName}` : null}
41
55
  </Typography>
42
56
  </Grid>
43
57
  )}