CountrySelect

The CountrySelect component is a form component that enables a user to select a single option from a dropdown menu as well as behaving like a standard text input with autocomplete options.

Types

The CountrySelect component supports two types:

• country (default): Displays country names for selection
• phone: Displays country phone codes (e.g., +1, +44, +49) for phone number input scenarios

Import

React

// with @dhl-official/react-library:
import { DhlCountrySelect } from "@dhl-official/react-library"

// with @dhl-official/ui-libraries/react-library:
import { DhlCountrySelect } from "@dhl-official/ui-libraries/react-library"

Angular

If the DUIL has been installed, you can use the web component directly:

<dhl-country-select></dhl-country-select>

Vue.js

// with @dhl-official/vue-library:
import { DhlCountrySelect } from "@dhl-official/vue-library"

// with @dhl-official/ui-libraries/vue-library:
import { DhlCountrySelect } from "@dhl-official/ui-libraries/vue-library"

Code

Country Type (Default)

React

<DhlCountrySelect
type="country"
variant={{
  label: "Select Country",
  placeholder: "Select Country",
  type: "animated"
}}
/>

Angular

<dhl-country-select
type="country"
variant='{"label": "Select Country", "placeholder": "Select Country", "type": "animated"}'
></dhl-country-select>

Vue.js

<dhl-country-select
type="country"
:variant="{
  label: 'Select Country',
  placeholder: 'Select Country',
  type: 'animated'
}"
/>

Phone Code Type

React

<DhlCountrySelect
type="phone"
variant={{
  label: "Country Code",
  placeholder: "Country Code",
  type: "animated"
}}
showClearButton={true}
/>

Angular

<dhl-country-select
type="phone"
variant='{"label": "Country Code", "placeholder": "Country Code", "type": "animated"}'
show-clear-button="true"
></dhl-country-select>

Vue.js

<dhl-country-select
type="phone"
:variant="{
  label: 'Country Code',
  placeholder: 'Country Code',
  type: 'animated'
}"
:show-clear-button="true"
/>

Interactive Demo

Readme

Properties

Property	Attribute	Description	Type	Default
changeEvent	change-event	[DEPRECATED] Use dhlChange event instead An optional input onChange callback handler.	(value: string) => boolean	undefined
customFilter	custom-filter	An optional callback handler that accepts the options and input data, used for custom filtering. If this function is not passed, by default, filtering will happen on the "label" key of the item if its an object or the actual value if the item is a primitive data type	(options: unknown, value: string) => DhlSelectionOptionType[]	undefined
dataAriaDescribedby	data-aria-describedby	An optional prop defining the list of reference IDs (separated by spaces), recommended when you want to an error message on your field.	string	undefined
dataAriaExpanded	data-aria-expanded	An optional prop used for assistive technology support - used to mark expandable and collapsible regions.	string	undefined
dataId	data-id	An optional prop. Gives a valid HTML ID attribute value for the component.	string	undefined
dataTestid	data-testid	An optional prop. The test id attached to the component as a data-testid attribute.	string	undefined
getItemLabel	get-item-label	An optional prop used to read the label of an option.	(option: any) => void	undefined
isDisabled	is-disabled	An optional flag to define if the component is disabled.	boolean	false
name	name	An optional value to be set to the element HTML name attribute. It takes any valid value that can be used for the name attribute of an HTMLInputElement.	string	undefined
openOnFocus	open-on-focus	An optional prop when set to true, the select option list will be shown on input focus.	boolean	false
optionClickEvent	option-click-event	[DEPRECATED] Use dhlClickOption event instead An optional callback for option click event, option is passed as callback parameter.	(option: DhlSelectionOptionType) => void	undefined
readonly	readonly	An optional flag to define if the component is readonly.	boolean	false
required	required	An optional prop to flag the component as required within a form context.	boolean	undefined
showAllOptionsAfterSelection	show-all-options-after-selection	An optional prop flag to define if options should be filtered after selection.	boolean	true
showClearButton	show-clear-button	An optional prop flag to define if clear button is displayed.	boolean	false
showPlaceholderImage	show-placeholder-image	An optional prop to define placeholder image.	boolean	false
showRightIcon	show-right-icon	An optional prop flag to define if right icon is displayed.	boolean	true
showSmallImage	show-small-image	An optional prop flag to define if small image is displayed.	boolean	true
size	size	An optional prop to define the size of the component.	Sizes.MD | Sizes.SM	Sizes.MD
type	type	An optional prop to define the type of the component.	"country" | "phone"	DHL_COUNTRY_SELECT.TYPE.COUNTRY
validation	validation	An optional object to set-up a custom components validation state. Required Fields: type	{ type: Variants.warning | Variants.valid | Variants.invalid | Variants.note; message?: string; }	undefined
value	value	An optional prop defining the value of the component which is taken when a form is submitted.	string	""
variant	variant	A optional object to set-up a custom components variant state. It can be used to set a custom label, a custom placeholder text, enable or disable label animation (via the mandatory type field).	{ label?: string; placeholder?: string; type: Variants.animated | Variants.static; }	{ label: "Select Country", placeholder: "Select Country", type: Variants.static, }

Dependencies

Depends on

• dhl-select

Graph

---

Built by DHL User Interface Library Team!