Canvas Kit V6 Deprecations + Migrations

[alanbsmith]

Canvas Kit V6 Deprecations + Migrations

Deprecations

Overivew

• V6 will not include any hard deprecations; all components will be soft-deprecated.
• All deprecations will be handled automatically by the v6 codemod

Deprecation Types

There are two types of deprecations: soft and hard.

Soft Deprecation

A soft-deprecated component is still available with its full functionality, but it will have been renamed with a prefix to indicate its soft-deprecated status. It will also include a console warning to announce its deprecation. This warning will only be triggered on the component's initial render.

Soft-deprecated types and utilities will also be renamed but generally will not trigger a console warning.

Hard Deprecation

A hard-deprecated component or package is no longer available. You will need to follow the method prescribed in our migration guide to update your application. Please reach out to our team directly if you need additional help.

Cookie Banner | View Storybook

Imported from @workday/canvas-kit-react/cookie-banner or @workday/canvas-kit-react

• CookieBanner => DeprecatedCookieBanner
• CookieBannerProps => DeprecatedCookieBannerProps

---

Header and Global Header | View Storybook

Imported from @workday/canvas-kit-labs-react/header or @workday/canvas-kit-labs-react

Note: SearchBar is not being deprecated. It is instead moving to its own package. See [#search-bar] for more information.

• DubLogoTitle, GlobalHeader, Header, and WorkdayLogoTitle will have console warnings
• DubLogoTitle => DeprecatedDubLogoTitle
• GlobalHeader => DeprecatedGlobalHeader
• Header => DeprecatedHeader
• HeaderHeight => DeprecatedHeaderHeight
• HeaderTheme => DeprecatedHeaderTheme
• HeaderVariant => DeprecatedHeaderVariant
• ThemeAttributes => DeprecatedHeaderThemeAttributes
• Themes => DeprecatedHeaderThemes
• WorkdayLogoTitle => DeprecatedWorkdayLogoTitle
• themes => deprecatedHeaderThemes

---

Page Header | View Storybook

Imported from @workday/canvas-kit-react/page-header or @workday/canvas-kit-react

• PageHeader => DeprecatedPageHeaderProps
• PageHeaderProps => DeprecatedPageHeaderProps

Migrations

Overview

• All migrations will be handled automatically by the v6 codemod

Search Bar | View Storybook

Imported from @workday/canvas-kit-labs-react/header or @workday/canvas-kit-labs-react

• Moves SearchBar and related exports to a new labs package: search-form:
  • SearchBar
    - SearchBarProps
  • SearchBarState
  • SearchThemeAttributes
  • SearchThemes
• Renames SearchBar and related exports
  • SearchForm
    - SearchFormProps
  • SearchFormState