@rancher/shell 1.2.0 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rancher/shell",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Rancher Dashboard Shell",
   "repository": "https://github.com/rancherlabs/dashboard",
   "license": "Apache-2.0",

package/rancher-components/BadgeState/BadgeState.vue

@@ -1,5 +1,5 @@
 <script lang="ts">
-import { PropType, defineComponent } from 'vue';
+import Vue, { PropType } from 'vue';
 
 interface Badge {
   stateBackground: string;
@@ -11,7 +11,7 @@ interface Badge {
  * <p>Represents a badge whose label and color is either taken from the value property or
  * from the label and color properties. The state property takes precedence.</p>
  */
-export default defineComponent({
+export default Vue.extend({
   props: {
     /**
      * A value having the properties `stateBackground` and `stateDisplay`
@@ -59,7 +59,7 @@ export default defineComponent({
 </script>
 
 <template>
-  <span :class="['badge-state', bg]">
+  <span :class="{'badge-state': true, [bg]: true}">
     <i
       v-if="icon"
       class="icon"

package/rancher-components/Banner/Banner.test.ts

@@ -1,12 +1,16 @@
 import { mount } from '@vue/test-utils';
 import { Banner } from './index';
+import { cleanHtmlDirective } from '@shell/plugins/clean-html-directive';
 
 describe('component: Banner', () => {
   it('should display text based on label', () => {
     const label = 'test';
     const wrapper = mount(
       Banner,
-      { propsData: { label } });
+      {
+        directives: { cleanHtmlDirective },
+        propsData:  { label }
+      });
 
     const element = wrapper.find('span').element;
 

package/rancher-components/Banner/Banner.vue

@@ -1,9 +1,9 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
+import Vue from 'vue';
 import { nlToBr } from '@shell/utils/string';
 import { stringify } from '@shell/utils/error';
 
-export default defineComponent({
+export default Vue.extend({
   props: {
     /**
      * A color class that represents the color of the banner.

package/rancher-components/Card/Card.vue

@@ -1,7 +1,7 @@
 <script lang="ts">
-import { defineComponent, PropType } from 'vue';
+import Vue from 'vue';
 
-export default defineComponent({
+export default Vue.extend({
   name:  'Card',
   props: {
     /**
@@ -22,7 +22,7 @@ export default defineComponent({
      * The function to invoke when the default action button is clicked.
      */
     buttonAction: {
-      type:    Function as PropType<(event: MouseEvent) => void>,
+      type:    Function,
       default: (): void => { }
     },
     /**
@@ -151,7 +151,7 @@ export default defineComponent({
 
       .card-body {
         justify-content: flex-start;
-        overflow: auto;
+        overflow: scroll;
       }
 
       > * {

package/rancher-components/Form/Checkbox/Checkbox.vue

@@ -1,10 +1,10 @@
 <script lang="ts">
-import { PropType, defineComponent } from 'vue';
+import Vue, { PropType } from 'vue';
 import { _EDIT, _VIEW } from '@shell/config/query-params';
 import { addObject, removeObject } from '@shell/utils/array';
 import cloneDeep from 'lodash/cloneDeep';
 
-export default defineComponent({
+export default Vue.extend({
   name: 'Checkbox',
 
   props: {
@@ -140,7 +140,7 @@ export default defineComponent({
     /**
      * Toggles the checked state for the checkbox and emits an 'input' event.
      */
-    clicked(event: MouseEvent | KeyboardEvent): boolean | void {
+    clicked(event: MouseEvent): boolean | void {
       if ((event.target as HTMLLinkElement).tagName === 'A' && (event.target as HTMLLinkElement).href) {
         // Ignore links inside the checkbox label so you can click them
         return true;
@@ -325,7 +325,6 @@ $fontColor: var(--input-label);
     border-radius: var(--border-radius);
     transition: all 0.3s ease-out;
     border: 1px solid var(--border);
-    flex-shrink: 0;
   }
 
   input {

package/rancher-components/Form/LabeledInput/LabeledInput.test.ts

@@ -1,3 +1,4 @@
+
 import { mount } from '@vue/test-utils';
 import { LabeledInput } from './index';
 
@@ -19,22 +20,4 @@ describe('component: LabeledInput', () => {
     expect(wrapper.emitted('input')).toHaveLength(1);
     expect(wrapper.emitted('input')![0][0]).toBe(value);
   });
-
-  it('using mode "multiline" should emit input value correctly', () => {
-    const value = 'any-string';
-    const delay = 1;
-    const wrapper = mount(LabeledInput as any, {
-      propsData: { delay, multiline: true },
-      mocks:     { $store: { getters: { 'i18n/t': jest.fn() } } }
-    });
-
-    jest.useFakeTimers();
-    wrapper.find('input').setValue('1');
-    wrapper.find('input').setValue(value);
-    jest.advanceTimersByTime(delay);
-    jest.useRealTimers();
-
-    expect(wrapper.emitted('input')).toHaveLength(1);
-    expect(wrapper.emitted('input')![0][0]).toBe(value);
-  });
 });

package/rancher-components/Form/LabeledInput/LabeledInput.vue

@@ -1,27 +1,21 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
+import Vue, { VueConstructor } from 'vue';
+import CompactInput from '@shell/mixins/compact-input';
+import LabeledFormElement from '@shell/mixins/labeled-form-element';
 import TextAreaAutoGrow from '@components/Form/TextArea/TextAreaAutoGrow.vue';
 import LabeledTooltip from '@components/LabeledTooltip/LabeledTooltip.vue';
 import { escapeHtml } from '@shell/utils/string';
 import cronstrue from 'cronstrue';
 import { isValidCron } from 'cron-validator';
 import { debounce } from 'lodash';
-import { useLabeledFormElement, labeledFormElementProps } from '@shell/composables/useLabeledFormElement';
-import { useCompactInput } from '@shell/composables/useCompactInput';
 
-declare module 'vue/types/vue' {
-  interface Vue {
-    onInput: (event: Event) => void | ((event: Event) => void);
-  }
-}
-
-export default defineComponent({
+export default (
+  Vue as VueConstructor<Vue & InstanceType<typeof LabeledFormElement> & InstanceType<typeof CompactInput>>
+).extend({
   components: { LabeledTooltip, TextAreaAutoGrow },
-
-  inheritAttrs: false,
+  mixins:     [LabeledFormElement, CompactInput],
 
   props: {
-    ...labeledFormElementProps,
     /**
      * The type of the Labeled Input.
      * @values text, cron, multiline, multiline-password
@@ -96,39 +90,24 @@ export default defineComponent({
     delay: {
       type:    Number,
       default: 0
-    },
-  },
-
-  setup(props, { emit }) {
-    const {
-      focused,
-      onFocusLabeled,
-      onBlurLabeled,
-      isDisabled,
-      validationMessage,
-      requiredField
-    } = useLabeledFormElement(props, emit);
-    const { isCompact } = useCompactInput(props);
-
-    return {
-      focused,
-      onFocusLabeled,
-      onBlurLabeled,
-      isDisabled,
-      validationMessage,
-      requiredField,
-      isCompact,
-    };
+    }
   },
 
   data() {
     return {
       updated:          false,
-      validationErrors: '',
+      validationErrors: ''
     };
   },
 
   computed: {
+    /**
+     * Determines if the Labeled Input @input event should be debounced.
+     */
+    onInput(): ((value: string) => void) | void {
+      return this.delay ? debounce(this.delayInput, this.delay) : this.delayInput;
+    },
+
     /**
      * Determines if the Labeled Input should display a label.
      */
@@ -143,7 +122,7 @@ export default defineComponent({
       return !!this.tooltip || !!this.tooltipKey;
     },
 
-    tooltipValue(): string | Record<string, unknown> | undefined {
+    tooltipValue(): string | undefined {
       if (this.hasTooltip) {
         return this.tooltipKey ? this.t(this.tooltipKey) : this.tooltip;
       }
@@ -165,7 +144,7 @@ export default defineComponent({
       if (this.type !== 'cron' || !this.value) {
         return;
       }
-      if (typeof this.value === 'string' && !isValidCron(this.value)) {
+      if (!isValidCron(this.value)) {
         return this.t('generic.invalidCron');
       }
       try {
@@ -194,22 +173,15 @@ export default defineComponent({
     /**
      * The max length for the Labeled Input.
      */
-    _maxlength(): number | undefined {
+    _maxlength(): number | null {
       if (this.type === 'text' && this.maxlength) {
         return this.maxlength;
       }
 
-      return undefined;
+      return null;
     },
   },
 
-  created() {
-    /**
-     * Determines if the Labeled Input @input event should be debounced.
-    */
-    this.onInput = this.delay ? debounce(this.delayInput, this.delay) : this.delayInput;
-  },
-
   methods: {
     /**
      * Attempts to give the Labeled Input focus.
@@ -244,13 +216,8 @@ export default defineComponent({
     /**
      * Emit on input with delay. Note: Arrow function is avoided due context
      * binding.
-     *
-     * NOTE: In multiline, TextAreaAutoGrow emits a string with the value
-     * https://github.com/rancher/dashboard/issues/10249
      */
-    delayInput(val: string | Event): void {
-      const value = typeof val === 'string' ? val : (val?.target as HTMLInputElement)?.value;
-
+    delayInput(value: string): void {
       this.$emit('input', value);
     },
 
@@ -267,7 +234,7 @@ export default defineComponent({
      * event.
      * @see labeled-form-element.ts mixin for onBlurLabeled()
      */
-    onBlur(event: string | FocusEvent): void {
+    onBlur(event: string): void {
       this.$emit('blur', event);
       this.onBlurLabeled();
     },
@@ -319,7 +286,7 @@ export default defineComponent({
         :placeholder="_placeholder"
         autocapitalize="off"
         :class="{ conceal: type === 'multiline-password' }"
-        @input="onInput"
+        @input="onInput($event)"
         @focus="onFocus"
         @blur="onBlur"
       />
@@ -336,7 +303,7 @@ export default defineComponent({
         autocomplete="off"
         autocapitalize="off"
         :data-lpignore="ignorePasswordManagers"
-        @input="onInput"
+        @input="onInput($event.target.value)"
         @focus="onFocus"
         @blur="onBlur"
         @change="onChange"
@@ -355,15 +322,20 @@ export default defineComponent({
       :hover="hoverTooltip"
       :value="validationMessage"
     />
-    <label
-      v-if="cronHint"
-      class="cron-label"
-    >{{ cronHint }}</label>
-    <label
-      v-if="subLabel"
-      v-clean-html="subLabel"
+    <div
+      v-if="cronHint || subLabel"
       class="sub-label"
-    />
+    >
+      <div
+        v-if="cronHint"
+      >
+        {{ cronHint }}
+      </div>
+      <div
+        v-if="subLabel"
+        v-clean-html="subLabel"
+      />
+    </div>
   </div>
 </template>
 <style scoped lang="scss">

package/rancher-components/Form/Radio/RadioButton.test.ts

@@ -1,5 +1,6 @@
 import { shallowMount } from '@vue/test-utils';
 import { RadioButton } from './index';
+import { cleanHtmlDirective } from '@shell/plugins/clean-html-directive';
 
 describe('radioButton.vue', () => {
   it('renders label slot contents', () => {
@@ -12,7 +13,8 @@ describe('radioButton.vue', () => {
     const wrapper = shallowMount(
       RadioButton,
       {
-        propsData: {
+        directives: { cleanHtmlDirective },
+        propsData:  {
           label: 'Test Label', val: {}, value: {}
         }
       });

package/rancher-components/Form/Radio/RadioButton.vue

@@ -1,9 +1,8 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
+import Vue from 'vue';
 import { _VIEW } from '@shell/config/query-params';
-import { randomStr } from '@shell/utils/string';
 
-export default defineComponent({
+export default Vue.extend({
   props: {
     /**
      * The name of the input, for grouping.
@@ -72,10 +71,7 @@ export default defineComponent({
   },
 
   data() {
-    return {
-      isChecked:    this.value === this.val,
-      randomString: `${ randomStr() }-radio`,
-    };
+    return { isChecked: this.value === this.val };
   },
 
   computed: {
@@ -119,15 +115,13 @@ export default defineComponent({
     /**
      * Emits the input event.
      */
-    clicked(event: MouseEvent | KeyboardEvent) {
-      const target = event.target;
-
-      if (this.isDisabled || (target instanceof HTMLElement && target.tagName === 'A')) {
+    clicked({ target }: { target?: HTMLElement }) {
+      if (this.isDisabled || target?.tagName === 'A') {
         return;
       }
 
       this.$emit('input', this.val);
-    },
+    }
   }
 });
 </script>
@@ -140,7 +134,7 @@ export default defineComponent({
     @click.stop="clicked($event)"
   >
     <input
-      :id="randomString"
+      :id="_uid+'-radio'"
       :disabled="isDisabled"
       :name="name"
       :value="''+val"

package/rancher-components/Form/Radio/RadioGroup.vue

@@ -1,15 +1,14 @@
 <script lang="ts">
-import { PropType, defineComponent } from 'vue';
+import Vue, { PropType } from 'vue';
 import { _VIEW } from '@shell/config/query-params';
 import RadioButton from '@components/Form/Radio/RadioButton.vue';
 
 interface Option {
   value: unknown,
-  label: string,
-  description?: string,
+  label: string
 }
 
-export default defineComponent({
+export default Vue.extend({
   components: { RadioButton },
   props:      {
     /**

package/rancher-components/Form/TextArea/TextAreaAutoGrow.vue

@@ -1,5 +1,5 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
+import Vue from 'vue';
 import debounce from 'lodash/debounce';
 import { _EDIT, _VIEW } from '@shell/config/query-params';
 
@@ -10,7 +10,7 @@ declare module 'vue/types/vue' {
   }
 }
 
-export default defineComponent({
+export default Vue.extend({
   inheritAttrs: false,
 
   props: {
@@ -115,9 +115,7 @@ export default defineComponent({
     /**
      * Emits the input event and resizes the Text Area.
     */
-    onInput(event: Event): void {
-      const val = (event?.target as HTMLInputElement)?.value;
-
+    onInput(val: string): void {
       this.$emit('input', val);
       this.queueResize();
     },
@@ -165,7 +163,7 @@ export default defineComponent({
     v-bind="$attrs"
     :spellcheck="spellcheck"
     @paste="$emit('paste', $event)"
-    @input="onInput($event)"
+    @input="onInput($event.target.value)"
     @focus="$emit('focus', $event)"
     @blur="$emit('blur', $event)"
   />

package/rancher-components/Form/ToggleSwitch/ToggleSwitch.vue

@@ -1,9 +1,6 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
-
-type StateType = boolean | 'true' | 'false' | undefined;
-
-export default defineComponent({
+import Vue from 'vue';
+export default Vue.extend({
   props: {
     value: {
       type:    [Boolean, String, Number],
@@ -31,7 +28,7 @@ export default defineComponent({
     },
   },
   data() {
-    return { state: false as StateType };
+    return { state: false as boolean | string | number };
   },
 
   watch: {
@@ -44,7 +41,7 @@ export default defineComponent({
   },
 
   methods: {
-    toggle(neu: StateType | null) {
+    toggle(neu: boolean | string | number) {
       this.state = neu === null ? !this.state : neu;
       this.$emit('input', this.state ? this.onValue : this.offValue);
     }

package/rancher-components/LabeledTooltip/LabeledTooltip.vue

@@ -1,7 +1,7 @@
 <script lang="ts">
-import { defineComponent } from 'vue';
+import Vue from 'vue';
 
-export default defineComponent({
+export default Vue.extend({
   props: {
     /**
      * The Labeled Tooltip value.
@@ -29,14 +29,9 @@ export default defineComponent({
     }
   },
   computed: {
-    iconClass(): string {
+    iconClass() {
       return this.status === 'error' ? 'icon-warning' : 'icon-info';
     }
-  },
-  methods: {
-    isObject(value: string | Record<string, unknown>): value is Record<string, unknown> {
-      return typeof value === 'object' && value !== null && !!value.content;
-    }
   }
 });
 </script>
@@ -49,7 +44,7 @@ export default defineComponent({
   >
     <template v-if="hover">
       <i
-        v-clean-tooltip="isObject(value) ? { ...{content: value.content, classes: [`tooltip-${status}`]}, ...value } : value"
+        v-clean-tooltip="value.content ? { ...{content: value.content, classes: [`tooltip-${status}`]}, ...value } : value"
         :class="{'hover':!value, [iconClass]: true}"
         class="icon status-icon"
       />