@nice-digital/nds-page-header 4.0.6 → 4.0.7-alpha.0

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 (4) hide show
  1. package/es/PageHeader.d.ts +4 -1
  2. package/es/PageHeader.js +5 -2
  3. package/package.json +3 -3
  4. package/scss/page-header.scss +6 -0
package/es/PageHeader.d.ts CHANGED
@@ -3,10 +3,13 @@ import "../scss/page-header.scss";
3
3
  export interface PageHeaderProps {
4
4
  [prop: string]: unknown;
5
5
  useAltHeading?: boolean;
6
+ isFullWidth?: boolean;
6
7
  preheading?: React.ReactNode;
8
+ breadcrumbs?: React.ReactNode;
7
9
  heading: React.ReactNode;
8
- lead?: React.ReactNode;
9
10
  metadata?: React.ReactNode[];
11
+ lead?: React.ReactNode;
12
+ description?: React.ReactNode;
10
13
  cta?: React.ReactNode;
11
14
  }
12
15
  export declare const PageHeader: React.FC<PageHeaderProps>;
package/es/PageHeader.js CHANGED
@@ -15,7 +15,10 @@ exports.PageHeader = void 0;
15
15
  const jsx_runtime_1 = require("react/jsx-runtime");
16
16
  require("../scss/page-header.scss");
17
17
  const PageHeader = (props) => {
18
- const { heading, useAltHeading = false, lead, metadata, cta, preheading } = props, rest = __rest(props, ["heading", "useAltHeading", "lead", "metadata", "cta", "preheading"]);
19
- return ((0, jsx_runtime_1.jsxs)("div", Object.assign({ className: "page-header", "data-component": "page-header" }, rest, { children: [(0, jsx_runtime_1.jsxs)("h1", Object.assign({ className: `page-header__heading ${useAltHeading ? "page-header__heading--alt" : ""}` }, { children: [preheading && ((0, jsx_runtime_1.jsx)("span", Object.assign({ className: "page-header__pre-heading" }, { children: preheading }))), heading] })), lead && (0, jsx_runtime_1.jsx)("p", Object.assign({ className: "page-header__lead" }, { children: lead })), metadata && ((0, jsx_runtime_1.jsx)("ul", Object.assign({ className: "page-header__metadata" }, { children: metadata.map((metadatum, i) => ((0, jsx_runtime_1.jsx)("li", { children: metadatum }, i))) }))), cta && (0, jsx_runtime_1.jsx)("p", Object.assign({ className: "page-header__cta" }, { children: cta }))] })));
18
+ const { useAltHeading = false, isFullWidth = false, preheading, breadcrumbs, heading, metadata, lead, description, cta } = props, rest = __rest(props, ["useAltHeading", "isFullWidth", "preheading", "breadcrumbs", "heading", "metadata", "lead", "description", "cta"]);
19
+ // TODO: Refactor this into some sort of conditional component
20
+ // e.g. https://dev.to/dailydevtips1/conditional-wrapping-in-react-46o5
21
+ const PageHeaderContent = () => ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [breadcrumbs && ((0, jsx_runtime_1.jsx)("div", Object.assign({ className: "page-header__breadcrumbs" }, { children: breadcrumbs }))), (0, jsx_runtime_1.jsxs)("h1", Object.assign({ className: `page-header__heading ${useAltHeading ? "page-header__heading--alt" : ""}` }, { children: [preheading && ((0, jsx_runtime_1.jsx)("span", Object.assign({ className: "page-header__pre-heading" }, { children: preheading }))), heading] })), lead && (0, jsx_runtime_1.jsx)("p", Object.assign({ className: "page-header__lead" }, { children: lead })), description && ((0, jsx_runtime_1.jsx)("div", Object.assign({ className: "page-header__description" }, { children: description }))), metadata && ((0, jsx_runtime_1.jsx)("ul", Object.assign({ className: "page-header__metadata" }, { children: metadata.map((metadatum, i) => ((0, jsx_runtime_1.jsx)("li", { children: metadatum }, i))) }))), cta && (0, jsx_runtime_1.jsx)("p", Object.assign({ className: "page-header__cta" }, { children: cta }))] }));
22
+ return ((0, jsx_runtime_1.jsx)("div", Object.assign({ className: `page-header ${isFullWidth ? "page-header--full-width" : ""}`, "data-component": "page-header" }, rest, { children: isFullWidth ? ((0, jsx_runtime_1.jsx)("div", Object.assign({ className: "container" }, { children: (0, jsx_runtime_1.jsx)(PageHeaderContent, {}) }))) : ((0, jsx_runtime_1.jsx)(PageHeaderContent, {})) })));
20
23
  };
21
24
  exports.PageHeader = PageHeader;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nice-digital/nds-page-header",
3
- "version": "4.0.6",
3
+ "version": "4.0.7-alpha.0",
4
4
  "description": "Page header component for the NICE Design System",
5
5
  "keywords": [
6
6
  "header"
@@ -35,7 +35,7 @@
35
35
  "url": "https://github.com/nice-digital/nice-design-system/issues"
36
36
  },
37
37
  "dependencies": {
38
- "@nice-digital/nds-core": "^4.0.6"
38
+ "@nice-digital/nds-core": "^4.0.7-alpha.0"
39
39
  },
40
40
  "peerDependencies": {
41
41
  "react": "^16 || ^17 || ^18",
@@ -49,5 +49,5 @@
49
49
  "@types/node": "^18.11.9",
50
50
  "typescript": "^4.8.4"
51
51
  },
52
- "gitHead": "04c8392903d506a0b09a52110944b32e449990b0"
52
+ "gitHead": "8b33a79ecc8fa224223615ebe8647378e97936ad"
53
53
  }
package/scss/page-header.scss CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  @use '@nice-digital/nds-core/scss/colours';
6
6
  @use '@nice-digital/nds-core/scss/glyphs';
7
+ @use '@nice-digital/nds-core/scss/layout';
7
8
  @use '@nice-digital/nds-core/scss/media-queries';
8
9
  @use '@nice-digital/nds-core/scss/spacing';
9
10
  @use '@nice-digital/nds-core/scss/typography';
@@ -31,6 +32,11 @@
31
32
  .page-header {
32
33
  margin: utils.rem(0 0 spacing.$x-large 0);
33
34
 
35
+ &--full-width {
36
+ @include layout.fullWidth();
37
+ background: colours.$page-header-full-width-background;
38
+ }
39
+
34
40
  &__pre-heading {
35
41
  @include typography.font-size(h5);
36
42
  display: block;