@workday/canvas-kit-react 5.2.7 → 6.0.0-alpha.0-next.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 (39) hide show
  1. package/cookie-banner/README.md +15 -10
  2. package/cookie-banner/index.ts +3 -3
  3. package/cookie-banner/lib/CookieBanner.tsx +29 -4
  4. package/dist/commonjs/cookie-banner/index.d.ts +3 -3
  5. package/dist/commonjs/cookie-banner/index.d.ts.map +1 -1
  6. package/dist/commonjs/cookie-banner/index.js +1 -1
  7. package/dist/commonjs/cookie-banner/lib/CookieBanner.d.ts +19 -2
  8. package/dist/commonjs/cookie-banner/lib/CookieBanner.d.ts.map +1 -1
  9. package/dist/commonjs/cookie-banner/lib/CookieBanner.js +19 -8
  10. package/dist/commonjs/page-header/index.d.ts +3 -3
  11. package/dist/commonjs/page-header/index.d.ts.map +1 -1
  12. package/dist/commonjs/page-header/index.js +1 -1
  13. package/dist/commonjs/page-header/lib/PageHeader.d.ts +19 -2
  14. package/dist/commonjs/page-header/lib/PageHeader.d.ts.map +1 -1
  15. package/dist/commonjs/page-header/lib/PageHeader.js +18 -7
  16. package/dist/es6/cookie-banner/index.d.ts +3 -3
  17. package/dist/es6/cookie-banner/index.d.ts.map +1 -1
  18. package/dist/es6/cookie-banner/index.js +3 -3
  19. package/dist/es6/cookie-banner/lib/CookieBanner.d.ts +19 -2
  20. package/dist/es6/cookie-banner/lib/CookieBanner.d.ts.map +1 -1
  21. package/dist/es6/cookie-banner/lib/CookieBanner.js +19 -8
  22. package/dist/es6/page-header/index.d.ts +3 -3
  23. package/dist/es6/page-header/index.d.ts.map +1 -1
  24. package/dist/es6/page-header/index.js +3 -3
  25. package/dist/es6/page-header/lib/PageHeader.d.ts +19 -2
  26. package/dist/es6/page-header/lib/PageHeader.d.ts.map +1 -1
  27. package/dist/es6/page-header/lib/PageHeader.js +18 -7
  28. package/package.json +5 -5
  29. package/page-header/README.md +11 -6
  30. package/page-header/index.ts +3 -3
  31. package/page-header/lib/PageHeader.tsx +28 -3
  32. package/ts3.5/dist/commonjs/cookie-banner/index.d.ts +3 -3
  33. package/ts3.5/dist/commonjs/cookie-banner/lib/CookieBanner.d.ts +19 -2
  34. package/ts3.5/dist/commonjs/page-header/index.d.ts +3 -3
  35. package/ts3.5/dist/commonjs/page-header/lib/PageHeader.d.ts +19 -2
  36. package/ts3.5/dist/es6/cookie-banner/index.d.ts +3 -3
  37. package/ts3.5/dist/es6/cookie-banner/lib/CookieBanner.d.ts +19 -2
  38. package/ts3.5/dist/es6/page-header/index.d.ts +3 -3
  39. package/ts3.5/dist/es6/page-header/lib/PageHeader.d.ts +19 -2
