1.0.0 • Published 4 years ago

rnschedule-practice v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

React Native Schedule View

This React Native component provides a scheduling view with space for unused time. Similar to Google Calendar's Day View.

Installing

Installing is pretty simple:

npm install rnschedule

OR

yarn add rnschedule

Example

import React from 'react';
import RNSchedule from 'rnschedule';

const data = [
    {
      title: 'Lunch Appointment',
      subtitle: 'With Harry',
      start: new Date(2018, 11, 2, 13, 20),
      end: new Date(2018, 11, 2, 14, 20),
      color: '#390099',
    }
  ]

const App = () =>
  <RNSchedule
    dataArray={data}
    onEventPress={(appt) => console.log(appt)}
  />

export default App

Demo

Gif Demo

Features

  • Moving "now" bar.
  • Initial loads view on today centered on "now."
  • Customizable appointment colors.
  • Scaled size of an hour to improve readability on various device sizes.
  • Adjustable hour sizing to make it size to whatever you want.

Properties API

None of the following properties are required. A simple Will still render an empty schedule.

PropDescriptionDefaultType
hourSizeChange the width of lines between hours.depends on screen sizeNumber
headerColorBackground color of the calendar header strip. Acceptable formats: Hex, RGB(A), HSL(A), HSV(A), and named strings. See Tinycolor for all formats.#F5F5F6String or Object
dataArrayArray of date appointment objects. See below example.Empty ArrayArray
leftIconInclude your own icon to the left of the day number.NullReact Component
accentColorColor of day circle in top left. Accepts Tinycolor formats.#1976d2String or Object
status_barDo you want extra margin for the status bar for iOS?trueBoolean
onEventPressReturn function for pressing a schedule event. Returns original data.nullFunction

Data Array Appt Objects

The dataArray prop must be an Array of appointment objects with the following format.

[
  {
    title: 'Lunch Appointment',
    subtitle: 'With Harry',
    start: new Date(2018, 11, 2, 13, 20),
    end: new Date(2018, 11, 2, 14, 20),
    color: '#390099'
  }
]
Appt Object API
KeyDescriptionTypeReq
titleTop title for the appointment.StringRequired
subtitleSlightly less bolded subtitle.StringNot Required
startWhen the appointment starts.DateRequired
endWhen the appointment ends.DateRequired
colorBackground color for the appointment.Tinycolor Accepted String/ObjectNot Required

For onEventPress function - additional properties may be passed so long as they don't interfere with the above api.

Built With

Thanks to these wonderful people for making some great stuff.

Contributing

I'm looking to add new contributors/maintainers to help out. So if you like this repo and want to help make it better let me know.

To-Do List

The component is very much under-construction. Want to help build something? Here is my to-do list:

  • Provide more control over Day Selector Styling.
  • Work on speed optimization.
  • Swipe to change days.
  • Full Day appointments.
  • Multi-Day appointments.
  • Option for dots on days with appts.
  • Events longer than 24 hours.
  • Spec UI to Material Design.
  • Build out testing.
  • Contribution guidelines.
  • Break out schedule view as stand-alone without cal select header.
  • Fix Shadowing on Header - feels weird.

Special Thanks

  • Special thanks to Wix's RN Calendar for getting things started and providing inspiration.