react-native-month-year-picker

React Native month picker component for iOS and Android

android	iOS

Getting started

$ npm install react-native-month-year-picker --save

or

$ yarn add @react-native-month-year-picker

For react-native@0.60.0 or above

As react-native@0.60.0 or above supports autolinking, so there is no need to run linking process. Read more about autolinking here.

iOS

CocoaPods on iOS needs this extra step

npx pod-install

Usage

import React, { useState } from 'react';
import { View, SafeAreaView, Text } from 'react-native';
import MonthPicker from 'react-native-month-year-picker';

const App = () => {
  const [date, setDate] = useState(new Date());

  const onValueChange = (event, newDate) => setDate(newDate);

  return (
    <SafeAreaView style={styles.container}>
      <Text>Month Picker Example</Text>
      <MonthPicker
        onChange={onValueChange}
        value={date}
        minimumDate={new Date()}
        maximumDate={new Date(2025, 5)}
      />
    </SafeAreaView>
  );
};

export default App;

Props

onChange (optional)

Date change handler.

This is called when the user changes the date in the UI. It receives the event and the date as parameters.

setDate = (event, date) => {};

<RNMonthPicker onChange={this.setDate} />;

value (required)

Defines the date value used in the component.

<RNMonthPicker value={new Date()} />

maximumDate (optional)

Defines the maximum date that can be selected. Use year and month constructor.

<RNMonthPicker maximumDate={new Date(2030, 10)} />

minimumDate (optional)

Defines the minimum date that can be selected. Use year and month constructor.

<RNMonthPicker minimumDate={new Date(2020, 5)} />

outputFormat (optional)

Defines the output format in which the date will return. Defaults to MM-YYYY. Refer to moment.js docs for more information about formats.

<RNMonthPicker outputFormat="M-YY" />

okButton (optional - Android only)

Picker modal confirmation button text. Default OK.

<RNMonthPicker okButton="Confirm" />

cancelButton (optional - Android only)

Picker modal cancelation button text. Default Cancel.

<RNMonthPicker cancelButton="Abort" />

Running example

1. Install required pods in example/ios by running npx pod-install.
2. Run yarn start to start Metro Bundler.
3. Run yarn ios or yarn android.