react-native-week-view

!weekView

Basic Usage

``js
import WeekView from 'react-native-week-view';

const myEvents = [
// ...
];

const MyComponent = () => (
events={myEvents}
selectedDate={new Date()}
numberOfDays={7}
/>
);

`

Props


* events _(Array)_ - Events to display, in Event Object format (see below)
* onEventPress _(Function)_ - Callback when event item is clicked
* numberOfDays _(Number)_ - Set number of days to show in view, can be 1, 3, 5, 7.
* formatDateHeader _(String)_ - Format for dates of header, default is MMM D
* selectedDate _(Date)_ - Intial date to show week/days in the view. Note: changing this prop will not have any effect in the displayed date; to actually change the date being displayed, use the goToDate() method, see below.
* onSwipeNext _(Function)_ - Callback when calendar is swiped to next week/days
* onSwipePrev _(Function)_ - Callback when calendar is swiped to previous week/days
* locale _(String)_ - locale for the header, there's a addLocale function to add cusomized locale. Default is en.
* showTitle _(Boolean)_ - show/hide the title (the selected month and year). Default is true.
* headerStyle _(Object)_ - custom styles for header container. Example: { backgroundColor: '#4286f4', color: '#fff', borderColor: '#fff' }
* headerTextStyle _(Object)_ - custom styles for text inside header. Includes day names and title (month)
* hourTextStyle _(Object)_ - custom styles for text displaying hours in the left.
* eventContainerStyle _(Object)_ - custom styles for the event container. Notice the background color and positioning (absolute) are already set.
* hoursInDisplay _(Number)_ - Amount of hours to display in the screen. Default is 6.
* startHour _(Number)_ - Hour to scroll to on start. Default is 8 (8 am).
* onGridClick _(Function)_ - Callback when the grid view is clicked, signature: (pressEvent, startHour, date) => {}.
* pressEvent _(Object)_ - object passed by the TouchableWithoutFeedback.onPress() method (and not an event object as defined below)
* startHour _(Number)_ - hour clicked (as integer)
* date _(Date)_ - date object indicating day clicked (the hour is not relevant)
* EventComponent _(React.Component)_ - Component rendered inside an event. By default, is a Text with the event.description. See below for details on the component.
* rightToLeft _(Boolean)_ - If true, render older days to the right and more recent days to the left.
* prependMostRecent _(Boolean)_ - If true, the horizontal prepending is done in the most recent dates. See issue #39 for more details. Default is false.

Event Object

`js
{
id: 1,
description: 'Event',
startDate: new Date(),
endDate: new Date(),
color: 'blue',
// ... more properties if needed,
}
`

Methods

To use the component methods save a reference to it:
`js
// ... other props
ref={(ref) => { this.weekViewRef = ref; }}
/>
`

* goToDate(date, animated = true): when called, the component navigates to a custom date. Note: if the target date has not been rendered before, there may be a delay on the animation. See this issue for details.




Custom EventComponent


The component will be rendered inside a TouchableOpacity, which has the background color set to event.color, and is placed with absolute position in the grid. The component receives two props:
* event _(Event)_ - Event object as described before.
* position: _(Object)_ - object containing top, left, height and width values in pixels.

For example, to display an icon inside each event, such as a react-native-elements Icon:
`js
const MyEventComponent = ({ event, position }) => (
name={event.iconName}
type={event.iconType}
color={event.color}
size={position.height}
/>
);

// ... other props
EventComponent={MyEventComponent}
/>
`

Locales customization


There's a addLocale function to add customized locale for the component. The component depends on momentjs, you can refer to https://momentjs.com/docs/#/customization/ for more information.

Example:
`js
export WeekView, { addLocale } from 'react-native-week-view';
// add customized localed before using locale prop.
addLocale('fr', {
months: 'janvier_février_mars_avril_mai_juin_juillet_août_septembre_octobre_novembre_décembre'.split('_'),
monthsShort: 'janv._févr._mars_avr._mai_juin_juil._août_sept._oct._nov._déc.'.split('_'),
weekdays: 'dimanche_lundi_mardi_mercredi_jeudi_vendredi_samedi'.split('_'),
weekdaysShort: 'dim._lun._mar._mer._jeu._ven._sam.'.split('_'),
});
``

TODO

- [x] allow to swipe between weeks or days.
- [x] header should be swipeable with columns.
- [x] allow to click on grid view.
- [ ] allow to drag drop events to specific time and date.