From ef617b8918eb272359c6a2366354ee64a9f61885 Mon Sep 17 00:00:00 2001 From: Adam DeHaven Date: Wed, 1 Nov 2023 09:31:43 -0400 Subject: [PATCH] docs: update migration guide --- docs/guide/migrating-to-version-9.md | 153 +++++++++++++-------------- 1 file changed, 72 insertions(+), 81 deletions(-) diff --git a/docs/guide/migrating-to-version-9.md b/docs/guide/migrating-to-version-9.md index 396686f0ec..98b4ad4840 100644 --- a/docs/guide/migrating-to-version-9.md +++ b/docs/guide/migrating-to-version-9.md @@ -16,18 +16,18 @@ Kongponents styles are no longer designed to be utilized standalone, separately ### KAlert -#### Structure - -#### Constants, Types & Interfaces - -* `appearances` const is no longer exported by the KAlert component. Instead, you can import `AlertAppearances` from `@kong/kongponents` directly. - #### Props #### Slots #### Events +#### Structure + +#### Constants, Types & Interfaces + +* `appearances` const is no longer exported by the KAlert component. Instead, you can import `AlertAppearances` from `@kong/kongponents` directly. + ### KBadge #### Structure @@ -40,17 +40,8 @@ Kongponents styles are no longer designed to be utilized standalone, separately ### KBreadcrumbs - ### KButton -#### Structure - -* `icon-btn` class has been renamed to `icon-button` - -#### Constants, Types & Interfaces - -* `appearances` and `sizes` constants are no longer exported by the KButton component. Instead, you can import `ButtonAppearances` and `ButtonSizes` from `@kong/kongponents` directly - #### Props * some values `appearance` prop accepts were changed: @@ -68,6 +59,14 @@ Kongponents styles are no longer designed to be utilized standalone, separately * `icon` slot is removed (TODO: [beta]) +#### Structure + +* `icon-btn` class has been renamed to `icon-button` + +#### Constants, Types & Interfaces + +* `appearances` and `sizes` constants are no longer exported by the KButton component. Instead, you can import `ButtonAppearances` and `ButtonSizes` from `@kong/kongponents` directly + ### KCard @@ -76,6 +75,11 @@ Kongponents styles are no longer designed to be utilized standalone, separately ### KCheckbox +#### Props + +* `testMode` prop has been removed +* `help` property of `labelAttributes` prop has been deprecated in favor of `info` + #### Structure * `k-input` class has been changed to `checkbox-input` @@ -83,32 +87,20 @@ Kongponents styles are no longer designed to be utilized standalone, separately * `k-checkbox-description` class has been changed to `checkbox-description` * `has-desc` class has been been changed to `has-description` -#### Constants, Types & Interfaces +### KCodeBlock #### Props -* `testMode` prop has been removed -* `help` property of `labelAttributes` prop has been deprecated in favor of `info` +* New `maxHeight` prop to control the `max-height` of the code block. Defaults to `none` #### Slots #### Events -### KCodeBlock - #### Structure #### Constants, Types & Interfaces -#### Props - -* New `maxHeight` prop to control the `max-height` of the code block. Defaults to `none` - -#### Slots - -#### Events - - ### KCollapse @@ -119,6 +111,16 @@ Kongponents styles are no longer designed to be utilized standalone, separately Component has been renamed to `KDropdown` +#### Props + +* `label` prop has been deprecated in favor of the new `trigger-text` prop (usage is the same) +* `appearance` prop has been changed in favor of the `selectionMenu` prop for the selection menu functionality. `appearance` now controls the underlying `KButton` `appearance` prop (note that default `appearance` for component when `selectionMenu` is `true` changed from `tertiary` to `primary`) +* `buttonAppearance` prop has been removed in favor of `appearance`, still controlling the `KButton` `appearance` prop +* `testMode` prop has been removed +* `icon` prop is removed (TODO: [beta]) +* `caretColor` prop is removed +* `isDangerous` `KDropdownItem` prop has been deprecated in favor of `danger` + #### Structure * `k-dropdown-menu` class has been removed (`k-dropdown` class remains) @@ -139,20 +141,6 @@ Component has been renamed to `KDropdown` * `AppearanceArray` const has been removed * `Appearance` type has been removed -#### Props - -* `label` prop has been deprecated in favor of the new `trigger-text` prop (usage is the same) -* `appearance` prop has been changed in favor of the `selectionMenu` prop for the selection menu functionality. `appearance` now controls the underlying `KButton` `appearance` prop (note that default `appearance` for component when `selectionMenu` is `true` changed from `tertiary` to `primary`) -* `buttonAppearance` prop has been removed in favor of `appearance`, still controlling the `KButton` `appearance` prop -* `testMode` prop has been removed -* `icon` prop is removed (TODO: [beta]) -* `caretColor` prop is removed -* `isDangerous` `KDropdownItem` prop has been deprecated in favor of `danger` - -#### Slots - -#### Events - ### KEmptyState @@ -170,17 +158,6 @@ Component has been renamed to `KDropdown` ### KInput -#### Structure - -* `form-control` class has been removed -* `over-char-limit` class has been removed -* `help` class has been changed to `help-text` - -#### Constants, Types & Interfaces - -* `SizeArray` and `IconPositionArray` constants have been removed -* `Size` and `IconPosition` types have been removed - #### Props * `overlayLabel` prop has been removed @@ -198,34 +175,36 @@ Component has been renamed to `KDropdown` * `icon:click` event has been removed. Instead, when using `before` and/or `after` slots, you can provide your custom click handlers bound to clicks on slotted content. See KInput's [slots](/components/input#after) for more details -### KInputSwitch +#### Structure +* `form-control` class has been removed +* `over-char-limit` class has been removed +* `help` class has been changed to `help-text` -### KLabel +#### Constants, Types & Interfaces -#### Structure +* `SizeArray` and `IconPositionArray` constants have been removed +* `Size` and `IconPosition` types have been removed -* `k-input-label` class has been renamed to `k-label` +### KInputSwitch -#### Constants, Types & Interfaces +### KLabel #### Props * `help` prop has been deprecated in favor of `info` * `testMode` prop has been removed -### KMenu +#### Structure + +* `k-input-label` class has been renamed to `k-label` +### KMenu ### KMethod Badge - ### KModal -#### Structure - -#### Constants, Types & Interfaces - #### Props * New `maxWidth` prop to control the `max-width` of the modal. Defaults to `500px` @@ -234,6 +213,10 @@ Component has been renamed to `KDropdown` #### Events +#### Structure + +#### Constants, Types & Interfaces + ### KModalFullscreen @@ -249,8 +232,6 @@ Component has been renamed to `KDropdown` ### KPrompt -#### Constants, Types & Interfaces - #### Props * New `maxHeight` prop to control the `max-height` of the prompt. Defaults to `400px` @@ -259,7 +240,7 @@ Component has been renamed to `KDropdown` #### Events - +#### Constants, Types & Interfaces ### Komponent @@ -271,31 +252,24 @@ Removed as of `v9`. Use `KTooltip` instead. ### KRadio -#### Structure - -* `k-input` class on the `input[type="radio"]` has been changed to `radio-input` -* `k-radio-default` class has been removed -* `k-radio-card` class has been changed to `radio-card` -* `k-radio-label` class has been changed to `radio-label` -* `k-radio-description` class has been changed to `radio-description` - -#### Constants, Types & Interfaces - #### Props * `testMode` prop has been removed * `type` prop has been deprecated in favor of `card` prop * `help` property of `labelAttributes` prop has been deprecated in favor of `info` -#### Slots +#### Structure -#### Events +* `k-input` class on the `input[type="radio"]` has been changed to `radio-input` +* `k-radio-default` class has been removed +* `k-radio-card` class has been changed to `radio-card` +* `k-radio-label` class has been changed to `radio-label` +* `k-radio-description` class has been changed to `radio-description` ### Krumbs Removed as of `v9`. Use `KBreadcumbs` instead. - ### KSegmentedControl @@ -334,3 +308,20 @@ Removed as of `v9`. Use `KBreadcumbs` instead. ### KView Switcher +