From 2e83c8574c8f8d14d49569721c62e1dfbfebde02 Mon Sep 17 00:00:00 2001 From: Adam DeHaven Date: Mon, 30 Oct 2023 10:48:10 -0400 Subject: [PATCH] docs: update migration guide links --- docs/.vitepress/config.ts | 1 - docs/guide/vue-3-migration-guide.md | 131 ---------------------------- docs/index.md | 4 +- 3 files changed, 2 insertions(+), 134 deletions(-) delete mode 100644 docs/guide/vue-3-migration-guide.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 6cafc12614..bc15cda1cc 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -103,7 +103,6 @@ export default defineConfig({ collapsed: false, items: [ { text: 'Migrating to v9', link: '/guide/migrating-to-version-9' }, - { text: 'Migration to Vue 3', link: '/guide/vue-3-migration-guide' }, ] }, { diff --git a/docs/guide/vue-3-migration-guide.md b/docs/guide/vue-3-migration-guide.md deleted file mode 100644 index dd2b5664cd..0000000000 --- a/docs/guide/vue-3-migration-guide.md +++ /dev/null @@ -1,131 +0,0 @@ -# Vue 3 Migration Guide - -This guide is primarily for users of Kongponents `v6/v7` (for Vue 2) who want to browse the breaking changes they may encounter when upgrading to Kongponents `v8` for Vue 3. - -This is not something you have to read from top to bottom before trying out the new version of Kongponents. - -## Breaking Changes - -If you notice other breaking changes we missed, we invite you to [open an issue](https://github.com/Kong/kongponents/issues). - -### KBreadcrumbs - -- New component name; previously known as `Krumbs` - -### KCheckbox - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Emits `input`, `change`, and `update:modelValue` events - -### KComponent - -- New component name; previously known as `Komponent` - -### Krumbs - -- Renamed to `KBreadcrumbs` - - -### KInput - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Emits `input` and `update:modelValue` events -- Default font size is now `16px` for accessibility and to prevent page zoom in some browsers -- `.k-input-medium + .has-error` font-size is now `11px` -- `.k-input-small + .has-error` font-size is now `11px` - -### KInputSwitch - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Emits `input`, `change`, and `update:modelValue` events -- Added the following CSS rule for label alignment - ```scss - &.has-label-left { - margin-right: 0; - margin-left: 16px; - } - ``` - -### KMenu - -- Added type interface for `items` prop - -### KMenuItem - -- Added type interface for `items` prop - -### Komponent - -- Renamed to `KComponent` - -### Kooltip - -- Renamed to `KTooltip` - -### KPagination - -- Added new CSS theming variables - - | Variable | Purpose - |:-------- |:------- - | `--KPaginationColor`| KPagination button text color - | `--KPaginationBackgroundColor`| KPagination button background color - | `--KPaginationBorderColor`| KPagination button border color - | `--KPaginationPageSizeColor`| KPagination page size button text color - | `--KPaginationActiveColor`| KPagination active button text color - | `--KPaginationActiveBackgroundColor`| KPagination active button background color - | `--KPaginationActiveBorderColor`| KPagination active button border color - | `--KPaginationDisabledColor`| KPagination disabled button text color - -### KPrompt - -- Added `autcomplete="off"` and `autocapitalize="off"` to the confirmation text input - -### KRadio - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- `value` prop has been renamed to `selectedValue` -- Emits `change` and `update:modelValue` events - -### KSegmentedControl - -- `v-model` is now mapped to `modelValue` prop instead of `selected` prop -- Added type interface for `options` prop - -### KSelect - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Emits `input`, `change`, and `update:modelValue` events -- `positionFixed` now defaults to `true` - -### KSkeleton - -- Renamed internal component from `Skeleton` to `SkeletonBase` -- `delayMilliseconds` prop now defaults to `0` - -### KSlideout - -- Changed `isVisible` class to `is-visible` - -### KTable - -- `fetcher` is now a required prop - -### KTabs - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Added type interface for `tabs` prop - -### KTextArea - -- `v-model` is now mapped to `modelValue` prop instead of `value` prop -- Emits `input`, `update:modelValue`, and `char-limit-exceeded` events -- Default font size is now `16px` for accessibility and to prevent page zoom in some browsers - -### KToggle - -- In your template, you now need to reference `isToggled.value` when getting/setting the value instead of `isToggled` - -### KTooltip - -- New component name; previously known as `Kooltip` diff --git a/docs/index.md b/docs/index.md index e686692d62..a7f7f5338c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,9 +32,9 @@ features: details: At Kong, we thrive with the open-source community. We're always looking for contributions; feel free to submit a pull request! link: /guide/contributing linkText: Start coding - - title: Migrating to Vue 3? + - title: Migrating from v8.x? details: Our Migration Guide has you covered with a complete list of breaking changes. - link: /guide/vue-3-migration-guide + link: /guide/migrating-to-version-9 linkText: View changes ---