@availity/mui-page-header 0.2.28 → 0.2.29

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 (8) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.d.mts +28 -0
  3. package/dist/index.d.ts +1 -1
  4. package/dist/index.js +40 -84
  5. package/dist/index.mjs +39 -84
  6. package/jest.config.js +10 -0
  7. package/package.json +15 -15
  8. package/project.json +8 -9
package/CHANGELOG.md CHANGED
@@ -2,6 +2,16 @@
2
2
 
3
3
  This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
4
4
 
5
+ ## [0.2.29](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.28...@availity/mui-page-header@0.2.29) (2024-04-19)
6
+
7
+ ### Dependency Updates
8
+
9
+ * `mui-feedback` updated to version `0.2.28`
10
+ * `mui-breadcrumbs` updated to version `0.2.28`
11
+ * `mui-button` updated to version `0.2.28`
12
+ * `mui-divider` updated to version `0.2.28`
13
+ * `mui-link` updated to version `0.2.28`
14
+ * `mui-typography` updated to version `0.2.28`
5
15
  ## [0.2.28](https://github.com/Availity/element/compare/@availity/mui-page-header@0.2.27...@availity/mui-page-header@0.2.28) (2024-04-15)
6
16
 
7
17
  ### Dependency Updates
package/dist/index.d.mts ADDED
@@ -0,0 +1,28 @@
1
+ import { BreadcrumbsProps } from '@availity/mui-breadcrumbs';
2
+ import { ButtonProps } from '@availity/mui-button';
3
+
4
+ interface ButtonsProps extends Omit<ButtonProps, 'size' | 'height' | 'color'> {
5
+ key: string;
6
+ }
7
+ interface PageHeaderProps {
8
+ /** Render breadcrumbs above the header */
9
+ breadcrumbs: BreadcrumbsProps;
10
+ /** Renders buttons in the right side of the header */
11
+ buttons?: ButtonsProps[];
12
+ /** If true, the Give Feedback button displays
13
+ * @default false
14
+ */
15
+ feedback?: boolean;
16
+ /** The text that displays in the header */
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 */
24
+ helpLink?: string;
25
+ }
26
+ declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpAppName, helpLink, }: PageHeaderProps) => JSX.Element;
27
+
28
+ export { type ButtonsProps, PageHeader, type PageHeaderProps };
package/dist/index.d.ts CHANGED
@@ -25,4 +25,4 @@ interface PageHeaderProps {
25
25
  }
26
26
  declare const PageHeader: ({ breadcrumbs, buttons, feedback, headerText, helpAppName, helpLink, }: PageHeaderProps) => JSX.Element;
27
27
 
28
- export { ButtonsProps, PageHeader, PageHeaderProps };
28
+ export { type ButtonsProps, PageHeader, type PageHeaderProps };
package/dist/index.js CHANGED
@@ -1,10 +1,27 @@
1
1
  "use strict";
2
2
  var __create = Object.create;
3
3
  var __defProp = Object.defineProperty;
4
+ var __defProps = Object.defineProperties;
4
5
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
6
+ var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
5
7
  var __getOwnPropNames = Object.getOwnPropertyNames;
8
+ var __getOwnPropSymbols = Object.getOwnPropertySymbols;
6
9
  var __getProtoOf = Object.getPrototypeOf;
7
10
  var __hasOwnProp = Object.prototype.hasOwnProperty;
