1.0.7 • Published 5 years ago

horizontal-calendar v1.0.7

Weekly downloads
74
License
MIT
Repository
github
Last release
5 years ago

horizontal-calendar

Fancy horizontal scrolling calendar for react

NPM JavaScript Style Guide

:baby_bottle: horizontal-calendar is in alpha

Install

npm install --save horizontal-calendar

Live Example

Live Horizontal Calendar

Usage

HorizontalCalendar will size itself (width-wise) according the width of it's parent container.

Parameters

  • showing - object with keys named years, quarters, months, days, weeks or days. This parameter is optional, and will default to all showing. Additionaly, you only have to include the keys you want to toggle.
  • noSelect - object with same keys as showing. This parameter is optional, and only the keys you want to toggle need to be included. If you would like to make something visible, but not selectable (i.e. show years and months, but only select days), you would uses showing={{quarters: false, weeks: false}} and noSelect={{years: false, months:false}}.
  • startDate - start of date range to display. Can be Unix seconds or date in string format YYYY-MM-DD - note the calendar runs in UTC internally (without a timezone).
  • endDate - end of date range to display. Can be Unix seconds or date in string format YYYY-MM-DD - note the calendar runs in UTC internally (without a timezone).
  • selectedMode - used to render with a selected period in conjunction with selectedDate. Options are day, week, month, quarter and year.
  • selectedDate - used to render with a selected period in conjunction with selectedMode. Can be Unix seconds or date in string format YYYY-MM-DD - note the calendar runs in UTC internally (without a timezone).

Note this componenet uses Scrollomatic for horizontal scrolling with scrollbars that look the same on all platforms.

Example

import React, { Component } from 'react'

import HorizontalCalendar from 'horizontal-calendar'

export default class App extends Component {
  render () {
    return (
      <div>
        <HorizontalCalendar
          showing={{
            years: true,
            quarters: true,
            months: true,
            days: true,
            weeks: true
          }}
          noSelect={{
            years: false,
            quarters: false,
            months: false,
            days: false,
            weeks: false
          }}
          startDate='2015-08-05'
          endDate='2017-08-05'
          selectedMode='day'
          selectedDate='2017-06-07'/>
      </div>
    )
  }
}

License

MIT

Copyright 2018, Crowd Conduct Corp.

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago