-
Notifications
You must be signed in to change notification settings - Fork 198
feat(docs): add v8 migration guide #9333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
feat(docs): add v8 migration guide #9333
Conversation
|
✅ Изменений в собранных файлах нет Commit 1cffcb9 |
👀 Docs deployed
📦 Package ❌yarn add @vkontakte/vkui@Commit 1cffcb9 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #9333 +/- ##
=======================================
Coverage 94.96% 94.96%
=======================================
Files 436 436
Lines 11763 11763
Branches 4329 4329
=======================================
Hits 11171 11171
Misses 592 592
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
SevereCloud
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Наоставлял nit-ов
| Вместо использования `ActionSheetItem` с `mode="cancel"` или `isCancelItem` в качестве `iosCloseItem`, используйте: | ||
|
|
||
| - `slotProps.iosCloseItem` в `ActionSheet` для передачи пропсов в кнопку отмены | ||
| - или проп `iosCloseItem` с компонентом `ActionSheetDefaultIosCloseItem` для полной кастомизации |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - или проп `iosCloseItem` с компонентом `ActionSheetDefaultIosCloseItem` для полной кастомизации | |
| - или свойство `iosCloseItem` с компонентом `ActionSheetDefaultIosCloseItem` для полной кастомизации |
|
|
||
| Вместо использования `ActionSheetItem` с `mode="cancel"` или `isCancelItem` в качестве `iosCloseItem`, используйте: | ||
|
|
||
| - `slotProps.iosCloseItem` в `ActionSheet` для передачи пропсов в кнопку отмены |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - `slotProps.iosCloseItem` в `ActionSheet` для передачи пропсов в кнопку отмены | |
| - `slotProps.iosCloseItem` в `ActionSheet` для передачи свойств в кнопку отмены |
| - Свойство `onClose` переименовано в `onClosed`. | ||
| - Добавлена поддержка `slotProps.iosCloseItem` для упрощения локализации кнопки "Отмена" на iOS. | ||
|
|
||
| Кнопка отмены на iOS рендерится отдельно от списка действий (вне `ActionSheetItem`). Теперь можно передавать пропсы напрямую в `ActionSheetDefaultIosCloseItem` через `slotProps.iosCloseItem` без необходимости создавать обёртку. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Кнопка отмены на iOS рендерится отдельно от списка действий (вне `ActionSheetItem`). Теперь можно передавать пропсы напрямую в `ActionSheetDefaultIosCloseItem` через `slotProps.iosCloseItem` без необходимости создавать обёртку. | |
| Кнопка отмены на iOS рендерится отдельно от списка действий (вне `ActionSheetItem`). Теперь можно передавать свойства напрямую в `ActionSheetDefaultIosCloseItem` через `slotProps.iosCloseItem` без необходимости создавать обёртку. |
| <details> | ||
| <summary>Миграция</summary> | ||
|
|
||
| Если вам нужно сохранить прежнее поведение, явно укажите `imageTheme="dark"`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Если вам нужно сохранить прежнее поведение, явно укажите `imageTheme="dark"`: | |
| Если вам нужно сохранить прежнее поведение, укажите `imageTheme="dark"`: |
| + onChange?: (value: Date) => void | ||
| ``` | ||
|
|
||
| Значение теперь не может быть `undefined`, поэтому проверка на существование значения больше не требуется. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Значение теперь не может быть `undefined`, поэтому проверка на существование значения больше не требуется. | |
| Проверка значения на `undefined` больше не требуется. |
| > 3. То, что можно изменить на месте, подвергнется миграции, о более сложных кейсах вы будете | ||
| > оповещены в консоли по ходу выполнения команды из **п.2**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > 3. То, что можно изменить на месте, подвергнется миграции, о более сложных кейсах вы будете | |
| > оповещены в консоли по ходу выполнения команды из **п.2**. | |
| > 3. Простые изменения подвергнутся миграции, случаи требующие ручных изменений | |
| > будут выведены в консоли |
| > | ||
| > 1. Для начала обновите ваше приложение до новой мажорной версии (**v8**) в соответствии с требованиями | ||
| > вашего пакетного менеджера и среды. | ||
| > 2. Перейдите в директорию с исходниками вашего проекта (обычно это `src/`) и запустите команду `npx @vkontakte/vkui-codemods`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > 2. Перейдите в директорию с исходниками вашего проекта (обычно это `src/`) и запустите команду `npx @vkontakte/vkui-codemods`. | |
| > 2. Перейдите в директорию с исходным кодом вашего проекта (обычно это `src/`) и запустите команду `npx @vkontakte/vkui-codemods`. |
|
|
||
| > **Автоматизация обновления до v8** | ||
| > | ||
| > Для `Typescript`-файлов можно воспользоваться инструментом по автоматической миграции ваших компонентов. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > Для `Typescript`-файлов можно воспользоваться инструментом по автоматической миграции ваших компонентов. | |
| > Для TypeScript файлов можно воспользоваться инструментом по автоматической миграции: |
| > **Автоматизация обновления до v8** | ||
| > | ||
| > Для `Typescript`-файлов можно воспользоваться инструментом по автоматической миграции ваших компонентов. | ||
| > | ||
| > 1. Для начала обновите ваше приложение до новой мажорной версии (**v8**) в соответствии с требованиями | ||
| > вашего пакетного менеджера и среды. | ||
| > 2. Перейдите в директорию с исходниками вашего проекта (обычно это `src/`) и запустите команду `npx @vkontakte/vkui-codemods`. | ||
| > 3. То, что можно изменить на месте, подвергнется миграции, о более сложных кейсах вы будете | ||
| > оповещены в консоли по ходу выполнения команды из **п.2**. | ||
| > |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > **Автоматизация обновления до v8** | |
| > | |
| > Для `Typescript`-файлов можно воспользоваться инструментом по автоматической миграции ваших компонентов. | |
| > | |
| > 1. Для начала обновите ваше приложение до новой мажорной версии (**v8**) в соответствии с требованиями | |
| > вашего пакетного менеджера и среды. | |
| > 2. Перейдите в директорию с исходниками вашего проекта (обычно это `src/`) и запустите команду `npx @vkontakte/vkui-codemods`. | |
| > 3. То, что можно изменить на месте, подвергнется миграции, о более сложных кейсах вы будете | |
| > оповещены в консоли по ходу выполнения команды из **п.2**. | |
| > | |
| > **Автоматическая миграция** | |
| > | |
| > Воспользуйтесь инструментом по автоматической миграции для TypeScript файлов: | |
| > | |
| > 1. Обновите `@vkontakte/vkui` до **v8** | |
| > 2. В директории с исходным кодом (обычно это `src/`) запустите команду `npx @vkontakte/vkui-codemods`. | |
| > 3. Простые изменения сделает codemod, о сложных будет выведено в консоли | |
| > |
| Изменены вертикальные отступы (padding) в компоненте. Теперь они рассчитываются динамически на основе | ||
| высоты поля и высоты строки текста, что делает компонент более компактным. | ||
|
|
||
| Было: `padding: 12px` | ||
|
|
||
| Стало: вертикальный отступ вычисляется как `(размер_поля - высота_строки) / 2`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Изменены вертикальные отступы (padding) в компоненте. Теперь они рассчитываются динамически на основе | |
| высоты поля и высоты строки текста, что делает компонент более компактным. | |
| Было: `padding: 12px` | |
| Стало: вертикальный отступ вычисляется как `(размер_поля - высота_строки) / 2`. | |
| Внутренние отступы синхронизированы с другими элементами форм. Компонент стал компактнее. |
Описание
Добавил migration guide для перехода на v8
Release notes
Документация
v8