https://github.com/yuthelloworld/calendar
📅 A lightweight calendar build with react.
https://github.com/yuthelloworld/calendar
calendar react
Last synced: about 1 year ago
JSON representation
📅 A lightweight calendar build with react.
- Host: GitHub
- URL: https://github.com/yuthelloworld/calendar
- Owner: YutHelloWorld
- License: mit
- Created: 2017-09-15T15:10:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-31T08:57:24.000Z (about 8 years ago)
- Last Synced: 2025-03-18T20:40:41.108Z (over 1 year ago)
- Topics: calendar, react
- Language: JavaScript
- Homepage: https://yuthelloworld.github.io/calendar/
- Size: 1.96 MB
- Stars: 13
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vortex-calendar
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[![npm license][license-image]][license-url]
[npm-image]: https://img.shields.io/npm/v/vortex-calendar.svg?style=flat-square
[npm-url]: https://npmjs.org/package/vortex-calendar
[travis-image]: https://img.shields.io/travis/YutHelloWorld/calendar.svg?style=flat-square
[travis-url]: https://travis-ci.org/YutHelloWorld/calendar
[node-image]: https://img.shields.io/badge/node.js-%3E=_6.11-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/vortex-calendar.svg?style=flat-square
[download-url]: https://npmjs.org/package/vortex-calendar
[license-image]: https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square
[license-url]: https://github.com/YutHelloWorld/calendar/blob/master/LICENSE
A light calendar 📅 . (gzipped: 2.45K)
👉 [Online](https://yuthelloworld.github.io/calendar/)
## Installation
```bash
# npm install vortex-calendar
yarn add vortex-calendar
```
## Usage
```JS
import Calendar from 'vortex-calendar'
import React from 'react'
import {render} from 'react-dom'
const MOUNT_NODE = document.getElementById('root')
render( console.log(v)}
/>, MOUNT_NODE)
```
## Prop Types
|Property|Type|Default|Description|
|:---:|:---:|:---:|:---:|
|minDate|String ('YYYY-MM-DD')| | The minimum date that is selectable|
|maxDate|String ('YYYY-MM-DD')| | The maximum date that is selectable|
|onSelect|Function| | Callback invoked after date select|
|locale|String| 'en'| By default, calendar comes with the English locale.
You can set 'zh' for Chinese.|
## Contributing
- Clone this repository.
```bash
git clone https://github.com/YutHelloWorld/calendar.git
cd
```
- Install all dependencies by `yarn` or `npm i`.Then code in `./src`.
- Run `yarn build` && `yarn start` to see changes with demo.
- Pull your request.
## License
The MIT License.