react-native-week-view

Basic Usage

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

const myEvents = [
  // ...
];

const MyComponent = () => (
  <WeekView
    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

{
  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:

<WeekView
  // ... 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:

const MyEventComponent = ({ event, position }) => (
  <Icon
    name={event.iconName}
    type={event.iconType}
    color={event.color}
    size={position.height}
  />
);

<WeekView
  // ... 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:

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

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