[Remove Vuetify from Studio] Replace CountryField VAutocomplete with KDS KMultiSelect

contentcuration/contentcuration/frontend/accounts/pages/Create.vue

@@ -131,10 +131,7 @@
 
         <!-- Location -->
         <h2 class="section-header">{{ $tr('locationLabel') }}*</h2>
-        <CountryField
-          v-model="form.locations"
-          clearable
-        />
+        <CountryField v-model="form.locations" />
         <div
           v-if="!valid && (!form.locations || !form.locations.length)"
           :style="{ color: $themeTokens.error }"

contentcuration/contentcuration/frontend/accounts/pages/__tests__/create.spec.js

@@ -3,6 +3,16 @@ import Vuex from 'vuex';
 import { render, screen, waitFor } from '@testing-library/vue';
 import userEvent from '@testing-library/user-event';
 import Create from '../Create';
+import CountryField from 'shared/views/form/CountryField';
+import { createTranslator } from 'shared/i18n';
+
+const { sourcePlaceholder$, websiteSourceOption$, registrationFailedOffline$ } = createTranslator(
+  'Create',
+  Create.$trs,
+);
+const { locationLabel$ } = createTranslator('CountryField', CountryField.$trs);
+
+const KENYA = 'Kenya';
 
 const routes = [
   { path: '/', name: 'Main' },
@@ -31,8 +41,19 @@ const makeStore = ({ offline = false } = {}) =>
         online: !offline,
       },
     },
-    actions: {
-      register: mockRegisterAction,
+    modules: {
+      account: {
+        namespaced: true,
+        actions: {
+          register: mockRegisterAction,
+        },
+      },
+      policies: {
+        namespaced: true,
+        getters: {
+          getPolicyAcceptedData: () => () => ({}),
+        },
+      },
     },
   });
 
@@ -102,20 +123,7 @@ describe('Create account page', () => {
     });
   });
 