@@ -1,4 +1,9 @@
1
- # Canvas Kit Cookie Banner
1
+ # Canvas Kit Cookie Banner (Deprecated)
2
+
3
+ > Note: As of Canvas Kit v6, CookieBanner is being soft-deprecated. It will be hard-deprecated
4
+ > (completely removed) in v7. Please see the
5
+ > [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
6
+ > for more information.
2
7
 
3
8
  Cookie banner component.
4
9
 
@@ -15,28 +20,28 @@ Fixes a cookie banner to the bottom of the web page.
15
20
  Can be configured with a "Cookie Settings" element and a custom notice.
16
21
 
17
22
  ```tsx
18
- import CookieBanner from '@workday/canvas-kit-react/cookie-banner'
23
+ import DeprecatedCookieBanner from '@workday/canvas-kit-react/cookie-banner'
19
24
 
20
- <CookieBanner
25
+ <DeprecatedCookieBanner
21
26
  onAccept={this.onAccept}
22
27
  isClosed={this.state.acceptedCookies}
23
28
  />
24
29
 
25
- <CookieBanner
30
+ <DeprecatedCookieBanner
26
31
  onAccept={this.onAccept}
27
32
  isClosed={this.state.acceptedCookies}
28
33
  onClickSettings={this.openSettings}
29
34
  notice="Custom notice"
30
35
  />
31
36
 
32
- <CookieBanner
37
+ <DeprecatedCookieBanner
33
38
  onAccept={this.onAccept}
34
39
  isClosed={this.state.acceptedCookies}
35
40
  onClickSettings={this.openSettings}
36
- notice={`${CookieBanner.DefaultNotice} This is appended.`}
41
+ notice={`${DeprecatedCookieBanner.DefaultNotice} This is appended.`}
37
42
  />
38
43
 
39
- <CookieBanner
44
+ <DeprecatedCookieBanner
40
45
  onAccept={this.onAccept}
41
46
  isClosed={this.state.acceptedCookies}
42
47
  notice={<Component />}
@@ -51,11 +56,11 @@ import CookieBanner from '@workday/canvas-kit-react/cookie-banner'
51
56
  > without changing your settings, we’ll assume that you are willing to receive cookies.
52
57
 
53
58
  ```tsx
54
- <CookieBanner
59
+ <DeprecatedCookieBanner
55
60
  onAccept={this.onAccept}
56
61
  isClosed={this.state.acceptedCookies}
57
62
  onClickSettings={this.openSettings}
58
- notice={`${CookieBanner.DefaultNotice} This is appended.`}
63
+ notice={`${DeprecatedCookieBanner.DefaultNotice} This is appended.`}
59
64
  />
60
65
  ```
61
66
 
@@ -90,7 +95,7 @@ Default: `undefined`
90
95
 
91
96
  > Custom cookie notice text or element to display.
92
97
 
93
- Default: `CookieBanner.DefaultNotice`
98
+ Default: `DeprecatedCookieBanner.DefaultNotice`
94
99
 
95
100
  #### `settingsLabel: string`
96
101
 
@@ -1,5 +1,5 @@
1
- import CookieBanner from './lib/CookieBanner';
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
2
 
3
- export default CookieBanner;
4
- export {CookieBanner};
3
+ export default DeprecatedCookieBanner;
4
+ export {DeprecatedCookieBanner};
5
5
  export * from './lib/CookieBanner';
@@ -5,7 +5,15 @@ import styled from '@emotion/styled';
5
5
  import {colors, commonColors, type, space} from '@workday/canvas-kit-react/tokens';
6
6
  import {Hyperlink, HyperlinkProps, PrimaryButton} from '@workday/canvas-kit-react/button';
7
7
 
8
- export interface CookieBannerProps {
8
+ /**
9
+ * ### Deprecated Cookie Banner Props
10
+ *
11
+ * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
12
+ * It will be hard-deprecated (completely removed) in v7. Please see the
13
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
14
+ * for more information.
15
+ */
16
+ export interface DeprecatedCookieBannerProps {
9
17
  /**
10
18
  * If true, set the CookieBanner to the closed state.
11
19
  * @default false
@@ -57,7 +65,7 @@ const Banner = styled('div')(
57
65
  padding: `${space.s} 0`,
58
66
  },
59
67
  },
60
- ({isClosed}: Pick<CookieBannerProps, 'isClosed'>) =>
68
+ ({isClosed}: Pick<DeprecatedCookieBannerProps, 'isClosed'>) =>
61
69
  isClosed ? {transform: 'translateY(100%)'} : null
62
70
  );
63
71
 
@@ -95,13 +103,30 @@ const CookieSettings = (props: CookieSettingsProps) => {
95
103
  return <Hyperlink as="button" css={cookieSettingsStyles} {...props} />;
96
104
  };
97
105
 
98
- export default class CookieBanner extends React.Component<CookieBannerProps> {
106
+ /**
107
+ * ### Deprecated Cookie Banner
108
+ *
109
+ * As of Canvas Kit v6, this component is being soft-deprecated.
110
+ * It will be hard-deprecated (completely removed) in v7. Please see the
111
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
112
+ * for more information.
113
+ */
114
+ export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
115
+ componentDidMount() {
116
+ console.warn(
117
+ `This component is being deprecated and will be removed in Canvas Kit V7.\n
118
+ For more information, please see the V6 migration guide:\n
119
+ https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page
120
+ `
121
+ );
122
+ }
123
+
99
124
  public static DefaultNotice =
100
125
  'We use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we’ll assume that you are willing to receive cookies.';
101
126
 
102
127
  public render(): React.ReactNode {
103
128
  const {
104
- notice = CookieBanner.DefaultNotice,
129
+ notice = DeprecatedCookieBanner.DefaultNotice,
105
130
  settingsLabel = 'Cookie Settings',
106
131
  isClosed,
107
132
  onAccept,
@@ -1,5 +1,5 @@
1
- import CookieBanner from './lib/CookieBanner';
2
- export default CookieBanner;
3
- export { CookieBanner };
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
+ export default DeprecatedCookieBanner;
3
+ export { DeprecatedCookieBanner };
4
4
  export * from './lib/CookieBanner';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../cookie-banner/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAC,YAAY,EAAC,CAAC;AACtB,cAAc,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../cookie-banner/index.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,oBAAoB,CAAC;AAExD,eAAe,sBAAsB,CAAC;AACtC,OAAO,EAAC,sBAAsB,EAAC,CAAC;AAChC,cAAc,oBAAoB,CAAC"}
@@ -7,6 +7,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
7
7
  };
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  var CookieBanner_1 = __importDefault(require("./lib/CookieBanner"));
10
- exports.CookieBanner = CookieBanner_1.default;
10
+ exports.DeprecatedCookieBanner = CookieBanner_1.default;
11
11
  exports.default = CookieBanner_1.default;
12
12
  __export(require("./lib/CookieBanner"));
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface CookieBannerProps {
2
+ /**
3
+ * ### Deprecated Cookie Banner Props
4
+ *
5
+ * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedCookieBannerProps {
3
11
  /**
4
12
  * If true, set the CookieBanner to the closed state.
5
13
  * @default false
@@ -24,7 +32,16 @@ export interface CookieBannerProps {
24
32
  */
25
33
  settingsLabel?: string;
26
34
  }
27
- export default class CookieBanner extends React.Component<CookieBannerProps> {
35
+ /**
36
+ * ### Deprecated Cookie Banner
37
+ *
38
+ * As of Canvas Kit v6, this component is being soft-deprecated.
39
+ * It will be hard-deprecated (completely removed) in v7. Please see the
40
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
41
+ * for more information.
42
+ */
43
+ export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
44
+ componentDidMount(): void;
28
45
  static DefaultNotice: string;
29
46
  render(): React.ReactNode;
30
47
  }
@@ -1 +1 @@
1
- {"version":3,"file":"CookieBanner.d.ts","sourceRoot":"","sources":["../../../../cookie-banner/lib/CookieBanner.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAE3D;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAEnE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA8DD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC;IAC1E,OAAc,aAAa,SAC6J;IAEjL,MAAM,IAAI,KAAK,CAAC,SAAS;CAwBjC"}
1
+ {"version":3,"file":"CookieBanner.d.ts","sourceRoot":"","sources":["../../../../cookie-banner/lib/CookieBanner.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAE3D;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAEnE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA8DD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,KAAK,CAAC,SAAS,CAAC,2BAA2B,CAAC;IAC9F,iBAAiB;IASjB,OAAc,aAAa,SAC6J;IAEjL,MAAM,IAAI,KAAK,CAAC,SAAS;CAwBjC"}
@@ -100,20 +100,31 @@ var cookieSettingsStyles = core_1.css({
100
100
  var CookieSettings = function (props) {
101
101
  return core_1.jsx(button_1.Hyperlink, __assign({ as: "button", css: cookieSettingsStyles }, props));
102
102
  };
103
- var CookieBanner = /** @class */ (function (_super) {
104
- __extends(CookieBanner, _super);
105
- function CookieBanner() {
103
+ /**
104
+ * ### Deprecated Cookie Banner
105
+ *
106
+ * As of Canvas Kit v6, this component is being soft-deprecated.
107
+ * It will be hard-deprecated (completely removed) in v7. Please see the
108
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
109
+ * for more information.
110
+ */
111
+ var DeprecatedCookieBanner = /** @class */ (function (_super) {
112
+ __extends(DeprecatedCookieBanner, _super);
113
+ function DeprecatedCookieBanner() {
106
114
  return _super !== null && _super.apply(this, arguments) || this;
107
115
  }
108
- CookieBanner.prototype.render = function () {
109
- var _a = this.props, _b = _a.notice, notice = _b === void 0 ? CookieBanner.DefaultNotice : _b, _c = _a.settingsLabel, settingsLabel = _c === void 0 ? 'Cookie Settings' : _c, isClosed = _a.isClosed, onAccept = _a.onAccept, onClickSettings = _a.onClickSettings, elemProps = __rest(_a, ["notice", "settingsLabel", "isClosed", "onAccept", "onClickSettings"]);
116
+ DeprecatedCookieBanner.prototype.componentDidMount = function () {
117
+ console.warn("This component is being deprecated and will be removed in Canvas Kit V7.\n\n For more information, please see the V6 migration guide:\n\n https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page\n ");
118
+ };
119
+ DeprecatedCookieBanner.prototype.render = function () {
120
+ var _a = this.props, _b = _a.notice, notice = _b === void 0 ? DeprecatedCookieBanner.DefaultNotice : _b, _c = _a.settingsLabel, settingsLabel = _c === void 0 ? 'Cookie Settings' : _c, isClosed = _a.isClosed, onAccept = _a.onAccept, onClickSettings = _a.onClickSettings, elemProps = __rest(_a, ["notice", "settingsLabel", "isClosed", "onAccept", "onClickSettings"]);
110
121
  return (core_1.jsx(Banner, __assign({ isClosed: isClosed }, elemProps),
111
122
  core_1.jsx(BannerItem, null, notice),
112
123
  core_1.jsx(BannerItem, { css: rowStyle },
113
124
  onClickSettings && (core_1.jsx(CookieSettings, { onClick: onClickSettings }, settingsLabel)),
114
125
  core_1.jsx(button_1.PrimaryButton, { onClick: onAccept, grow: true }, "Continue"))));
115
126
  };
116
- CookieBanner.DefaultNotice = 'We use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we’ll assume that you are willing to receive cookies.';
117
- return CookieBanner;
127
+ DeprecatedCookieBanner.DefaultNotice = 'We use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we’ll assume that you are willing to receive cookies.';
128
+ return DeprecatedCookieBanner;
118
129
  }(React.Component));
119
- exports.default = CookieBanner;
130
+ exports.default = DeprecatedCookieBanner;
@@ -1,5 +1,5 @@
1
- import PageHeader from './lib/PageHeader';
2
- export default PageHeader;
3
- export { PageHeader };
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
+ export default DeprecatedPageHeader;
3
+ export { DeprecatedPageHeader };
4
4
  export * from './lib/PageHeader';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page-header/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAE1C,eAAe,UAAU,CAAC;AAC1B,OAAO,EAAC,UAAU,EAAC,CAAC;AACpB,cAAc,kBAAkB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page-header/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,kBAAkB,CAAC;AAEpD,eAAe,oBAAoB,CAAC;AACpC,OAAO,EAAC,oBAAoB,EAAC,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}
@@ -7,6 +7,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
7
7
  };
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  var PageHeader_1 = __importDefault(require("./lib/PageHeader"));
10
- exports.PageHeader = PageHeader_1.default;
10
+ exports.DeprecatedPageHeader = PageHeader_1.default;
11
11
  exports.default = PageHeader_1.default;
12
12
  __export(require("./lib/PageHeader"));
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface PageHeaderProps {
2
+ /**
3
+ * ### Deprecated Page Header Props
4
+ *
5
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedPageHeaderProps {
3
11
  /**
4
12
  * The text of the PageHeader title.
5
13
  */
@@ -15,7 +23,16 @@ export interface PageHeaderProps {
15
23
  */
16
24
  breakpoint?: number;
17
25
  }
18
- export default class PageHeader extends React.Component<PageHeaderProps> {
26
+ /**
27
+ * ### Deprecated Page Header
28
+ *
29
+ * As of Canvas Kit v6, this component is being soft-deprecated.
30
+ * It will be hard-deprecated (completely removed) in v7. Please see the
31
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
32
+ * for more information.
33
+ */
34
+ export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
35
+ componentDidMount(): void;
19
36
  private renderChildren;
20
37
  render(): JSX.Element;
21
38
  }
@@ -1 +1 @@
1
- {"version":3,"file":"PageHeader.d.ts","sourceRoot":"","sources":["../../../../page-header/lib/PageHeader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAkDD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC;IACtE,OAAO,CAAC,cAAc;IAgBf,MAAM;CAad"}
1
+ {"version":3,"file":"PageHeader.d.ts","sourceRoot":"","sources":["../../../../page-header/lib/PageHeader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAkDD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,KAAK,CAAC,SAAS,CAAC,yBAAyB,CAAC;IAC1F,iBAAiB;IASjB,OAAO,CAAC,cAAc;IAgBf,MAAM;CAad"}
@@ -88,12 +88,23 @@ var IconList = styled_1.default('div')({
88
88
  marginRight: tokens_1.space.xxs,
89
89
  },
90
90
  });
91
- var PageHeader = /** @class */ (function (_super) {
92
- __extends(PageHeader, _super);
93
- function PageHeader() {
91
+ /**
92
+ * ### Deprecated Page Header
93
+ *
94
+ * As of Canvas Kit v6, this component is being soft-deprecated.
95
+ * It will be hard-deprecated (completely removed) in v7. Please see the
96
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
97
+ * for more information.
98
+ */
99
+ var DeprecatedPageHeader = /** @class */ (function (_super) {
100
+ __extends(DeprecatedPageHeader, _super);
101
+ function DeprecatedPageHeader() {
94
102
  return _super !== null && _super.apply(this, arguments) || this;
95
103
  }
96
- PageHeader.prototype.renderChildren = function (children) {
104
+ DeprecatedPageHeader.prototype.componentDidMount = function () {
105
+ console.warn("This component is being deprecated and will be removed in Canvas Kit V7.\n\n For more information, please see the V6 migration guide:\n\n https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page\n ");
106
+ };
107
+ DeprecatedPageHeader.prototype.renderChildren = function (children) {
97
108
  return React.Children.map(children, function (child) {
98
109
  if (!React.isValidElement(child)) {
99
110
  return child;
@@ -106,7 +117,7 @@ var PageHeader = /** @class */ (function (_super) {
106
117
  return child;
107
118
  });
108
119
  };
109
- PageHeader.prototype.render = function () {
120
+ DeprecatedPageHeader.prototype.render = function () {
110
121
  // TODO: Standardize on prop spread location (see #150)
111
122
  var _a = this.props, _b = _a.title, title = _b === void 0 ? '' : _b, _c = _a.breakpoint, breakpoint = _c === void 0 ? 768 : _c, _d = _a.capWidth, capWidth = _d === void 0 ? false : _d, children = _a.children, elemProps = __rest(_a, ["title", "breakpoint", "capWidth", "children"]);
112
123
  return (React.createElement(Header, null,
@@ -114,6 +125,6 @@ var PageHeader = /** @class */ (function (_super) {
114
125
  React.createElement(Title, null, title),
115
126
  React.createElement(IconList, null, this.renderChildren(children)))));
116
127
  };
117
- return PageHeader;
128
+ return DeprecatedPageHeader;
118
129
  }(React.Component));
119
- exports.default = PageHeader;
130
+ exports.default = DeprecatedPageHeader;
@@ -1,5 +1,5 @@
1
- import CookieBanner from './lib/CookieBanner';
2
- export default CookieBanner;
3
- export { CookieBanner };
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
+ export default DeprecatedCookieBanner;
3
+ export { DeprecatedCookieBanner };
4
4
  export * from './lib/CookieBanner';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../cookie-banner/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAC,YAAY,EAAC,CAAC;AACtB,cAAc,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../cookie-banner/index.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,oBAAoB,CAAC;AAExD,eAAe,sBAAsB,CAAC;AACtC,OAAO,EAAC,sBAAsB,EAAC,CAAC;AAChC,cAAc,oBAAoB,CAAC"}
@@ -1,4 +1,4 @@
1
- import CookieBanner from './lib/CookieBanner';
2
- export default CookieBanner;
3
- export { CookieBanner };
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
+ export default DeprecatedCookieBanner;
3
+ export { DeprecatedCookieBanner };
4
4
  export * from './lib/CookieBanner';
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface CookieBannerProps {
2
+ /**
3
+ * ### Deprecated Cookie Banner Props
4
+ *
5
+ * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedCookieBannerProps {
3
11
  /**
4
12
  * If true, set the CookieBanner to the closed state.
5
13
  * @default false
@@ -24,7 +32,16 @@ export interface CookieBannerProps {
24
32
  */
25
33
  settingsLabel?: string;
26
34
  }
27
- export default class CookieBanner extends React.Component<CookieBannerProps> {
35
+ /**
36
+ * ### Deprecated Cookie Banner
37
+ *
38
+ * As of Canvas Kit v6, this component is being soft-deprecated.
39
+ * It will be hard-deprecated (completely removed) in v7. Please see the
40
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
41
+ * for more information.
42
+ */
43
+ export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
44
+ componentDidMount(): void;
28
45
  static DefaultNotice: string;
29
46
  render(): React.ReactNode;
30
47
  }
@@ -1 +1 @@
1
- {"version":3,"file":"CookieBanner.d.ts","sourceRoot":"","sources":["../../../../cookie-banner/lib/CookieBanner.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAE3D;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAEnE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA8DD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC;IAC1E,OAAc,aAAa,SAC6J;IAEjL,MAAM,IAAI,KAAK,CAAC,SAAS;CAwBjC"}
1
+ {"version":3,"file":"CookieBanner.d.ts","sourceRoot":"","sources":["../../../../cookie-banner/lib/CookieBanner.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAE3D;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IAEnE;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA8DD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,KAAK,CAAC,SAAS,CAAC,2BAA2B,CAAC;IAC9F,iBAAiB;IASjB,OAAc,aAAa,SAC6J;IAEjL,MAAM,IAAI,KAAK,CAAC,SAAS;CAwBjC"}
@@ -88,20 +88,31 @@ var cookieSettingsStyles = css({
88
88
  var CookieSettings = function (props) {
89
89
  return jsx(Hyperlink, __assign({ as: "button", css: cookieSettingsStyles }, props));
90
90
  };
91
- var CookieBanner = /** @class */ (function (_super) {
92
- __extends(CookieBanner, _super);
93
- function CookieBanner() {
91
+ /**
92
+ * ### Deprecated Cookie Banner
93
+ *
94
+ * As of Canvas Kit v6, this component is being soft-deprecated.
95
+ * It will be hard-deprecated (completely removed) in v7. Please see the
96
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
97
+ * for more information.
98
+ */
99
+ var DeprecatedCookieBanner = /** @class */ (function (_super) {
100
+ __extends(DeprecatedCookieBanner, _super);
101
+ function DeprecatedCookieBanner() {
94
102
  return _super !== null && _super.apply(this, arguments) || this;
95
103
  }
96
- CookieBanner.prototype.render = function () {
97
- var _a = this.props, _b = _a.notice, notice = _b === void 0 ? CookieBanner.DefaultNotice : _b, _c = _a.settingsLabel, settingsLabel = _c === void 0 ? 'Cookie Settings' : _c, isClosed = _a.isClosed, onAccept = _a.onAccept, onClickSettings = _a.onClickSettings, elemProps = __rest(_a, ["notice", "settingsLabel", "isClosed", "onAccept", "onClickSettings"]);
104
+ DeprecatedCookieBanner.prototype.componentDidMount = function () {
105
+ console.warn("This component is being deprecated and will be removed in Canvas Kit V7.\n\n For more information, please see the V6 migration guide:\n\n https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page\n ");
106
+ };
107
+ DeprecatedCookieBanner.prototype.render = function () {
108
+ var _a = this.props, _b = _a.notice, notice = _b === void 0 ? DeprecatedCookieBanner.DefaultNotice : _b, _c = _a.settingsLabel, settingsLabel = _c === void 0 ? 'Cookie Settings' : _c, isClosed = _a.isClosed, onAccept = _a.onAccept, onClickSettings = _a.onClickSettings, elemProps = __rest(_a, ["notice", "settingsLabel", "isClosed", "onAccept", "onClickSettings"]);
98
109
  return (jsx(Banner, __assign({ isClosed: isClosed }, elemProps),
99
110
  jsx(BannerItem, null, notice),
100
111
  jsx(BannerItem, { css: rowStyle },
101
112
  onClickSettings && (jsx(CookieSettings, { onClick: onClickSettings }, settingsLabel)),
102
113
  jsx(PrimaryButton, { onClick: onAccept, grow: true }, "Continue"))));
103
114
  };
104
- CookieBanner.DefaultNotice = 'We use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we’ll assume that you are willing to receive cookies.';
105
- return CookieBanner;
115
+ DeprecatedCookieBanner.DefaultNotice = 'We use cookies to ensure that we give you the best experience on our website. If you continue without changing your settings, we’ll assume that you are willing to receive cookies.';
116
+ return DeprecatedCookieBanner;
106
117
  }(React.Component));
107
- export default CookieBanner;
118
+ export default DeprecatedCookieBanner;
@@ -1,5 +1,5 @@
1
- import PageHeader from './lib/PageHeader';
2
- export default PageHeader;
3
- export { PageHeader };
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
+ export default DeprecatedPageHeader;
3
+ export { DeprecatedPageHeader };
4
4
  export * from './lib/PageHeader';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page-header/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAE1C,eAAe,UAAU,CAAC;AAC1B,OAAO,EAAC,UAAU,EAAC,CAAC;AACpB,cAAc,kBAAkB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page-header/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,kBAAkB,CAAC;AAEpD,eAAe,oBAAoB,CAAC;AACpC,OAAO,EAAC,oBAAoB,EAAC,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}
@@ -1,4 +1,4 @@
1
- import PageHeader from './lib/PageHeader';
2
- export default PageHeader;
3
- export { PageHeader };
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
+ export default DeprecatedPageHeader;
3
+ export { DeprecatedPageHeader };
4
4
  export * from './lib/PageHeader';
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface PageHeaderProps {
2
+ /**
3
+ * ### Deprecated Page Header Props
4
+ *
5
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedPageHeaderProps {
3
11
  /**
4
12
  * The text of the PageHeader title.
5
13
  */
@@ -15,7 +23,16 @@ export interface PageHeaderProps {
15
23
  */
16
24
  breakpoint?: number;
17
25
  }
18
- export default class PageHeader extends React.Component<PageHeaderProps> {
26
+ /**
27
+ * ### Deprecated Page Header
28
+ *
29
+ * As of Canvas Kit v6, this component is being soft-deprecated.
30
+ * It will be hard-deprecated (completely removed) in v7. Please see the
31
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
32
+ * for more information.
33
+ */
34
+ export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
35
+ componentDidMount(): void;
19
36
  private renderChildren;
20
37
  render(): JSX.Element;
21
38
  }
@@ -1 +1 @@
1
- {"version":3,"file":"PageHeader.d.ts","sourceRoot":"","sources":["../../../../page-header/lib/PageHeader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAkDD,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC;IACtE,OAAO,CAAC,cAAc;IAgBf,MAAM;CAad"}
1
+ {"version":3,"file":"PageHeader.d.ts","sourceRoot":"","sources":["../../../../page-header/lib/PageHeader.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAK/B;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAkDD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,KAAK,CAAC,SAAS,CAAC,yBAAyB,CAAC;IAC1F,iBAAiB;IASjB,OAAO,CAAC,cAAc;IAgBf,MAAM;CAad"}
@@ -76,12 +76,23 @@ var IconList = styled('div')({
76
76
  marginRight: space.xxs,
77
77
  },
78
78
  });
79
- var PageHeader = /** @class */ (function (_super) {
80
- __extends(PageHeader, _super);
81
- function PageHeader() {
79
+ /**
80
+ * ### Deprecated Page Header
81
+ *
82
+ * As of Canvas Kit v6, this component is being soft-deprecated.
83
+ * It will be hard-deprecated (completely removed) in v7. Please see the
84
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
85
+ * for more information.
86
+ */
87
+ var DeprecatedPageHeader = /** @class */ (function (_super) {
88
+ __extends(DeprecatedPageHeader, _super);
89
+ function DeprecatedPageHeader() {
82
90
  return _super !== null && _super.apply(this, arguments) || this;
83
91
  }
84
- PageHeader.prototype.renderChildren = function (children) {
92
+ DeprecatedPageHeader.prototype.componentDidMount = function () {
93
+ console.warn("This component is being deprecated and will be removed in Canvas Kit V7.\n\n For more information, please see the V6 migration guide:\n\n https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page\n ");
94
+ };
95
+ DeprecatedPageHeader.prototype.renderChildren = function (children) {
85
96
  return React.Children.map(children, function (child) {
86
97
  if (!React.isValidElement(child)) {
87
98
  return child;
@@ -94,7 +105,7 @@ var PageHeader = /** @class */ (function (_super) {
94
105
  return child;
95
106
  });
96
107
  };
97
- PageHeader.prototype.render = function () {
108
+ DeprecatedPageHeader.prototype.render = function () {
98
109
  // TODO: Standardize on prop spread location (see #150)
99
110
  var _a = this.props, _b = _a.title, title = _b === void 0 ? '' : _b, _c = _a.breakpoint, breakpoint = _c === void 0 ? 768 : _c, _d = _a.capWidth, capWidth = _d === void 0 ? false : _d, children = _a.children, elemProps = __rest(_a, ["title", "breakpoint", "capWidth", "children"]);
100
111
  return (React.createElement(Header, null,
@@ -102,6 +113,6 @@ var PageHeader = /** @class */ (function (_super) {
102
113
  React.createElement(Title, null, title),
103
114
  React.createElement(IconList, null, this.renderChildren(children)))));
104
115
  };
105
- return PageHeader;
116
+ return DeprecatedPageHeader;
106
117
  }(React.Component));
107
- export default PageHeader;
118
+ export default DeprecatedPageHeader;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-react",
3
- "version": "5.2.7",
3
+ "version": "6.0.0-alpha.0-next.21+5558f5a3",
4
4
  "description": "The parent module that contains all Workday Canvas Kit React components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -57,9 +57,9 @@
57
57
  "@popperjs/core": "^2.5.4",
58
58
  "@workday/canvas-colors-web": "^2.0.0",
59
59
  "@workday/canvas-depth-web": "^0.16.4",
60
- "@workday/canvas-kit-labs-react": "^5.2.7",
61
- "@workday/canvas-kit-popup-stack": "^5.2.7",
62
- "@workday/canvas-kit-preview-react": "^5.2.7",
60
+ "@workday/canvas-kit-labs-react": "^6.0.0-alpha.0-next.21+5558f5a3",
61
+ "@workday/canvas-kit-popup-stack": "^6.0.0-alpha.0-next.21+5558f5a3",
62
+ "@workday/canvas-kit-preview-react": "^6.0.0-alpha.0-next.21+5558f5a3",
63
63
  "@workday/canvas-system-icons-web": "1.0.41",
64
64
  "@workday/design-assets-types": "^0.2.4",
65
65
  "chroma-js": "^2.1.0",
@@ -75,5 +75,5 @@
75
75
  "@workday/canvas-accent-icons-web": "^1.0.0",
76
76
  "@workday/canvas-applet-icons-web": "^0.17.50"
77
77
  },
78
- "gitHead": "def0edbf49b84470fd7b57254dc09ef9dd23d99a"
78
+ "gitHead": "5558f5a3d383ac1a39b2703152a2985d3cabe57b"
79
79
  }
@@ -1,4 +1,9 @@
1
- # Canvas Kit Page Header
1
+ # Canvas Kit Page Header (Deprecated)
2
+
3
+ > Note: As of Canvas Kit v6, PageHeader is being soft-deprecated. It will be hard-deprecated
4
+ > (completely removed) in v7. Please see the
5
+ > [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
6
+ > for more information.
2
7
 
3
8
  A Canvas component that displays the header of a specific page within a website or application. It
4
9
  is generally used as a sub-header to the main application header
@@ -16,19 +21,19 @@ yarn add @workday/canvas-kit-react
16
21
 
17
22
  ```tsx
18
23
  import * as React from 'react';
19
- import {PageHeader} from '@workday/canvas-kit-react/page-header';
24
+ import {DeprecatedPageHeader} from '@workday/canvas-kit-react/page-header';
20
25
  import {IconButton} from '@workday/canvas-kit-react/button';
21
26
  import {exportIcon, fullscreenIcon} from '@workday/canvas-system-icons-web';
22
27
 
23
- <PageHeader title="Product">
28
+ <DeprecatedPageHeader title="Product">
24
29
  <IconButton icon={exportIcon} />
25
30
  <IconButton icon={fullscreenIcon} />
26
- </PageHeader>
31
+ </DeprecatedPageHeader>
27
32
 
28
- <PageHeader title="With Cap Width" capWidth={true}>
33
+ <DeprecatedPageHeader title="With Cap Width" capWidth={true}>
29
34
  <IconButton icon={exportIcon} />
30
35
  <IconButton icon={fullscreenIcon} />
31
- </PageHeader>
36
+ </DeprecatedPageHeader>
32
37
  ```
33
38
 
34
39
  ## Static Properties
@@ -1,5 +1,5 @@
1
- import PageHeader from './lib/PageHeader';
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
2
 
3
- export default PageHeader;
4
- export {PageHeader};
3
+ export default DeprecatedPageHeader;
4
+ export {DeprecatedPageHeader};
5
5
  export * from './lib/PageHeader';
@@ -3,7 +3,15 @@ import styled from '@emotion/styled';
3
3
  import {colors, gradients, space, type} from '@workday/canvas-kit-react/tokens';
4
4
  import {IconButton, IconButtonProps} from '@workday/canvas-kit-react/button';
5
5
 
6
- export interface PageHeaderProps {
6
+ /**
7
+ * ### Deprecated Page Header Props
8
+ *
9
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
10
+ * It will be hard-deprecated (completely removed) in v7. Please see the
11
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
12
+ * for more information.
13
+ */
14
+ export interface DeprecatedPageHeaderProps {
7
15
  /**
8
16
  * The text of the PageHeader title.
9
17
  */
@@ -28,7 +36,7 @@ const Header = styled('header')({
28
36
  MozOsxFontSmoothing: 'grayscale',
29
37
  });
30
38
 
31
- const Container = styled('div')<Pick<PageHeaderProps, 'breakpoint' | 'capWidth'>>(
39
+ const Container = styled('div')<Pick<DeprecatedPageHeaderProps, 'breakpoint' | 'capWidth'>>(
32
40
  {
33
41
  display: 'flex',
34
42
  alignItems: 'center',
@@ -68,7 +76,24 @@ const IconList = styled('div')({
68
76
  },
69
77
  });
70
78
 
71
- export default class PageHeader extends React.Component<PageHeaderProps> {
79
+ /**
80
+ * ### Deprecated Page Header
81
+ *
82
+ * As of Canvas Kit v6, this component is being soft-deprecated.
83
+ * It will be hard-deprecated (completely removed) in v7. Please see the
84
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
85
+ * for more information.
86
+ */
87
+ export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
88
+ componentDidMount() {
89
+ console.warn(
90
+ `This component is being deprecated and will be removed in Canvas Kit V7.\n
91
+ For more information, please see the V6 migration guide:\n
92
+ https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page
93
+ `
94
+ );
95
+ }
96
+
72
97
  private renderChildren(children: React.ReactNode): React.ReactNode {
73
98
  return React.Children.map(children, child => {
74
99
  if (!React.isValidElement(child)) {
@@ -1,5 +1,5 @@
1
- import CookieBanner from './lib/CookieBanner';
2
- export default CookieBanner;
3
- export { CookieBanner };
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
+ export default DeprecatedCookieBanner;
3
+ export { DeprecatedCookieBanner };
4
4
  export * from './lib/CookieBanner';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface CookieBannerProps {
2
+ /**
3
+ * ### Deprecated Cookie Banner Props
4
+ *
5
+ * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedCookieBannerProps {
3
11
  /**
4
12
  * If true, set the CookieBanner to the closed state.
5
13
  * @default false
@@ -24,7 +32,16 @@ export interface CookieBannerProps {
24
32
  */
25
33
  settingsLabel?: string;
26
34
  }
27
- export default class CookieBanner extends React.Component<CookieBannerProps> {
35
+ /**
36
+ * ### Deprecated Cookie Banner
37
+ *
38
+ * As of Canvas Kit v6, this component is being soft-deprecated.
39
+ * It will be hard-deprecated (completely removed) in v7. Please see the
40
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
41
+ * for more information.
42
+ */
43
+ export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
44
+ componentDidMount(): void;
28
45
  static DefaultNotice: string;
29
46
  render(): React.ReactNode;
30
47
  }
@@ -1,5 +1,5 @@
1
- import PageHeader from './lib/PageHeader';
2
- export default PageHeader;
3
- export { PageHeader };
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
+ export default DeprecatedPageHeader;
3
+ export { DeprecatedPageHeader };
4
4
  export * from './lib/PageHeader';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface PageHeaderProps {
2
+ /**
3
+ * ### Deprecated Page Header Props
4
+ *
5
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedPageHeaderProps {
3
11
  /**
4
12
  * The text of the PageHeader title.
5
13
  */
@@ -15,7 +23,16 @@ export interface PageHeaderProps {
15
23
  */
16
24
  breakpoint?: number;
17
25
  }
18
- export default class PageHeader extends React.Component<PageHeaderProps> {
26
+ /**
27
+ * ### Deprecated Page Header
28
+ *
29
+ * As of Canvas Kit v6, this component is being soft-deprecated.
30
+ * It will be hard-deprecated (completely removed) in v7. Please see the
31
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
32
+ * for more information.
33
+ */
34
+ export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
35
+ componentDidMount(): void;
19
36
  private renderChildren;
20
37
  render(): JSX.Element;
21
38
  }
@@ -1,5 +1,5 @@
1
- import CookieBanner from './lib/CookieBanner';
2
- export default CookieBanner;
3
- export { CookieBanner };
1
+ import DeprecatedCookieBanner from './lib/CookieBanner';
2
+ export default DeprecatedCookieBanner;
3
+ export { DeprecatedCookieBanner };
4
4
  export * from './lib/CookieBanner';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface CookieBannerProps {
2
+ /**
3
+ * ### Deprecated Cookie Banner Props
4
+ *
5
+ * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedCookieBannerProps {
3
11
  /**
4
12
  * If true, set the CookieBanner to the closed state.
5
13
  * @default false
@@ -24,7 +32,16 @@ export interface CookieBannerProps {
24
32
  */
25
33
  settingsLabel?: string;
26
34
  }
27
- export default class CookieBanner extends React.Component<CookieBannerProps> {
35
+ /**
36
+ * ### Deprecated Cookie Banner
37
+ *
38
+ * As of Canvas Kit v6, this component is being soft-deprecated.
39
+ * It will be hard-deprecated (completely removed) in v7. Please see the
40
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
41
+ * for more information.
42
+ */
43
+ export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
44
+ componentDidMount(): void;
28
45
  static DefaultNotice: string;
29
46
  render(): React.ReactNode;
30
47
  }
@@ -1,5 +1,5 @@
1
- import PageHeader from './lib/PageHeader';
2
- export default PageHeader;
3
- export { PageHeader };
1
+ import DeprecatedPageHeader from './lib/PageHeader';
2
+ export default DeprecatedPageHeader;
3
+ export { DeprecatedPageHeader };
4
4
  export * from './lib/PageHeader';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,13 @@
1
1
  import * as React from 'react';
2
- export interface PageHeaderProps {
2
+ /**
3
+ * ### Deprecated Page Header Props
4
+ *
5
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
6
+ * It will be hard-deprecated (completely removed) in v7. Please see the
7
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
8
+ * for more information.
9
+ */
10
+ export interface DeprecatedPageHeaderProps {
3
11
  /**
4
12
  * The text of the PageHeader title.
5
13
  */
@@ -15,7 +23,16 @@ export interface PageHeaderProps {
15
23
  */
16
24
  breakpoint?: number;
17
25
  }
18
- export default class PageHeader extends React.Component<PageHeaderProps> {
26
+ /**
27
+ * ### Deprecated Page Header
28
+ *
29
+ * As of Canvas Kit v6, this component is being soft-deprecated.
30
+ * It will be hard-deprecated (completely removed) in v7. Please see the
31
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
32
+ * for more information.
33
+ */
34
+ export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
35
+ componentDidMount(): void;
19
36
  private renderChildren;
20
37
  render(): JSX.Element;
21
38
  }