Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/wix/react-native-calendars

React Native Calendar Components πŸ—“οΈ πŸ“†
https://github.com/wix/react-native-calendars

android calendar hacktoberfest ios react-native ui-components

Last synced: 2 months ago
JSON representation

React Native Calendar Components πŸ—“οΈ πŸ“†

Lists

README 

        
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)



# React Native Calendars πŸ—“οΈ πŸ“†



## A declarative cross-platform React Native calendar component for iOS and Android.



[![Version](https://img.shields.io/npm/v/react-native-calendars.svg)](https://www.npmjs.com/package/react-native-calendars)

[![Build Status](https://travis-ci.org/wix/react-native-calendars.svg?branch=master)](https://travis-ci.org/wix/react-native-calendars)







This module includes information on how to use this customizable **React Native** calendar component.



The package is compatible with both **Android** and **iOS**







> ### **Official documentation**

>

> This README provides basic examples of how to get started with `react-native-calendars`. For detailed information, refer to the [official documentation site](https://wix.github.io/react-native-calendars/docs/Intro).



## Features ✨



- Pure JS. No Native code required

- Date marking - dot, multi-dot, period, multi-period and custom marking

- Customization of style, content (days, months, etc) and dates

- Detailed documentation and examples

- Swipeable calendar with flexible custom rendering

- Scrolling to today, selecting dates, and more

- Allowing or blocking certain dates

- Accessibility support

- Automatic date formatting for different locales



## Try it out ⚑



You can run a sample module using these steps:



```

$ git clone [email protected]:wix/react-native-calendars.git



$ cd react-native-calendars



$ npm install



$ cd ios && pod install && cd ..



$ react-native run-ios

```



You can check example screens source code in [example module screens](https://github.com/wix-private/wix-react-native-calendar/tree/master/example/src/screens)



This project is compatible with Expo/CRNA (without ejecting), and the examples have been [published on Expo](https://expo.io/@community/react-native-calendars-example)



## Getting Started πŸ”§



Here's how to get started with react-native-calendars in your React Native project:



### Install the package:



Using `npm`:



```

$ npm install --save react-native-calendars

```



Using `Yarn`:



```

$ yarn add react-native-calendars

```



**RN Calendars is implemented in JavaScript, so no native module linking is required.**



## Usage πŸš€



Basic usage examples of the library



##### **For detailed information on using this component, see the [official documentation site](https://wix.github.io/react-native-calendars/docs/Intro)**



### Importing the `Calendar` component



```javascript

import {`[Calendar](#calendar), [CalendarList](#calendarlist), [Agenda](#agenda)`} from 'react-native-calendars';

```



### Use the `Calendar` component in your app:



```javascript

 {

    console.log('selected day', day);

  }}

/>

```



## Some Code Examples



Here are a few code snippets that demonstrate how to use some of the key features of react-native-calendars:



### Creating a basic calendar with default settings:



```javascript

import React, {useState} from 'react';

import {Calendar, LocaleConfig} from 'react-native-calendars';



const App = () => {

  const [selected, setSelected] = useState('');



  return (

     {

        setSelected(day.dateString);

      }}

      markedDates={{

        [selected]: {selected: true, disableTouchEvent: true, selectedDotColor: 'orange'}

      }}

    />

  );

};



export default App;

```



### Customize the appearance of the calendar:



```javascript

 {

    console.log('selected day', day);

  }}

  // Mark specific dates as marked

  markedDates={{

    '2012-03-01': {selected: true, marked: true, selectedColor: 'blue'},

    '2012-03-02': {marked: true},

    '2012-03-03': {selected: true, marked: true, selectedColor: 'blue'}

  }}

/>

```



### Configuring the locale:



```javascript

import {LocaleConfig} from 'react-native-calendars';

import React, {useState} from 'react';

import {Calendar, LocaleConfig} from 'react-native-calendars';



LocaleConfig.locales['fr'] = {

  monthNames: [

    'Janvier',

    'FΓ©vrier',

    'Mars',

    'Avril',

    'Mai',

    'Juin',

    'Juillet',

    'AoΓ»t',

    'Septembre',

    'Octobre',

    'Novembre',

    'DΓ©cembre'

  ],

  monthNames: [

    'Janvier',

    'FΓ©vrier',

    'Mars',

    'Avril',

    'Mai',

    'Juin',

    'Juillet',

    'AoΓ»t',

    'Septembre',

    'Octobre',

    'Novembre',

    'DΓ©cembre'

  ],

  monthNamesShort: ['Janv.', 'FΓ©vr.', 'Mars', 'Avril', 'Mai', 'Juin', 'Juil.', 'AoΓ»t', 'Sept.', 'Oct.', 'Nov.', 'DΓ©c.'],

  dayNames: ['Dimanche', 'Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi'],

  dayNamesShort: ['Dim.', 'Lun.', 'Mar.', 'Mer.', 'Jeu.', 'Ven.', 'Sam.'],

  today: "Aujourd'hui"

};



LocaleConfig.defaultLocale = 'fr';



const App = () => {

  const [selected, setSelected] = useState('');



  return (

     {

        setSelected(day.dateString);

      }}

      markedDates={{

        [selected]: {selected: true, disableTouchEvent: true, selectedDotColor: 'orange'}

      }}

    />

  );

};



export default App;

```



### Adding a global theme to the calendar:



```javascript

import React, { useState } from 'react';

import { Calendar, LocaleConfig } from 'react-native-calendars';



const App = () => {

  const [selected, setSelected] = useState('');



  return (

    



### Dot marking



  



### Multi-Dot marking



 



### Period Marking



  



  



### Multi-Period marking



  



### Custom marking



  



  



### Date loading indicator



  



### Scrollable semi-infinite calendar



  



### Horizontal calendar



  



### Agenda



  







## Authors



- [Tautvilas Mecinskas](https://github.com/tautvilas/) - Initial code - [@tautvilas](https://twitter.com/Tautvilas)

- Katrin Zotchev - Initial design - [@katrin_zot](https://twitter.com/katrin_zot)



See also the list of [contributors](https://github.com/wix/react-native-calendar-components/contributors) who participated in this project.



## Contributing



We welcome contributions to react-native-calendars.



If you have an idea for a new feature or have discovered a bug, please open an issue.



Please `npm run test` and `npm run lint` before pushing changes.



Don't forget to add a **title** and a **description** explaining the issue you're trying to solve and your proposed solution.



Screenshots and Gifs are VERY helpful to add to the PR for reviews.



Please DO NOT format the files - we're trying to keep a unified syntax and keep the reviewing process fast and simple.



## License



React Native Calendars is MIT licensed