Skip to content

Commit

Permalink
add table of content
Browse files Browse the repository at this point in the history
  • Loading branch information
sirineJ committed Feb 24, 2025
1 parent a06f83f commit a95f48f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Migration

## Table of Contents
1. [Automated migration](#automated-migration)
2. [From v9.x to v10](#from-v9.x-to-v10)
3. [From v8.x to v9](#from-v8.x-to-v9)
4. [From v7.x to v8](#from-v7.x-to-v8)
5. [From v6.x to v7](#from-v6.x-to-v7)
6. [From v5.x to v6](#from-v5.x-to-v6)
7. [From v4.x to v5](#from-v4.x-to-v5)
8. [From v3.x to v4](#from-v3.x-to-v4)
9. [From v2.x to v3](#from-v2.x-to-v3)
10. [From v1.x to v2](#from-v1.x-to-v2)


## 🤖 Automated migration

Some of the changes in this guide can be automated using the [ESLint](https://circuit.sumup.com/?path=/docs/packages-eslint-plugin-circuit-ui--docs) and [Stylelint](https://circuit.sumup.com/?path=/docs/packages-stylelint-plugin-circuit-ui--docs) plugins. Changes that can be automated are marked with a robot emoji (🤖) and the name of the rule (e.g. _no-deprecated-props_)
Expand All @@ -8,6 +21,10 @@ We encourage you to enable and apply the rules incrementally and review the chan

Prior to v5, codemods were implemented using [jscodeshift](#-codemods-jscodeshift).

## From v9.x to v10



## From v8.x to v9

Circuit UI v9 introduces a [new typeface](#new-typeface), more flexible [typography APIs](#typography-apis), and [stable input components](#stable-components) for colors, dates, and phone numbers. For a complete list of changes, refer to the [changelog](https://github.com/sumup-oss/circuit-ui/blob/main/packages/circuit-ui/CHANGELOG.md).
Expand Down Expand Up @@ -731,6 +748,7 @@ Tip: Provide the `--transform`/`-t` argument at the end of the command, so that
> ./node_modules/.bin/circuit-ui migrate -l JavaScript -l TypeScript -t codemod-name
> ```
## From v4.x to v5
Circuit UI v5 is a maintenance release, primarily removing deprecated components and props.
Expand Down

0 comments on commit a95f48f

Please sign in to comment.