react-native-country

This package provides a country selector with a search engine.

Example

Basic usage

1import { CountrySelector } from "react-native-countries";
2
3export default function App() {
4  const [show, setShow] = useState(false);
5  const [countryCode, setCountryCode] = useState('');
6  const [flag, setFlag] = useState('');
7  return (
8    <View style={styles.container}>
9      <TouchableOpacity
10        onPress={() => setShow(true)}
11        style={{
12            width: '80%',
13            height: 60,
14            backgroundColor: 'white',
15            padding: 10,
16        }}
17      >
18        <Text style={{
19            color: 'black',
20            fontSize: 20
21        }}>
22            {countryCode ? 'Selected  country: ' + countryCode + ` ${flag}` : 'Click Here!'}
23        </Text>
24      </TouchableOpacity>
25
26      {/* For showing picker just put show state to show prop */}
27      <CountrySelector
28        show={show}
29        searchMessage={`No country was found`}
30        onBackdropPress={() => setShow(false)}
31        inputPlaceholder='Search for the country by name'
32        // when selector button press you will get the country object with dial code
33        selectorButtonOnPress={(item) => {
34          setCountryCode(item.dial_code);
35          setFlag(item.flag);
36          setShow(false);
37        }}
38      />
39      <StatusBar style="auto" />
40    </View>
41  );
42}

Props

Below are the props you can pass to the React Component.

Prop	Type	Default	Example	Description
show	boolean			this prop is used to show/hide the modal.
selectorButtonOnPress	function		(country) => setCode(country.dial_code)	Put your function here to get the result of the selected country.
inputPlaceholder	string		inputPlaceholder={'Your placeholder'}	If you want a custom placeholder
searchMessage	string		searchMessage={'Some search message here'}	If you want a different message when you can't find a country
lang	string	'en'	lang={'pl'}	If you want to change the language, just 'en'/'es'. required lang just add them and make a PR :)
enableModalAvoiding	boolean	false	enableModalAvoiding={true}	For the modal to avoid the keyboard androidWindowSoftInputMode with value pan, by default android will avoid keyboard by itself
androidWindowSoftInputMode	string		androidWindowSoftInputMode={'pan'}	Basically android bypasses the keyboard by itself, if you want to use the custom bypassing you can use this prop
itemTemplate	ReactNode	CountryButton	itemTemplate={YourTemplateComponentsHere}	This parameter gets a React Node element to render as a template for each item in the list. These properties are sent to the element: key, element, style, name and onPress.
style	Object		style={{yoursStylesHere}}	If you want to change the styles of the components you probably need this props. You can check the styling part below.
disableBackdrop	boolean	false	disableBackdrop	if you don't want to show the modal background pass this prop.
onBackdropPress	function	null	onBackdropPress={() => setShow(false)}	If you want to close the modal by pressing outside the modal.
initialState	string		initialState={'+380'}	Sometimes it is necessary to pre-select the country, for example, because of the user's current location, so you can use this option.
excludedCountries	array		excludedCountries={['RU', 'AF']}	In this option you can define the list of countries to be deleted by adding their codes.

You can also use all the other FlatList and TextInput props if you need to.

Styling

1<CountrySelector
2    show={show}
3    lang={'es'}
4    style={{
5        // styles for the modal
6        modal: {
7            height: 800,
8            backgroundColor: '#17bebb'
9        },
10        // Styles for modal backdrop [View]
11        backdrop: {
12        
13        },
14        // Styles for bottom input line [View]
15        line: {
16        
17        },
18        // Styles for list of countries [FlatList]
19        itemsList: {
20        
21        },
22        // Styles for input [TextInput]
23        textInput: {
24              height: 80,
25              borderRadius: 0,
26        },
27        // Styles for country button [TouchableOpacity]
28        countryButtonStyles: {
29              height: 80
30        },
31        // Styles for search message [Text]
32        searchMessageText: {
33
34        },
35        // Styles for search message container [View]
36        countryMessageContainer: {
37        
38        },
39        // Flag styles [Text]
40        flag: {
41
42        },
43        // Dial code styles [Text]
44        dialCode: {
45
46        },
47        // Country name styles [Text]
48        countryName: {
49
50        }
51    }}
52    selectorButtonOnPress={(item) => {
53        setCountryCode(item.dial_code);
54        setShow(false);
55    }}
56/>