2.0.1 • Published 2 years ago

@vespaiach/horizontal-calendar v2.0.1

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

React Horizontal Infinity-Scrolling Calendar

A simple and reusable calendar for React application with supporting of infinity scrolling horizontally.

Demo

Installation

The Calendar can be installed via npm:

npm install @vespaiach/horizontal-calendar --save

Or via yarn:

yarn add @vespaiach/horizontal-calendar

You will need to install packages: React, @use-gesture/react and classnames. Please find their support versions under peerDependencies section in package.json

The Gist

You will also need to include CSS file calendar.css from this package. The below example shows how to include CSS files

import '@vespaiach/horizontal-calendar/dist/calendar.css';
import '@vespaiach/horizontal-calendar/dist/defaultTheme.css';

import React from 'react';
import ReactDOM from 'react-dom';

import Calendar from '@vespaiach/horizontal-calendar';

function App() {
    const [selection, setSelection] = useState<Date | [Date, Date | null] | null>(null);

    return <Calendar rangeSelection selection={selection} onChange={setSelection} />;
}

ReactDOM.render(<App />, document.querySelector('#root'));

Note: overwrite defaultTheme.css to re-style the calendar as you wish

Configuration

The basic usage:

<Calendar onChange={handleChange} />
optionsNoterequired
onChange(values: Date | Date, Date | null) => voidno
classNamestring - css classno
startAtDate - the date calendar will show from beginingno (default current date)
rangeSelectionboolean - allow to select a range of datesno (default to only select single date)
selectionDate | Date, Date | null | null - dates are being selectedno
monthBoxWidthnumber - width of each month boxno (default = 290px)
monthNameCellHeightnumber - height of very top cellno (default = 32px)
weekDayCellHeightnumber - height of week day cellno (default = 32px)
dateCellHeightnumber - height of date cellno (default = 32px)

License

See the MIT license file.

2.0.1

2 years ago

2.0.0

2 years ago

1.0.0

2 years ago

0.0.9

2 years ago