@types/country-select-js v1.0.5

Installation

npm install --save @types/country-select-js

Summary

This package contains type definitions for country-select-js (https://github.com/mrmarkfrench/country-select-js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/country-select-js.

index.d.ts

// Type definitions for country-select-js 1.0
// Project: https://github.com/mrmarkfrench/country-select-js
// Definitions by: Humberto Rocha <https://github.com/humrochagf>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

/// <reference types="jquery" />

declare namespace CountrySelectJs {
  interface Options {
    /**
     * Set the default country by it's country code. Otherwise it will just be
     * the first country in the list.
     */
    defaultCountry?: string | undefined;

    /**
     * Display only the countries you specify. Takes an array of country codes.
     */
    onlyCountries?: string[] | undefined;

    /**
     * Specify the countries to appear at the top of the list. Defaults to
     * ["us", "gb"]
     */
    preferredCountries?: string[] | undefined;

    /**
     * Set the dropdown's width to be the same as the input. This is
     * automatically enabled for small screens.
     */
    responsiveDropdown?: boolean | undefined;
  }

  interface CountryData {
    name: string;
    iso2: string;
  }
}

interface JQuery {
  /**
   * Remove the plugin from the input, and unbind any event listeners.
   */
  countrySelect(method: 'destroy'): void;

  /**
   * Get the country data for the currently selected flag.
   */
  countrySelect(method: 'getSelectedCountryData'): CountrySelectJs.CountryData;

  countrySelect(method: string, value: string): void;

  /**
   * initialize the plugin with optional options.
   */
  countrySelect(options?: CountrySelectJs.Options): JQueryDeferred<any>;
}

Additional Details

• Last updated: Thu, 08 Jul 2021 09:08:17 GMT
• Dependencies: @types/jquery
• Global values: none

Credits

These definitions were written by Humberto Rocha.