css/MIGRATING.md

# 16.0.0
In `v16` two major changes happened:

1. All colors got moved to [primer/primitives](https://github.com/primer/primitives). This lets us use the same Primer colors across different libraries.
2. Primer CSS also switched from using SASS variables for colors to CSS variables.
3. By using CSS variables, components, utilities can now switch between different color modes at runtime.

Below a migration guide when updating Primer CSS to `16.0.0`:

## Components

No changes should be needed. Components get updated without automatically without making changes.

## Utility classes

### Text

[`v15`](https://primer.style/css/utilities/colors#text-color-utilities) | `v16`
--- | ---
`.text-gray-dark`         | `.text-primary`
`.text-gray`              | `.text-secondary`
`.text-gray-light`        | `.text-tertiary`
`.text-green`             | `.text-success`
`.text-yellow`            | `.text-warning`
`.text-red`               | `.text-danger`
`.text-white`             | `.text-inverse`
`.text-blue`              | `.link-primary`
`.link-gray-dark`         | `.link-secondary`
`.link-gray`              | `.link-tertiary`
`.text-black`             | n/a
`.text-orange`            | n/a
`.text-orange-light`      | n/a
`.text-purple`            | n/a
`.text-pink`              | n/a

### Icon

`v15` | `v16`
--- | ---
n/a | `.icon-primary`
n/a | `.icon-secondary`
n/a | `.icon-tertiary`
n/a | `.icon-info`
n/a | `.icon-success`
n/a | `.icon-warning`
n/a | `.icon-danger`

### Border

[`v15`](https://primer.style/css/utilities/borders#border-color-utilities) | `v16`
--- | ---
`.border-gray`          | `.border-primary`
`.border-gray-light`    | `.border-secondary`
`.border-gray-dark`     | `.border-tertiary`
`.border-blue`          | `.border-info`
`.border-green`         | `.border-success`
`.border-yellow`        | `.border-warning`
`.border-red`           | `.border-danger`
`.border-white`         | `.border-inverse`
`.border-gray-darker`   | n/a
`.border-blue-light`    | n/a
`.border-red-light`     | n/a
`.border-purple`        | n/a
`.border-black-fade`    | n/a
`.border-white-fade`    | n/a
`.border-white-fade-15` | n/a
`.border-white-fade-30` | n/a
`.border-white-fade-50` | n/a
`.border-white-fade-70` | n/a
`.border-white-fade-85` | n/a

### Background

[`v15`](https://primer.style/css/utilities/colors#background-utilities) | `v16`
--- | ---
`.bg-white`        | `.bg-primary`
`.bg-gray-light`   | `.bg-tertiary`
`.bg-gray`         | `.bg-secondary`
`.bg-gray-dark`    | `.bg-canvas-inverse`
`.bg-blue-light`   | `.bg-info`
`.bg-blue`         | `.bg-info-inverse`
`.bg-green-light`  | `.bg-success`
`.bg-green`        | `.bg-success-inverse`
`.bg-yellow-light` | `.bg-warning`
`.bg-yellow`       | `.bg-warning-inverse`
`.bg-red-light`    | `.bg-danger`
`.bg-red`          | `.bg-danger-inverse`
n/a                | `.bg-canvas`
`.bg-purple-light` | n/a
`.bg-purple`       | n/a
`.bg-yellow-dark`  | n/a
`.bg-orange`       | n/a
`.bg-pink`         | n/a

### Shadow

`v15` | `v16`
--- | ---
`.box-shadow`               | `.shadow-small`
`.box-shadow-medium`        | `.shadow-medium`
`.box-shadow-large`         | `.shadow-large`
`.box-shadow-extra-large`   | `.shadow-extra-large`

## Variables

### Text

`v15` | `v16`
--- | ---
`$text-gray-dark` (`$gray-900`)         | `var(--color-text-primary)`
`$text-gray` (`$gray-600`)              | `var(--color-text-secondary)`
`$text-gray-light` (`$gray-500`)        | `var(--color-text-tertiary)`
`$text-white` (`$white`)                | `var(--color-text-inverse)`
`$text-blue` (`$blue-500`)              | `var(--color-text-link-primary)`
`$text-green` (`$green-600`)            | `var(--color-text-success)`
`$text-red` (`$red-600`)                | `var(--color-text-danger)`
`$text-yellow` (`$yellow-800`)          | `var(--color-text-warning)`
n/a                                     | `var(--color-text-placeholder)`
n/a                                     | `var(--color-text-disabled)`
n/a                                     | `var(--color-text-link-secondary)`
n/a                                     | `var(--color-text-link-tertiary)`
`$text-black` (`$black`)                | n/a
`$text-orange` (`$orange-900`)          | n/a
`$text-orange-light` (`$orange-600`)    | n/a
`$text-purple` (`$purple-500`)          | n/a
`$text-pink` (`$pink-500`)              | n/a

### Icon

`v15` | `v16`
--- | ---
n/a                                     | `var(--color-icon-primary)`
n/a                                     | `var(--color-icon-secondary)`
n/a                                     | `var(--color-icon-tertiary)`
n/a                                     | `var(--color-icon-info)`
n/a                                     | `var(--color-icon-danger)`
n/a                                     | `var(--color-icon-success)`
n/a                                     | `var(--color-icon-warning)`

### Border

`v15` | `v16`
--- | ---
`$border-color` (`$gray-200`)                   | `var(--color-border-primary)`
`$border-gray` (`$gray-200`)                    | `var(--color-border-primary)`
`$border-gray-light` (`lighten($gray-200, 3%)`) | `var(--color-border-primary-light)`
`$border-gray-dark` (`$gray-300`)               | `var(--color-border-secondary)`
`$border-white` (`$white`)                      | `var(--color-border-inverse)`
`$border-blue` (`$blue-500`)                    | `var(--color-border-info)`
`$border-green` (`$green-400`)                  | `var(--color-border-success)`
`$border-red` (`$red-500`)                      | `var(--color-border-danger)`
`$border-yellow` (`$yellow-600`)                | `var(--color-border-warning)`
`$border-gray-darker` (`$gray-700`)     | n/a
`$border-blue-light` (`$blue-200`)      | n/a
`$border-red-light` (`$red-300`)        | n/a
`$border-purple` (`$purple-500`)        | n/a
`$border-black-fade` (`$black-fade-15`) | n/a
`$border-white-fade` (`$white-fade-15`) | n/a
`$border-green-light` (`desaturate($green-300, 40%)`) | n/a

### Background

`v15` | `v16`
--- | ---
`$bg-white`        (`$white`)       | `var(--color-bg-primary)`
`$bg-gray`         (`$gray-100`)    | `var(--color-bg-secondary)`
`$bg-gray-light`   (`$gray-000`)    | `var(--color-bg-tertiary)`
`$bg-gray-dark`    (`$gray-900`)    | `var(--color-bg-canvas-inverse)`
`$bg-red`          (`$red-500`)     | `var(--color-bg-danger-inverse)`
`$bg-red-light`    (`$red-000`)     | `var(--color-bg-danger)`
`$bg-green`        (`$green-500`)   | `var(--color-bg-success-inverse)`
`$bg-green-light`  (`$green-100`)   | `var(--color-bg-success)`
`$bg-blue`         (`$blue-500`)    | `var(--color-bg-info-inverse)`
`$bg-blue-light`   (`$blue-000`)    | `var(--color-bg-info)`
`$bg-yellow`       (`$yellow-500`)  | `var(--color-bg-warning-inverse)`
`$bg-yellow-light` (`$yellow-200`)  | `var(--color-bg-warning)`
n/a                                 | `var(--color-bg-canvas)`
`$bg-black` (`$black`)              | n/a
`$bg-black-fade` (`$black-fade-50`) | n/a
`$bg-orange` (`$orange-700`)        | n/a
`$bg-purple` (`$purple-500`)        | n/a
`$bg-purple-light` (`$purple-000`)  | n/a
`$bg-pink` (`$pink-500`)            | n/a
`$bg-yellow-dark` (`$yellow-700`)   | n/a

### Shadow

`v15` | `v16`
--- | ---
`$box-shadow`               | `var(--color-shadow-small)`
`$box-shadow-medium`        | `var(--color-shadow-medium)`
`$box-shadow-large`         | `var(--color-shadow-large)`
`$box-shadow-extra-large`   | `var(--color-shadow-extra-large)`
`$box-shadow-highlight`     | `var(--color-shadow-highlight)`
`$box-shadow-inset`         | `var(--color-shadow-inset)`
`$box-shadow-focus`         | `var(--color-shadow-focus)`

## Color System

`v15` | `v16`
--- | ---
`$black` | `var(--color-scale-black)`
`$white` | `var(--color-scale-white)`
`$gray-000` | `var(--color-scale-gray-0)`
`$gray-100` | `var(--color-scale-gray-1)`
`$gray-200` | `var(--color-scale-gray-2)`
... | ...
`$pink-700` | `var(--color-scale-pink-7)`
`$pink-800` | `var(--color-scale-pink-8)`
`$pink-900` | `var(--color-scale-pink-9)`

## Not available

If something is not available (n/a), there are a few options to consider:

- If it makes sense, try using what is available.
- If not, you can create the following:
  1. Create a new "app" variable by the color system
  2. Use the new "app" variable with a custom class

---

Happy migrating!


# 12.0.0
The v12 release marks a major transition from small, single-purpose npm packages (`primer-core`, `primer-marketing`, `primer-utilities`, etc.) to a single package — `@primer/css` — which contains all of the SCSS source files in subdirectories. Here's what you need to do to migrate different parts of your app:

## npm
First, install the new package.

```sh
npm install --save @primer/css
```

If you use the `primer` package, all you'll need to do is:

```sh
npm uninstall --save primer
```

If you use other packages, such as `primer-utilities`, you will need to uninstall each one by name or use a command line tool like [jq](https://stedolan.github.io/jq/) to list them:

```sh
jq -r '.dependencies | keys[] | select(.|startswith("primer"))' package.json
```

And, if you're feeling saucy, uninstall them all by piping that to `xargs npm uninstall`. :sparkles:

## Sass
There are a couple of things you'll need to change in your Sass setup when migrating to v12. This section is intentionally vague because environments vary wildly between text editors, Sass implementations, and application frameworks. When in doubt, consult the relevant documentation, and feel free to [file an issue][help] if you think that we can help.

### Sass imports
Generally speaking, all of your Sass `@import` statements can be migrated with the following search-and-replace operations, **in the following order**:

* If you import `primer/index.scss` or `primer`, just replace `primer` with `@primer/css` and you're done!
* Otherwise...
    1. Replace `primer-marketing-` with `@primer/css/marketing/`, e.g.
        * `primer-marketing-buttons/index.scss` becomes `@primer/css/marketing/buttons/index.scss`
        * `primer-marketing-utilities/index.scss` becomes `@primer/css/marketing/utilities/index.scss`
    1. Replace `primer-` with `@primer/css/`, e.g.
        * `primer-markdown/index.scss` becomes `@primer/css/markdown/index.scss`
        * `primer-utilities/index.scss` becomes `@primer/css/utilities/index.scss`
    1. Delete `lib/` from every Primer CSS path, e.g.
        * `primer-forms/lib/form-control.scss` becomes `@primer/css/forms/form-control.scss`
        * `primer-navigation/lib/subnav.scss` becomes `@primer/css/navigation/subnav.scss`

If your text editor supports search and replace regular expressions, the following patterns should work:

| find | replace |
| :--- | :--- |
| `primer-marketing-(\w+)(\/lib)?` | `@primer/css/marketing/$1` |
| `primer-(\w+)(\/lib)?` | `@primer/css/$1` |
| `primer\b` | `@primer/css`

#### `primer-migrate`
You can also use the included [`primer-migrate` script](bin/primer-migrate):

```sh
npx -p @primer/css primer-migrate path/to/**/*.scss
```

### Sass include paths
If you've installed Primer CSS with npm, you very likely already have `node_modules` listed in your Sass `includePaths` option, and you won't need to change anything. :tada:

If you've installed Primer CSS with something _other than_ npm, or you don't know how it was installed, consult the documentation for your setup first, then [let us know][help] if you still can't figure it out.

## Compiled CSS files

The compiled CSS files can be found under `/dist` in case you want to directly link to them.

## Fonts
The marketing-specific font files published in the [`fonts` directory](https://unpkg.com/primer-marketing-support@2.0.0/fonts/) of `primer-marketing-support@2.0.0` are published in the `fonts` directory of `@primer/css`. If you use these fonts, you'll need to do the following:

1. Update any scripts that copy the `.woff` font files from `node_modules/primer-marketing-support/fonts` into your application to look for them in `node_modules/@primer/css/fonts`.
1. Update any webpack (or other bundler) resolution rules that look for fonts in `primer-marketing-support/fonts` to look for them in `@primer/css/fonts`.
1. Customize the [`$marketing-font-path` variable](src/marketing/support/variables.scss#L1) to match the path from which they're served.

[help]: https://github.com/primer/css/issues/new?title=Help!&labels=v12,migration