Skip to content

Commit b94e357

Browse files
committed
docs: Add migration guide to v3
1 parent 425fea3 commit b94e357

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The right color picker, but not the framework you're looking for?
6060
* [Usage](#usage)
6161
* [Options](#options)
6262
* [Change log](#change-log)
63+
* [Migration from v2](#migration-from-v2)
6364
* [Migration from v1](#migration-from-v1)
6465
* [Contributing](#contributing)
6566
* [Credits](#credits)
@@ -144,6 +145,27 @@ Please see [Releases][link-releases] for more information on what has changed re
144145

145146
[Back To Top](#quick-links)
146147

148+
## Migration from v2
149+
150+
With v3 the inner circle is now transparent instead of solid white. If you previously relied on that and you prefer to keep the existing behavior you can do that by wrapping the `<color-picker>` with a `<div>` and add white background to it. Here's an example how to do that:
151+
152+
```vue
153+
<template>
154+
<div class="wrapper">
155+
<color-picker :hue="hue" @input="onInput"></color-picker>
156+
</div>
157+
</template>
158+
159+
<style>
160+
.wrapper {
161+
padding: 32px;
162+
background: #fff;
163+
}
164+
</style>
165+
```
166+
167+
[Back To Top](#quick-links)
168+
147169
## Migration from v1
148170

149171
Straight forward - `v-model` becomes `v-bind` and you need to add the `@input` event (which was previously added by the `v-model` directive implicitly).

0 commit comments

Comments
 (0)