intl-tel-input 29.1.3 → 29.2.0

package/dist/js/intlTelInputWithUtils.mjs

@@ -1761,6 +1761,29 @@ var EVENTS = {
   // used for synthetic input trigger
   STRICT_REJECT: "strict:reject"
 };
+var ITI_SLOTS = [
+  "container",
+  "input",
+  "countryContainer",
+  "selectedCountry",
+  "selectedCountryPrimary",
+  "selectedFlag",
+  "arrow",
+  "selectedDialCode",
+  "countrySelector",
+  "countrySelectorContainer",
+  "searchWrapper",
+  "searchIcon",
+  "searchInput",
+  "searchClear",
+  "countryList",
+  "countryListItem",
+  "countryListItemFlag",
+  "countryName",
+  "dialCode",
+  "countryCheck",
+  "noResults"
+];
 var CLASSES = {
   HIDE: "iti__hide",
   V_HIDE: "iti__v-hide",
@@ -1937,6 +1960,8 @@ var defaults = {
   allowNumberExtensions: false,
   // Allow alphanumeric "phonewords" (e.g. +1 800 FLOWERS) as valid numbers
   allowPhonewords: false,
+  //* Add custom classes to the elements we generate, keyed by slot name e.g. { selectedCountry: "rounded-l-lg" }.
+  classNames: {},
   //* Add a custom class to the (injected) container element.
   containerClass: "",
   //* Locale for localising country names via Intl.DisplayNames.
@@ -1999,6 +2024,7 @@ var isElLike = (val) => {
   return v.nodeType === 1 && typeof v.tagName === "string" && typeof v.appendChild === "function";
 };
 var placeholderPolicySet = new Set(Object.values(PLACEHOLDER_POLICY));
+var slotSet = new Set(ITI_SLOTS);
 var warn = (message) => {
   console.warn(`[intl-tel-input] ${message}`);
 };
@@ -2099,6 +2125,26 @@ var validateOptions = (customOptions) => {
         }
         validatedOptions[key] = value;
         break;
+      case "classNames": {
+        if (!isPlainObject(value)) {
+          warnOption("classNames", "an object", value);
+          break;
+        }
+        const validSlots = {};
+        for (const [slot, slotValue] of Object.entries(value)) {
+          if (!slotSet.has(slot)) {
+            warn(
+              `Unknown slot '${slot}' in 'classNames'. Valid slots: ${ITI_SLOTS.join(", ")}. Skipping.`
+            );
+          } else if (typeof slotValue !== "string") {
+            warnOption(`classNames.${slot}`, "a string", slotValue);
+          } else {
+            validSlots[slot] = slotValue.trim().replace(/\s+/g, " ");
+          }
+        }
+        validatedOptions[key] = validSlots;
+        break;
+      }
       case "countryOrder": {
         if (value === null) {
           validatedOptions[key] = value;
@@ -2511,11 +2557,18 @@ var UI = class {
       );
     }
   }
+  //* Append any consumer-supplied classes (via the classNames option) for the given slot to our own classes for that element.
+  #withSlotClass(slot, ourClasses) {
+    const custom = this.#options.classNames[slot];
+    return custom ? `${ourClasses} ${custom}` : ourClasses;
+  }
   //* Generate all of the markup for the core library: the selected country overlay, and the country selector.
   buildMarkup(countries, searchTokens) {
     this.#countries = countries;
     this.#searchTokens = searchTokens;
-    this.telInputEl.classList.add("iti__tel-input");
+    this.telInputEl.classList.add(
+      ...this.#withSlotClass("input", "iti__tel-input").split(" ")
+    );
     if (!this.telInputEl.hasAttribute("type")) {
       this.telInputEl.setAttribute("type", "tel");
     }
@@ -2543,7 +2596,9 @@ var UI = class {
       "iti--inline-country-selector": countrySelectorMode !== COUNTRY_SELECTOR_MODE.FULLSCREEN,
       [containerClass]: Boolean(containerClass)
     });
-    const wrapper = createEl("div", { class: parentClasses });
+    const wrapper = createEl("div", {
+      class: this.#withSlotClass("container", parentClasses)
+    });
     if (this.#isRTL) {
       wrapper.setAttribute("dir", "ltr");
     }
@@ -2559,7 +2614,12 @@ var UI = class {
     this.#countryContainerEl = createEl(
       "div",
       // visibly hidden until we measure its width to set the input padding correctly
-      { class: `iti__country-container ${CLASSES.V_HIDE}` },
+      {
+        class: this.#withSlotClass(
+          "countryContainer",
+          `iti__country-container ${CLASSES.V_HIDE}`
+        )
+      },
       wrapper
     );
     if (enableCountrySelector) {
@@ -2567,7 +2627,7 @@ var UI = class {
         "button",
         {
           type: "button",
-          class: "iti__selected-country",
+          class: this.#withSlotClass("selectedCountry", "iti__selected-country"),
           [ARIA.EXPANDED]: "false",
           [ARIA.LABEL]: this.#options.uiTranslations.noCountrySelected,
           [ARIA.HASPOPUP]: "dialog",
@@ -2581,31 +2641,44 @@ var UI = class {
     } else {
       this.#selectedCountryEl = createEl(
         "div",
-        { class: "iti__selected-country" },
+        { class: this.#withSlotClass("selectedCountry", "iti__selected-country") },
         this.#countryContainerEl
       );
     }
     const selectedCountryPrimary = createEl(
       "div",
-      { class: "iti__selected-country-primary" },
+      {
+        class: this.#withSlotClass(
+          "selectedCountryPrimary",
+          "iti__selected-country-primary"
+        )
+      },
       this.#selectedCountryEl
     );
     this.#selectedFlagEl = createEl(
       "div",
-      { class: CLASSES.FLAG },
+      { class: this.#withSlotClass("selectedFlag", CLASSES.FLAG) },
       selectedCountryPrimary
     );
     if (enableCountrySelector) {
       this.#arrowEl = createEl(
         "div",
-        { class: "iti__arrow", [ARIA.HIDDEN]: "true" },
+        {
+          class: this.#withSlotClass("arrow", "iti__arrow"),
+          [ARIA.HIDDEN]: "true"
+        },
         selectedCountryPrimary
       );
     }
     if (separateDialCode) {
       this.#selectedDialCodeEl = createEl(
         "div",
-        { class: "iti__selected-dial-code" },
+        {
+          class: this.#withSlotClass(
+            "selectedDialCode",
+            "iti__selected-dial-code"
+          )
+        },
         this.#selectedCountryEl
       );
     }