-  // NOTE:
-  // Full form submission tests are intentionally skipped here.
-  //
-  // The "locations" field uses CountryField, which internally uses VAutocomplete
-  // (a Vuetify component). VAutocomplete does not reliably update its v-model
-  // state when interacted with via Vue Testing Library's userEvent APIs, which
-  // prevents a fully user-centric submission flow from being exercised.
-  //
-  // The "source" field has been migrated to KSelect (KDS) and no longer has
-  // this limitation, but "locations" remains the blocker.
-  //
-  // These tests will be re-enabled once CountryField is migrated away from
-  // VAutocomplete as part of the ongoing Vuetify removal effort.
-  it.skip('creates an account when the user submits valid information', async () => {
+  it('creates an account when the user submits valid information', async () => {
     await renderComponent();
 
     await userEvent.type(screen.getByLabelText(/first name/i), 'Test');
@@ -126,6 +134,12 @@ describe('Create account page', () => {
 
     await userEvent.click(screen.getByLabelText(/tagging content sources/i));
 
+    await userEvent.type(screen.getByRole('combobox', { name: locationLabel$() }), KENYA);
+    await userEvent.click(await screen.findByRole('option', { name: KENYA }));
+
+    await userEvent.click(screen.getByText(sourcePlaceholder$()));
+    await userEvent.click(await screen.findByText(websiteSourceOption$()));
+
     await userEvent.click(screen.getByLabelText(/i have read and agree to terms of service/i));
 
     const finishButton = screen.getByRole('button', { name: /finish/i });
@@ -137,27 +151,17 @@ describe('Create account page', () => {
     await userEvent.click(finishButton);
 
     await waitFor(() => {
-      expect(mockRegisterAction).toHaveBeenCalled();
+      expect(mockRegisterAction).toHaveBeenCalledWith(
+        expect.anything(),
+        expect.objectContaining({ locations: KENYA }),
+      );
     });
   });
 
-  // Skipped for the same reason as above — CountryField (VAutocomplete) blocker
-  it.skip('shows an offline error when the user is offline', async () => {
+  it('shows an offline error and disables Finish when the user is offline', async () => {
     await renderComponent({ offline: true });
 
-    await userEvent.type(screen.getByLabelText(/first name/i), 'Test');
-    await userEvent.type(screen.getByLabelText(/last name/i), 'User');
-    await userEvent.type(screen.getByLabelText(/email/i), '[email protected]');
-    await userEvent.type(screen.getByLabelText(/^password$/i), 'tester123');
-    await userEvent.type(screen.getByLabelText(/confirm password/i), 'tester123');
-
-    await userEvent.click(screen.getByLabelText(/tagging content sources/i));
-
-    await userEvent.click(screen.getByLabelText(/i have read and agree to terms of service/i));
-
-    const finishButton = screen.getByRole('button', { name: /finish/i });
-    await userEvent.click(finishButton);
-
-    expect(await screen.findByText(/offline/i)).toBeInTheDocument();
+    expect(screen.getByTestId('studio-banner')).toHaveTextContent(registrationFailedOffline$());
+    expect(screen.getByRole('button', { name: /finish/i })).toBeDisabled();
   });
 });

contentcuration/contentcuration/frontend/administration/pages/Users/UserTable.vue

@@ -57,7 +57,6 @@
         <CountryField
           ref="locationDropdown"
           v-model="locationFilter"
-          :outline="false"
           :multiple="false"
           label="Target location"
         />

contentcuration/contentcuration/frontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/index.vue

@@ -204,7 +204,6 @@
                   :disabled="!canBeEdited"
                   :label="countryLabel$()"
                   fullWidth
-                  :hide-details="true"
                 />
               </KTransition>
             </div>

contentcuration/contentcuration/frontend/channelList/views/Channel/components/LanguageFilter.vue

@@ -64,12 +64,12 @@
         },
       },
       messages() {
-        const { languageItemsSelectedLabel$, languageSelectionsClearedLabel$ } = commonStrings;
+        const { languageItemsSelectedLabel$, selectionsClearedLabel$ } = commonStrings;
         const { clearAllAction$ } = communityChannelsStrings;
         return createMultiSelectMessages({
           clearText: clearAllAction$,
           itemsSelected: languageItemsSelectedLabel$,
-          cleared: languageSelectionsClearedLabel$,
+          cleared: selectionsClearedLabel$,
         });
       },
     },

contentcuration/contentcuration/frontend/settings/pages/Storage/RequestForm.vue

@@ -133,11 +133,7 @@
     <div class="mb-1 mt-3">
       <label>{{ $tr('targetRegionsLabel') }}</label>
     </div>
-    <CountryField
-      v-model="location"
-      :box="false"
-      :menu-props="{ zIndex: 1, offsetY: true }"
-    />
+    <CountryField v-model="location" />
     <KTextbox
       v-model="import_count"
       :invalid="errors.import_count"

contentcuration/contentcuration/frontend/shared/strings/commonStrings.js

@@ -102,8 +102,12 @@ export const commonStrings = createTranslator('CommonStrings', {
     message: '{count, plural, one {# language selected} other {# languages selected}}',
     context: 'Announced with the number of languages currently selected in a language picker',
   },
-  languageSelectionsClearedLabel: {
+  countryItemsSelectedLabel: {
+    message: '{count, plural, one {# country selected} other {# countries selected}}',
+    context: 'Announced with the number of countries currently selected in a country picker',
+  },
+  selectionsClearedLabel: {
     message: '{count, plural, one {Cleared # selection} other {Cleared # selections}}',
-    context: 'Announced when all selected languages are cleared from a language picker',
+    context: 'Announced when all selected options are cleared from a multiple selection dropdown',
   },
 });

contentcuration/contentcuration/frontend/shared/views/LanguageDropdown.vue

@@ -103,15 +103,13 @@
           clearAction$,
           optionRemovedLabel$,
           languageItemsSelectedLabel$,
-          languageSelectionsClearedLabel$,
+          selectionsClearedLabel$,
         } = commonStrings;
         return createMultiSelectMessages({
           clearText: clearAction$,
           itemsSelected: languageItemsSelectedLabel$,
           cleared: ({ label, count }) =>
-            this.multiple
-              ? languageSelectionsClearedLabel$({ count })
-              : optionRemovedLabel$({ label }),
+            this.multiple ? selectionsClearedLabel$({ count }) : optionRemovedLabel$({ label }),
         });
       },
     },

contentcuration/contentcuration/frontend/shared/views/form/CountryField.vue

@@ -1,57 +1,43 @@
 <template>
 
