day-schedule-selector

A jQuery plugin to render a weekly schedule and allow selecting time slots in each day.

Getting Started

$('#weekly-schedule').dayScheduleSelector({
  /* options */
});

Options

$("#weekly-schedule").dayScheduleSelector({
  days: [1, 2, 3, 5, 6],
  startTime: '09:50',
  endTime: '21:06',
  horizontalView: true,
  interval: 15
});

days

default: [0, 1, 2, 3, 4, 5, 6]

An integer array of days included in the calendar with Sunday being 0 and Saturday being 6.

startTime

default: '08:00'

Start time of each day on the calendar, in HH:mm format.

endTime

default: '20:00'

End time of each day on the calendar, in HH:mm format.

interval

default: 30

An integer value representing length of each time slot, in minutes.

horizontalView

default: false

A boolean value to switch display. Columns are hours, rows are days.

Events

The following custom events are triggered on the element.

selected.artsy.dayScheduleSelector

Triggered when a selection is made. Passes the event and an array of selected time slots to the event handler.

$("#weekly-schedule").on('selected.artsy.dayScheduleSelector', function (e, selected) {
  /* selected is an array of time slots selected this time. */
}

Serialization to cron

In order to get a cron-like string out of the exclusion array that you can get when serializing a schedule, you can perform the following:

var data = $("#weekly-schedule").data('artsy.dayScheduleSelector').serialize();
var cronString = window.DayScheduleSelector.serializedToCron(data);

For instance, for the exclusion list

var exclusionList = {
 "0": [],
 "1": [],
 "2": [],
 "3": [
  [
   "10:00",
   "12:00"
  ]
 ],
 "4": [],
 "5": [
  [
   "03:00",
   "09:00"
  ]
 ],
 "6": []
}

It gives the corresponding cron string

"0 * * * sun,mon,tue,thu,sat</br>0 0-9,12-24 * * wed</br>0 0-2,9-24 * * fri</br>"

Installation

Install as a Ruby gem

Add this line to your application's Gemfile:

gem 'day_schedule_selector', '0.1.0', { git: 'https://github.com/starsirius/day-schedule-selector.git', branch: 'master' }

And then execute:

$ bundle

Usage

TODO: Write usage instructions here

Development

Ruby gem

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Fork it ( https://github.com/starsirius/day-schedule-selector/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

eirmag / day-schedule-selector