11
+ var __propIsEnum = Object.prototype.propertyIsEnumerable;
12
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
13
+ var __spreadValues = (a, b) => {
14
+ for (var prop in b || (b = {}))
15
+ if (__hasOwnProp.call(b, prop))
16
+ __defNormalProp(a, prop, b[prop]);
17
+ if (__getOwnPropSymbols)
18
+ for (var prop of __getOwnPropSymbols(b)) {
19
+ if (__propIsEnum.call(b, prop))
20
+ __defNormalProp(a, prop, b[prop]);
21
+ }
22
+ return a;
23
+ };
24
+ var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
8
25
  var __export = (target, all) => {
9
26
  for (var name in all)
10
27
  __defProp(target, name, { get: all[name], enumerable: true });
@@ -18,6 +35,10 @@ var __copyProps = (to, from, except, desc) => {
18
35
  return to;
19
36
  };
20
37
  var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
38
+ // If the importer is in node compatibility mode or this is not an ESM
39
+ // file that has been converted to a CommonJS file using a Babel-
40
+ // compatible transform (i.e. "__esModule" has not been set), then set
41
+ // "default" to the CommonJS "module.exports" for node compatibility.
21
42
  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
22
43
  mod
23
44
  ));
@@ -48,90 +69,25 @@ var PageHeader = ({
48
69
  helpAppName,
49
70
  helpLink
50
71
  }) => {
51
- return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, {
52
- component: import_Container.default,
53
- container: true,
54
- direction: "column",
55
- marginTop: "1rem",
56
- marginBottom: "1.25rem",
57
- children: [
58
- breadcrumbs || helpLink ? /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, {
59
- direction: "row",
60
- item: true,
61
- container: true,
62
- justifyContent: "space-between",
63
- marginBottom: 4,
64
- children: [
65
- breadcrumbs && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, {
66
- item: true,
67
- children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_breadcrumbs.Breadcrumbs, {
68
- ...breadcrumbs
69
- })
70
- }),
71
- helpLink && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, {
72
- item: true,
73
- marginLeft: 2,
74
- children: /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_mui_typography.Typography, {
75
- variant: "body1",
76
- children: [
77
- "Need help? ",
78
- /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_link.Link, {
79
- href: helpLink,
80
- target: "_blank",
81
- children: "Watch a demo"
82
- }),
83
- " ",
84
- helpAppName ? `for ${helpAppName}` : null
85
- ]
86
- })
87
- })
88
- ]
89
- }) : null,
90
- /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, {
91
- direction: "row",
92
- item: true,
93
- container: true,
94
- marginBottom: 2,
95
- alignItems: "center",
96
- justifyContent: "space-between",
97
- children: [
98
- /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, {
99
- item: true,
100
- children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_typography.Typography, {
101
- variant: "h1",
102
- children: headerText
103
- })
104
- }),
105
- /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, {
106
- item: true,
107
- container: true,
108
- width: "auto",
109
- children: [
110
- buttons && buttons.length > 0 && (buttons == null ? void 0 : buttons.map((buttonProps) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, {
111
- item: true,
112
- marginLeft: 2,
113
- height: "100%",
114
- children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_button.Button, {
115
- ...buttonProps,
116
- size: "large",
117
- color: "secondary"
118
- })
119
- }))),
120
- feedback ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, {
121
- item: true,
122
- marginLeft: 2,
123
- height: "100%",
124
- children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_feedback.Feedback, {
125
- appName: headerText
126
- })
127
- }) : null
128
- ]
129
- })
130
- ]
131
- }),
132
- /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_divider.Divider, {})
133
- ]
134
- });
72
+ return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, { component: import_Container.default, container: true, direction: "column", marginTop: "1rem", marginBottom: "1.25rem", children: [
73
+ breadcrumbs || helpLink ? /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, { direction: "row", item: true, container: true, justifyContent: "space-between", marginBottom: 4, children: [
74
+ breadcrumbs && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, { item: true, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_breadcrumbs.Breadcrumbs, __spreadValues({}, breadcrumbs)) }),
75
+ helpLink && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, { item: true, marginLeft: 2, children: /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_mui_typography.Typography, { variant: "body1", children: [
76
+ "Need help? ",
77
+ /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_link.Link, { href: helpLink, target: "_blank", children: "Watch a demo" }),
78
+ " ",
79
+ helpAppName ? `for ${helpAppName}` : null
80
+ ] }) })
81
+ ] }) : null,
82
+ /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, { direction: "row", item: true, container: true, marginBottom: 2, alignItems: "center", justifyContent: "space-between", children: [
83
+ /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, { item: true, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_typography.Typography, { variant: "h1", children: headerText }) }),
84
+ /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_Grid.default, { item: true, container: true, width: "auto", children: [
85
+ buttons && buttons.length > 0 && (buttons == null ? void 0 : buttons.map((buttonProps) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, { item: true, marginLeft: 2, height: "100%", children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_button.Button, __spreadProps(__spreadValues({}, buttonProps), { size: "large", color: "secondary" })) }))),
86
+ feedback ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Grid.default, { item: true, marginLeft: 2, height: "100%", children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_feedback.Feedback, { appName: headerText }) }) : null
87
+ ] })
88
+ ] }),
89
+ /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_divider.Divider, {})
90
+ ] });
135
91
  };
