https://github.com/ripjar/material-datetime-picker

A material design date-time picker for the web
https://github.com/ripjar/material-datetime-picker

date-picker datetime-picker javascript material-design web

Last synced: 4 days ago
JSON representation

A material design date-time picker for the web

• Host: GitHub
• URL: https://github.com/ripjar/material-datetime-picker
• Owner: ripjar
• License: mit
• Created: 2015-12-23T10:40:53.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-10-14T18:13:09.000Z (about 6 years ago)
• Last Synced: 2024-10-18T13:20:09.113Z (23 days ago)
• Topics: date-picker, datetime-picker, javascript, material-design, web
• Language: JavaScript
• Homepage:
• Size: 707 KB
• Stars: 247
• Watchers: 33
• Forks: 82
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# Material Datetime Picker 

A Material Design date/time picker modal, built for the web. Works well with Materialize, or standalone.

[https://ripjar.github.io/material-datetime-picker/](https://ripjar.github.io/material-datetime-picker/)

[![Status][status]](https://travis-ci.org/ripjar/material-datetime-picker) 

[![Package][npm]](https://www.npmjs.com/package/material-datetime-picker)

![Time][date] ![Time][time]

## Installation

```

npm install material-datetime-picker

```

#### Dependencies

The picker depends on Google's Material Design icons (packaged with Materialize), or included in the `head` of the document;

```html

```

--- 

For best results also include Google's Material Font `Roboto`;

```html

```

---

If you want to use this project as a standalone ``, you can use  `dist/material-datetime-picker.js`. You'll need to include `moment.js` and `rome.js` as well:

```html

<script src="https://cdnjs.cloudflare.com/ajax/libs/rome/2.1.22/rome.js">

```

## Usage

### Manual (recommended)

The picker can be instantiated and interacted with manally;

    

```javascript

import MaterialDateTimePicker from 'material-datetime-picker';

const picker = new MaterialDateTimePicker()

    .on('submit', (val) => console.log(`data: ${val}`))

    .on('open', () => console.log('opened'))

    .on('close', () => console.log('closed'));

document.querySelector('.c-datepicker-btn')

    .on('click', () => picker.open());        

```

---

### As form input

The picker is decoupled from any single form element for simplicity. However, it should be simple to link the picker to a form input or button. For instance, given the input element ``, the following could be written;

    

```javascript

import MaterialDateTimePicker from 'material-datetime-picker';

const input = document.querySelector('.c-datepicker-input');

const picker = new MaterialDateTimePicker()

    .on('submit', (val) => {

      input.value = val.format("DD/MM/YYYY");

    });

input.addEventListener('focus', () => picker.open());      

```

## Options

    

All options are optional, including the `el`.

```javascript

{

    // DOM Element to attach the datepicker. This element will receive 

    // events when the data changes. If an input element, will be 

    // populated with formatted date and time chosen.

    // `el` must be a DOM Element object. Selectpr strings or wrappers

    // like a jQuery selection are not supported.

    el: document.querySelector('.c-datepicker-btn'),

    // if `el` is set, the format used to display the datetime in the input, 

    format: 'DD/MM/YY', 

    //  the default value of the picker

    default: moment(),

    // the container to append the picker. If you change this, you need to make

    // sure your element has a z-index > 0 so that it displays in front of the scrim.

    container: document.body,    

    // cosmetic classes that can be overriden

    // mostly used for styling the calendar

    styles: {

        scrim: 'c-scrim',

        back: 'c-datepicker__back',

        container: 'c-datepicker__calendar',

        date: 'c-datepicker__date',

        dayBody: 'c-datepicker__days-body',

        dayBodyElem: 'c-datepicker__day-body',

        dayConcealed: 'c-datepicker__day--concealed',

        dayDisabled: 'c-datepicker__day--disabled',

        dayHead: 'c-datepicker__days-head',

        dayHeadElem: 'c-datepicker__day-head',

        dayRow: 'c-datepicker__days-row',

        dayTable: 'c-datepicker__days',

        month: 'c-datepicker__month',

        next: 'c-datepicker__next',

        positioned: 'c-datepicker--fixed',

        selectedDay: 'c-datepicker__day--selected',

        selectedTime: 'c-datepicker__time--selected',

        time: 'c-datepicker__time',

        timeList: 'c-datepicker__time-list',

        timeOption: 'c-datepicker__time-option',

        clockNum: 'c-datepicker__clock__num'

    },

    // date range to allow (see rome validator factories)

    dateValidator: null       

}

```

## License

MIT

[date]: https://github.com/ripjar/material-datepicker/raw/master/demo/date.png "Date select image"

[time]: https://github.com/ripjar/material-datepicker/raw/master/demo/time.png "Time select image"

[status]: https://api.travis-ci.org/ripjar/material-datetime-picker.svg "Build Status"

[npm]: https://img.shields.io/npm/v/material-datetime-picker.svg "Package"