react-native-expo-modal-select
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

react-native-expo-modal-select

This is customizable Modal Select for your React Native and Expo application.

Installation

npm install react-native-expo-modal-select

or

yarn add react-native-expo-modal-select

Usage

import React, { useState } from 'react';
import { StyleSheet, View } from 'react-native';
import ModalSelect, { Item } from 'react-native-expo-modal-select';

const countries: Item[] = [
  {
    label: 'Brazil',
    value: 'brazil',
  },
  {
    label: 'EUA',
    value: 'eua',
  },
  {
    label: 'Canada',
    value: 'canada',
  },
];

export default function Select() {
  const [country, setCountry] = useState('');
  return (
    <View style={styles.container}>
      <ModalSelect
        label="country"
        placeholder="Select your country"
        items={countries}
        value={country}
        onChange={(value) => setCountry(value)}
      />
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    padding: 16,
    backgroundColor: '#ddd',
  },
});

Reference

testID

id for testing

Type Required Default
string No undefined

label

display a text label for describing the select component

Type Required Default
string No undefined

required

display * for required fields

Type Required Default
boolean No false

items

array of Item that will be represented in modal as all the options that could be selected

Type Required Default
array Yes

value

selected item in modal select

Type Required Default
string Yes

placeholder

text that will be displayed inside the touchable

Type Required Default
string No undefined

touchableStyle

style object for touchable

Type Required Default
object No undefined

touchableTextStyle

style object for text inside touchable

Type Required Default
object No undefined

itemTouchableStyle

style object for select item touchable

Type Required Default
object No undefined

itemTextStyle

style object for select item text

Type Required Default
object No undefined

errorTextStyle

style object for error text

Type Required Default
object No undefined

labelStyle

style object for label text

Type Required Default
object No undefined

modalStyle

style object for customizing modal

Type Required Default
object No undefined

modalTitleStyle

style object for modal title text

Type Required Default
object No undefined

showErrorMessage

when false, hide the error message keeping the error style.

Type Required Default
boolean No true

errorColor

defines the error used when has an error

Type Required Default
string No #e74c3c

closeTextStyle

style object for modal close button text

Type Required Default
object No undefined

cancelTouchableText

text that will be displayed inside the cancel touchable

Type Required Default
string No Cancel

emptyIndicatorText

text that will be displayed inside the empty indicator

Type Required Default
function Yes Sorry, there is nothing to be shown here

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT


Made with create-react-native-library

Package Sidebar

Install

npm i react-native-expo-modal-select

Weekly Downloads

2

Version

0.1.4

License

MIT

Unpacked Size

69.1 kB

Total Files

38

Last publish

Collaborators

  • guribeiro