136
92
  // Annotate the CommonJS export names for ESM import in node:
137
93
  0 && (module.exports = {
package/dist/index.mjs CHANGED
@@ -1,3 +1,23 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __defProps = Object.defineProperties;
3
+ var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
4
+ var __getOwnPropSymbols = Object.getOwnPropertySymbols;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __propIsEnum = Object.prototype.propertyIsEnumerable;
7
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
8
+ var __spreadValues = (a, b) => {
9
+ for (var prop in b || (b = {}))
10
+ if (__hasOwnProp.call(b, prop))
11
+ __defNormalProp(a, prop, b[prop]);
12
+ if (__getOwnPropSymbols)
13
+ for (var prop of __getOwnPropSymbols(b)) {
14
+ if (__propIsEnum.call(b, prop))
15
+ __defNormalProp(a, prop, b[prop]);
16
+ }
17
+ return a;
18
+ };
19
+ var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
20
+
1
21
  // src/lib/PageHeader.tsx
2
22
  import Container from "@mui/material/Container";
3
23
  import Grid from "@mui/material/Grid";
@@ -16,90 +36,25 @@ var PageHeader = ({
16
36
  helpAppName,
17
37
  helpLink
18
38
  }) => {
19
- return /* @__PURE__ */ jsxs(Grid, {
20
- component: Container,
21
- container: true,
22
- direction: "column",
23
- marginTop: "1rem",
24
- marginBottom: "1.25rem",
25
- children: [
26
- breadcrumbs || helpLink ? /* @__PURE__ */ jsxs(Grid, {
27
- direction: "row",
28
- item: true,
29
- container: true,
30
- justifyContent: "space-between",
31
- marginBottom: 4,
32
- children: [
33
- breadcrumbs && /* @__PURE__ */ jsx(Grid, {
34
- item: true,
35
- children: /* @__PURE__ */ jsx(Breadcrumbs, {
36
- ...breadcrumbs
37
- })
38
- }),
39
- helpLink && /* @__PURE__ */ jsx(Grid, {
40
- item: true,
41
- marginLeft: 2,
42
- children: /* @__PURE__ */ jsxs(Typography, {
43
- variant: "body1",
44
- children: [
45
- "Need help? ",
46
- /* @__PURE__ */ jsx(Link, {
47
- href: helpLink,
48
- target: "_blank",
49
- children: "Watch a demo"
50
- }),
51
- " ",
52
- helpAppName ? `for ${helpAppName}` : null
53
- ]
54
- })
55
- })
56
- ]
57
- }) : null,
58
- /* @__PURE__ */ jsxs(Grid, {
59
- direction: "row",
60
- item: true,
61
- container: true,
62
- marginBottom: 2,
63
- alignItems: "center",
64
- justifyContent: "space-between",
65
- children: [
66
- /* @__PURE__ */ jsx(Grid, {
67
- item: true,
68
- children: /* @__PURE__ */ jsx(Typography, {
69
- variant: "h1",
70
- children: headerText
71
- })
72
- }),
73
- /* @__PURE__ */ jsxs(Grid, {
74
- item: true,
75
- container: true,
76
- width: "auto",
77
- children: [
78
- buttons && buttons.length > 0 && (buttons == null ? void 0 : buttons.map((buttonProps) => /* @__PURE__ */ jsx(Grid, {
79
- item: true,
80
- marginLeft: 2,
81
- height: "100%",
82
- children: /* @__PURE__ */ jsx(Button, {
83
- ...buttonProps,
84
- size: "large",
85
- color: "secondary"
86
- })
87
- }))),
88
- feedback ? /* @__PURE__ */ jsx(Grid, {
89
- item: true,
90
- marginLeft: 2,
91
- height: "100%",
92
- children: /* @__PURE__ */ jsx(Feedback, {
93
- appName: headerText
94
- })
95
- }) : null
96
- ]
97
- })
98
- ]
99
- }),
100
- /* @__PURE__ */ jsx(Divider, {})
101
- ]
102
- });
39
+ return /* @__PURE__ */ jsxs(Grid, { component: Container, container: true, direction: "column", marginTop: "1rem", marginBottom: "1.25rem", children: [
40
+ breadcrumbs || helpLink ? /* @__PURE__ */ jsxs(Grid, { direction: "row", item: true, container: true, justifyContent: "space-between", marginBottom: 4, children: [
41
+ breadcrumbs && /* @__PURE__ */ jsx(Grid, { item: true, children: /* @__PURE__ */ jsx(Breadcrumbs, __spreadValues({}, breadcrumbs)) }),
42
+ helpLink && /* @__PURE__ */ jsx(Grid, { item: true, marginLeft: 2, children: /* @__PURE__ */ jsxs(Typography, { variant: "body1", children: [
43
+ "Need help? ",
44
+ /* @__PURE__ */ jsx(Link, { href: helpLink, target: "_blank", children: "Watch a demo" }),
45
+ " ",
46
+ helpAppName ? `for ${helpAppName}` : null
47
+ ] }) })
48
+ ] }) : null,
49
+ /* @__PURE__ */ jsxs(Grid, { direction: "row", item: true, container: true, marginBottom: 2, alignItems: "center", justifyContent: "space-between", children: [
50
+ /* @__PURE__ */ jsx(Grid, { item: true, children: /* @__PURE__ */ jsx(Typography, { variant: "h1", children: headerText }) }),
51
+ /* @__PURE__ */ jsxs(Grid, { item: true, container: true, width: "auto", children: [
52
+ buttons && buttons.length > 0 && (buttons == null ? void 0 : buttons.map((buttonProps) => /* @__PURE__ */ jsx(Grid, { item: true, marginLeft: 2, height: "100%", children: /* @__PURE__ */ jsx(Button, __spreadProps(__spreadValues({}, buttonProps), { size: "large", color: "secondary" })) }))),
53
+ feedback ? /* @__PURE__ */ jsx(Grid, { item: true, marginLeft: 2, height: "100%", children: /* @__PURE__ */ jsx(Feedback, { appName: headerText }) }) : null
54
+ ] })
55
+ ] }),
56
+ /* @__PURE__ */ jsx(Divider, {})
57
+ ] });
103
58
  };
104
59
  export {
105
60
  PageHeader
package/jest.config.js CHANGED
@@ -4,4 +4,14 @@ module.exports = {
4
4
  ...global,
5
5
  displayName: 'page-header',
6
6
  coverageDirectory: '../../coverage/page-header',
7
+ /* TODO: Update to latest Jest snapshotFormat
8
+ * By default Nx has kept the older style of Jest Snapshot formats
9
+ * to prevent breaking of any existing tests with snapshots.
10
+ * It's recommend you update to the latest format.
11
+ * You can do this by removing snapshotFormat property
12
+ * and running tests with --update-snapshot flag.
13
+ * Example: From within the project directory, run "nx test --update-snapshot"
14
+ * More info: https://jestjs.io/docs/upgrading-to-jest29#snapshot-format
15
+ */
16
+ snapshotFormat: { escapeString: true, printBasicPrototype: true },
7
17
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@availity/mui-page-header",
3
- "version": "0.2.28",
3
+ "version": "0.2.29",
4
4
  "description": "Availity MUI PageHeader Component - part of the @availity/element design system",
5
5
  "keywords": [
6
6
  "react",
@@ -32,23 +32,23 @@
32
32
  "publish:canary": "yarn npm publish --access public --tag canary"
33
33
  },
34
34
  "devDependencies": {
35
- "@availity/mui-breadcrumbs": "^0.2.5",
36
- "@availity/mui-button": "^0.6.6",
37
- "@availity/mui-divider": "^0.3.6",
38
- "@availity/mui-link": "^0.2.8",
39
- "@availity/mui-typography": "^0.1.7",
40
- "@mui/material": "^5.14.12",
35
+ "@availity/mui-breadcrumbs": "^0.2.6",
36
+ "@availity/mui-button": "^0.6.7",
37
+ "@availity/mui-divider": "^0.3.7",
38
+ "@availity/mui-link": "^0.2.9",
39
+ "@availity/mui-typography": "^0.1.8",
40
+ "@mui/material": "^5.15.15",
41
41
  "react": "18.2.0",
42
42
  "react-dom": "18.2.0",
43
- "tsup": "^5.12.7",
44
- "typescript": "^4.6.4"
43
+ "tsup": "^8.0.2",
44
+ "typescript": "^5.4.5"
45
45
  },
46
46
  "peerDependencies": {
47
- "@availity/mui-breadcrumbs": "^0.2.5",
48
- "@availity/mui-button": "^0.6.6",
49
- "@availity/mui-divider": "^0.3.6",
50
- "@availity/mui-link": "^0.2.8",
51
- "@availity/mui-typography": "^0.1.7",
47
+ "@availity/mui-breadcrumbs": "^0.2.6",
48
+ "@availity/mui-button": "^0.6.7",
49
+ "@availity/mui-divider": "^0.3.7",
50
+ "@availity/mui-link": "^0.2.9",
51
+ "@availity/mui-typography": "^0.1.8",
52
52
  "@mui/material": "^5.11.9",
53
53
  "react": ">=16.3.0"
54
54
  },
@@ -56,6 +56,6 @@
56
56
  "access": "public"
57
57
  },
58
58
  "dependencies": {
59
- "@availity/mui-feedback": "^0.1.26"
59
+ "@availity/mui-feedback": "^0.1.27"
60
60
  }
61
61
  }
package/project.json CHANGED
@@ -6,10 +6,9 @@
6
6
  "tags": [],
7
7
  "targets": {
8
8
  "lint": {
9
- "executor": "@nrwl/linter:eslint",
9
+ "executor": "@nx/eslint:lint",
10
10
  "options": {
11
11
  "eslintConfig": ".eslintrc.json",
12
- "lintFilePatterns": ["packages/page-header/**/*.{js,ts}"],
13
12
  "silent": false,
14
13
  "fix": false,
15
14
  "cache": true,
@@ -22,20 +21,20 @@
22
21
  }
23
22
  },
24
23
  "test": {
25
- "executor": "@nrwl/jest:jest",
26
- "outputs": ["coverage/page-header"],
24
+ "executor": "@nx/jest:jest",
25
+ "outputs": ["{workspaceRoot}/coverage/page-header"],
27
26
  "options": {
28
- "jestConfig": "packages/page-header/jest.config.js",
29
- "passWithNoTests": true
27
+ "jestConfig": "packages/page-header/jest.config.js"
30
28
  }
31
29
  },
32
30
  "version": {
33
31
  "executor": "@jscutlery/semver:version",
34
32
  "options": {
35
33
  "preset": "conventional",
36
- "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
37
- "tagPrefix": "@availity/${projectName}@",
38
- "trackDeps": true
34
+ "commitMessageFormat": "chore({projectName}): release version ${version} [skip ci]",
35
+ "tagPrefix": "@availity/{projectName}@",
36
+ "trackDeps": true,
37
+ "skipCommitTypes": ["docs"]
39
38
  }
40
39
  }
41
40
  }