react-native-calendar-strip

Easy to use and visually stunning calendar component for React Native.

<CalendarStrip> is a React Native component designed to replace the standard date picker component. It works for both iOS and Android and in both portrait and landscape orientations!

Instalation

Just use the standard npm installation

npm install react-native-calendar-strip --save

Example

You can see the examples in \example folder of this repo.

Simple "out of the box" usage

You can use this component without any styling or customization. Just import it in your project and render it:

import React, {Component} from 'react';
import {
    AppRegistry,
    View
} from 'react-native';

import CalendarStrip from 'react-native-calendar-strip';

class Example extends Component {
    render() {
        return (
            <View>
                <CalendarStrip/>
            </View>
        );
    }
}

AppRegistry.registerComponent('Example', () => Example);

Styling and animations

Even though this component works withouth any customization, it is possible to customize almost everything, so you can make it as beautiful as you want:

import React, {Component} from 'react';
import {
    AppRegistry,
    View
} from 'react-native';

import CalendarStrip from 'react-native-calendar-strip';

class Example extends Component {
    render() {
        return (
            <View>
                <CalendarStrip
                    calendarAnimation={{type: 'sequence', duration: 30}}
                    selection={'border'}
                    selectionAnimation={{duration: 300, borderWidth: 1}}
                    style={{paddingTop: 20, paddingBottom: 10}}
                    calendarHeaderStyle={{color: 'white'}}
                    calendarColor={'#7743CE'}
                    highlightColor={'#9265DC'}
                    dateNumberStyle={{color: 'white'}}
                    dateNameStyle={{color: 'white'}}
                    borderHighlightColor={'white'}
                    iconLeft={require('./img/left-arrow.png')}
                    iconRight={require('./img/right-arrow.png')}
                    iconContainer={{flex: 0.1}}
                />
            </View>
        );
    }
}

AppRegistry.registerComponent('Example', () => Example);

Props / API

This is the list of all the props you can pass to the component so that you can customize it:

Initial data and onDateSelected handler

• startingDate: React.PropTypes.any - Date to be used for centering the calendar/showing the week based on that date. It is internaly wrapped by moment so it accepts both Date and moment Date.
• selectedDate: React.PropTypes.any - Date to be used as pre selected Date. It is internaly wrapped by moment so it accepts both Date and moment Date.
• onDateSelected: React.PropTypes.func - Function to be used as a callback when a date is selected. It returns moment Date

Top level style

• style: React.PropTypes.any - Style for the top level CalendarStrip component

Icon

• iconLeft: React.PropTypes.any - Icon to be used for the left icon. It accepts require statement with url to the image (require('./img/icon.png')), or object with remote uri {uri: 'http://example.com/image.png'}
• iconRight: React.PropTypes.any - Icon to be used for the right icon. It accepts require statement with url to the image (require('./img/icon.png')), or object with remote uri {uri: 'http://example.com/image.png'}
• iconStyle: React.PropTypes.any - Style that is applied to both left and right icons. It is applied before iconLeftStyle or iconLeftStyle.
• iconLeftStyle: React.PropTypes.any - Style for left icon. It will override all of the other styles applied to icons.
• iconRightStyle: React.PropTypes.any - Style for right icon. It will override all of the other styles applied to icons.
• iconContainer: React.PropTypes.any - Style for the container of icons. (Example usage is to add flex property to it so in the portrait mode, it will shrink the dates strip)

Header style and formating

• calendarHeaderStyle: React.PropTypes.any - Style for the header text of the calendar.
• calendarHeaderFormat: React.PropTypes.string - Format for the header text of the calendar. For options, refere to moments documentation

Date name and number styling

• dateNameStyle: React.PropTypes.any - Style for the name of the day on work days in dates strip.
• dateNumberStyle: React.PropTypes.any - Style for the number of the day on work days in dates strip.
• weekendDateNameStyle: React.PropTypes.any - Style for the name of the day on weekend days in dates strip.
• weekendDateNumberStyle: React.PropTypes.any - Style for the number of the day on weekend days in dates strip.

Animations

There are two animated properties that also can be customized. The first one is actually animated showing of dates when you change a week. If you do not add this prop, it will not have an animation There are 2 possible options.

• calendarAnimation: React.PropTypes.object - Animation object for showin the dates. It can have 2 types: {type: 'sequence', duration: 30} or {type: 'parallel', duration: 300} and the duration part being the duration of animation in millisecond.

####### Sequence The animation is used to show dates in sequence, so it shows them one by one.

####### Parallel The animation is used to show dates in parallel, so it shows all of them with opacity animation.

---

The second animation is used to animate selection of the date. Again, there are 2 types of animation, and they are either animating circular border around a date or changing a circualar background of the date.

• selection: React.PropTypes.string - String prop for type of selection highligh. Possible types are border or background. !important This property will only determen the type of selection and type of animation, but to be animated, properties bellow have to be added as well.
• selectionAnimation: React.PropTypes.object - An object used for the animation of selection. If this object is added, only then the selection will be animated. This object defines {duration: 30} of the animation, and if you add a type border of selection, you should also add a {duration: 30, borderWidth: 1} to this object.
• borderHighlightColor: React.PropTypes.string - Highlighting border color.

If you chose the background type of animation, the selected date will animate the circular background color from calendarColor to highlightColor. That is why, when this type is chosen, you have to define both of these colors.

• calendarColor: React.PropTypes.string - Color of the circular backgroundo of the date. !important This color will also be aplied as the whole calendar strip background color, so that highlighting the date will appear 'from background' but be aware that top level style of this component can override this property.
• highlightColor: React.PropTypes.string - Highlighting color of dates.

ToDo

• Add unit tests
• Add Travis CI integration
• Implement week view, which should show weeks in a month rather than days, so that you select the whole week
• Add a month and a year selection in a form of a popup

Licence

The MIT License (MIT) Copyright (c) 2016 Bogdan Begovic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.