Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.41 KB

v3-migration.md

File metadata and controls

35 lines (22 loc) · 1.41 KB
Raw

v3 Upgrade Guide

Follow the sections below for upgrading from v2 to v3.

Prerequisites

Moving to v3 of this library requires you to be using v11 of Carbon. Migrating a codebase to Carbon v11 will likely be significantly more involved than upgrading to v3 of this component library. View their migration guide for getting started with that work.

Dependencies

  1. Install @carbon/react and @boomerang-io/carbon-addons-boomerang-react
  2. Optionally uninstall carbon-components-react, carbon-components and any other @carbon packages that are included in @carbon/react .e.g. @carbon/icons-react

Styles

You can import the carbon styles and the ours as follows:

// app.scss
@use "@carbon/react";
@use "@boomerang-io/carbon-addons-boomerang-react/scss/global";

There are a few more advanced use-cases documented in the the readme styles.

JavaScript

You can no longer import Carbon components from our component library. For example, the Button component is not exported and you need to update the imports in your codebase if you used the addons alias.

- import { Button } from "@boomerang-io/carbon-addons-boomerang-react
+ import { Button } from "@carbon/react

That's it though. Our component API has remained unchanged for better or worse.