@@ -2636,7 +2709,10 @@ var UI = class {
     const extraClasses = matchDropdownWidth ? "" : "iti--flexible-dropdown-width";
     this.#countrySelectorEl = createEl("div", {
       id: `iti-${this.#id}__country-selector`,
-      class: `iti__country-selector ${CLASSES.HIDE} ${extraClasses}`,
+      class: this.#withSlotClass(
+        "countrySelector",
+        `iti__country-selector ${CLASSES.HIDE} ${extraClasses}`
+      ),
       role: "dialog",
       [ARIA.MODAL]: "true"
     });
@@ -2649,7 +2725,7 @@ var UI = class {
     this.#countryListEl = createEl(
       "ul",
       {
-        class: "iti__country-list",
+        class: this.#withSlotClass("countryList", "iti__country-list"),
         id: `iti-${this.#id}__country-listbox`,
         role: "listbox",
         [ARIA.LABEL]: uiTranslations.countryListAriaLabel
@@ -2668,7 +2744,9 @@ var UI = class {
         "iti--inline-country-selector": !isFullscreen,
         [containerClass]: Boolean(containerClass)
       });
-      this.#detachedCountrySelectorEl = createEl("div", { class: wrapperClasses });
+      this.#detachedCountrySelectorEl = createEl("div", {
+        class: this.#withSlotClass("countrySelectorContainer", wrapperClasses)
+      });
       this.#detachedCountrySelectorEl.appendChild(this.#countrySelectorEl);
     } else {
       this.#countryContainerEl.appendChild(this.#countrySelectorEl);
@@ -2689,13 +2767,13 @@ var UI = class {
     const { uiTranslations, searchInputClass } = this.#options;
     const searchWrapper = createEl(
       "div",
-      { class: "iti__search-input-wrapper" },
+      { class: this.#withSlotClass("searchWrapper", "iti__search-input-wrapper") },
       this.#countrySelectorEl
     );
     this.#searchIconEl = createEl(
       "span",
       {
-        class: "iti__search-icon",
+        class: this.#withSlotClass("searchIcon", "iti__search-icon"),
         [ARIA.HIDDEN]: "true"
       },
       searchWrapper
@@ -2707,7 +2785,10 @@ var UI = class {
         id: `iti-${this.#id}__search-input`,
         // Chrome says inputs need either a name or an id
         type: "search",
-        class: `iti__search-input ${searchInputClass}`,
+        class: this.#withSlotClass(
+          "searchInput",
+          `iti__search-input ${searchInputClass}`
+        ),
         placeholder: uiTranslations.searchPlaceholder,
         // role=combobox + aria-autocomplete=list + aria-activedescendant allows maintaining focus on the search input while allowing users to navigate search results with up/down keyboard keys
         role: "combobox",
@@ -2723,7 +2804,10 @@ var UI = class {
       "button",
       {
         type: "button",
-        class: `iti__search-clear ${CLASSES.HIDE}`,
+        class: this.#withSlotClass(
+          "searchClear",
+          `iti__search-clear ${CLASSES.HIDE}`
+        ),
         [ARIA.LABEL]: uiTranslations.clearSearchAriaLabel,
         tabindex: "-1"
       },
@@ -2738,7 +2822,7 @@ var UI = class {
     this.#noResultsMessageEl = createEl(
       "div",
       {
-        class: `iti__no-results ${CLASSES.HIDE}`,
+        class: this.#withSlotClass("noResults", `iti__no-results ${CLASSES.HIDE}`),
         [ARIA.HIDDEN]: "true"
         // all a11y messaging happens in this.#searchResultsLiveRegionEl
       },
@@ -2792,11 +2876,9 @@ var UI = class {
   //* For each country: add a country list item <li> to the countryList <ul> container.
   #appendListItems() {
     const frag = document.createDocumentFragment();
+    const liClass = this.#withSlotClass("countryListItem", CLASSES.COUNTRY_ITEM);
     for (let i = 0; i < this.#countries.length; i++) {
       const c = this.#countries[i];
-      const liClass = buildClassNames({
-        [CLASSES.COUNTRY_ITEM]: true
-      });
       const listItem = createEl("li", {
         id: `iti-${this.#id}__item-${c.iso2}`,
         class: liClass,
@@ -2808,11 +2890,28 @@ var UI = class {
       listItem.dataset[DATA_KEYS.ISO2] = c.iso2;
       this.#listItemByIso2.set(c.iso2, listItem);
       if (this.#options.showFlags) {
-        createEl("div", { class: `${CLASSES.FLAG} iti__${c.iso2}` }, listItem);
+        createEl(
+          "div",
+          {
+            class: this.#withSlotClass(
+              "countryListItemFlag",
+              `${CLASSES.FLAG} iti__${c.iso2}`
+            )
+          },
+          listItem
+        );
       }
-      const nameEl = createEl("span", { class: "iti__country-name" }, listItem);
+      const nameEl = createEl(
+        "span",
+        { class: this.#withSlotClass("countryName", "iti__country-name") },
+        listItem
+      );
       nameEl.textContent = `${c.name} `;
-      const dialEl = createEl("span", { class: "iti__dial-code" }, nameEl);
+      const dialEl = createEl(
+        "span",
+        { class: this.#withSlotClass("dialCode", "iti__dial-code") },
+        nameEl
+      );
       if (this.#isRTL) {
         dialEl.setAttribute("dir", "ltr");
       }
@@ -3259,7 +3358,10 @@ var UI = class {
         newListItem.setAttribute(ARIA.SELECTED, "true");
         const checkIcon = createEl(
           "span",
-          { class: "iti__country-check", [ARIA.HIDDEN]: "true" },
+          {
+            class: this.#withSlotClass("countryCheck", "iti__country-check"),
+            [ARIA.HIDDEN]: "true"
+          },
           newListItem
         );
         checkIcon.appendChild(buildCheckIcon());
@@ -3446,7 +3548,10 @@ var UI = class {
       this.#updateSelectedListItem(iso2);
     }
     if (this.#selectedCountryEl) {
-      const flagClass = iso2 && showFlags ? `${CLASSES.FLAG} iti__${iso2}` : `${CLASSES.FLAG} ${CLASSES.GLOBE}`;
+      const flagClass = this.#withSlotClass(
+        "selectedFlag",
+        iso2 && showFlags ? `${CLASSES.FLAG} iti__${iso2}` : `${CLASSES.FLAG} ${CLASSES.GLOBE}`
+      );
       let ariaLabel, title;
       let flagContent = null;
       if (iso2) {
@@ -4843,7 +4948,7 @@ var intlTelInput = Object.assign(
     attachUtils,
     startedLoadingUtils: false,
     startedLoadingAutoCountry: false,
-    version: "29.1.3",
+    version: "29.2.0",
     NUMBER_FORMAT,
     NUMBER_TYPE,
     VALIDATION_ERROR,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intl-tel-input",
-  "version": "29.1.3",
+  "version": "29.2.0",
   "description": "A JavaScript library for entering, formatting, and validating international telephone numbers",
   "type": "module",
   "license": "MIT",