-  <DropdownWrapper>
-    <template #default="{ attach, menuProps }">
-      <VAutocomplete
-        v-model="locations"
-        :items="options"
-        :label="label || $tr('locationLabel')"
-        :multiple="multiple"
-        :box="box"
-        item-value="id"
-        item-text="name"
-        :required="required"
-        :rules="rules"
-        :search-input.sync="searchInput"
-        :no-data-text="$tr('noCountriesFound')"
-        :chips="multiple"
-        :attach="attach"
-        :menuProps="menuProps"
-        clearable
-        v-bind="$attrs"
-      />
-    </template>
-  </DropdownWrapper>
+  <KMultiSelect
+    v-model="locations"
+    :options="options"
+    :label="label || $tr('locationLabel')"
+    :multiple="multiple"
+    itemValue="id"
+    itemText="name"
+    :disabled="disabled"
+    :invalid="invalid"
+    :invalidText="$tr('locationRequiredMessage')"
+    :noResultsText="$tr('noCountriesFound')"
+    :appearanceOverrides="{ maxWidth: fullWidth ? '100%' : '500px' }"
+    :messages="messages"
+    clearable
+  />
 
 </template>
 
 
 <script>
 
+  import KMultiSelect from 'kolibri-design-system/lib/candidate/multiselect/KMultiSelect';
   import countries from '../../utils/countries';
-
-  import DropdownWrapper from 'shared/views/form/DropdownWrapper';
+  import { commonStrings } from 'shared/strings/commonStrings';
+  import { createMultiSelectMessages } from 'shared/utils/multiSelectMessages';
 
   export default {
     name: 'CountryField',
-    components: { DropdownWrapper },
-    // $attrs are rebound to a descendent component
-    inheritAttrs: false,
+    components: { KMultiSelect },
     props: {
       value: {
         type: [String, Array],
-        default() {
-          return [];
-        },
+        default: null,
       },
       required: {
         type: Boolean,
         default: false,
       },
-      box: {
-        type: Boolean,
-        default: true,
-      },
       multiple: {
         type: Boolean,
         default: true,
@@ -65,26 +51,27 @@
         type: Boolean,
         default: false,
       },
+      disabled: {
+        type: Boolean,
+        default: false,
+      },
     },
     data() {
       return {
-        searchInput: '',
+        validated: false,
       };
     },
     computed: {
       locations: {
         get() {
-          return this.value;
+          // KMultiSelect expects an array in multiple mode and a string or null in single mode
+          if (this.multiple) {
+            return this.value || [];
+          }
+          return this.value || null;
         },
         set(value) {
           this.$emit('input', value);
-
-          // If selecting multiple countries, a chip is created for the selected item,
-          // so the input can be cleared. If selecting a single country, the search input
-          // becomes the selected country and should not be cleared to stay visible.
-          if (this.multiple) {
-            setTimeout(this.searchInputClear, 1);
-          }
         },
       },
       options() {
@@ -97,16 +84,33 @@
           };
         });
       },
-      rules() {
-        return [v => (!this.required || v.length ? true : this.$tr('locationRequiredMessage'))];
+      invalid() {
+        const hasSelection = this.multiple ? this.locations.length > 0 : Boolean(this.locations);
+        return this.required && this.validated && !hasSelection;
       },
-      autocompleteMaxWidth() {
-        return this.fullWidth ? '100%' : '500px';
+      messages() {
+        const {
+          clearAction$,
+          optionRemovedLabel$,
+          countryItemsSelectedLabel$,
+          selectionsClearedLabel$,
+        } = commonStrings;
+        return createMultiSelectMessages({
+          clearText: clearAction$,
+          itemsSelected: countryItemsSelectedLabel$,
+          // KMultiSelect passes a label in single mode and a count in multiple mode
+          cleared: ({ label, count }) =>
+            this.multiple ? selectionsClearedLabel$({ count }) : optionRemovedLabel$({ label }),
+        });
       },
     },
     methods: {
-      searchInputClear() {
-        this.searchInput = '';
+      /**
+       * @public
+       */
+      validate() {
+        this.validated = true;
+        return this.invalid ? this.$tr('locationRequiredMessage') : '';
       },
     },
     $trs: {
@@ -117,17 +121,3 @@
   };
 
 </script>
-
-
-<style lang="scss" scoped>
-
-  ::v-deep .v-select__selections {
-    width: calc(100% - 48px); // Account for clear icon
-    min-height: 0 !important;
-  }
-
-  .v-autocomplete {
-    max-width: v-bind('autocompleteMaxWidth');
-  }
-
-</style>