Nervously Proposing Marriage

    react-datepicker-fa

    1.0.3 • Public • Published

    React Date Picker

    npm npm Build Status CircleCI

    A simple and reusable Datepicker component for React (with persian jalali calendar support) Demo.

    This package uses react-persian-datepicker project under the hood.

    Installation

    The package can be installed via NPM:

    npm install react-datepicker-fa --save
    

    At this point you can import react-datepicker-fa and its styles in your application as follows:

    import DatePicker from 'react-datepicker-fa';
     
    // Be sure to include styles at some point, probably during your bootstrapping
    import 'react-datepicker-fa/dist/react-datepicker-fa.min.css';

    Below is a simple example on how to use the Datepicker in a React view. You will also need to require the css file from this package (or provide your own). The example below shows how to include the css from this package if your build system supports requiring css files (webpack is one that does).

    import React from 'react'
    import moment from 'moment-jalaali'
    import DatePicker from 'react-datepicker-fa';
     
    import 'react-datepicker-fa/dist/react-datepicker-fa.min.css';
     
    export default React.createClass({
      getInitialState() {
        return {
          value: moment()
        }
      },
      render() {
        return <DatePicker
          onChange={value => this.setState({ value })}
          value={this.state.value}
        />
      }
    })
     

    You can also use the standalone build by including react-datepicker-fa.js and react-datepicker-fa.css in your page. (If you do this though you'll also need to include the dependencies.) For example:

    <script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.1.0/react.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/react/15.1.0/react-dom.min.js"></script>
    <script src="https://unpkg.com/classnames/index.js"></script>
    <script src="https://unpkg.com/react-datepicker-fa/dist/index.js"></script>
     
    <link rel="stylesheet" href="https://unpkg.com/react-datepicker-fa/dist/react-datepicker-fa.min.css">

    Configuration

    The most basic use of the DatePicker can be described with:

    <DatePicker onChange={value => this.setState({ value })} value={this.state.value} />

    Local Development

    The master branch contains the latest version of the datepicker-fa component. To start your example app, you can run npm install then npm start. This starts a simple webserver on http://localhost:8080.

    Todo

    • Write some tests
    • Better documentation
    • UI improvements
    • Remove classnames dependency

    Built With

    • moment-jalaali - A Jalaali (Jalali, Persian, Khorshidi, Shamsi) calendar system plugin for moment.js.

    Thanks

    Special thanks to @mohebifar for his open-source project which this component is based on.

    Contributing

    Contributions are welcome and will be fully credited. I'd be happy to accept PRs for that.

    License

    Copyright (c) 2016 savalanpour Inc. and individual contributors. Licensed under MIT license, see LICENSE for the full license.

    Install

    npm i react-datepicker-fa

    DownloadsWeekly Downloads

    4

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    4.43 MB

    Total Files

    106

    Last publish

    Collaborators

    • savalanpour