Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fooloomanzoo/datetime-picker

A minimal picker for date and time for Polymer, that can use the native input
https://github.com/fooloomanzoo/datetime-picker

calendar date datepicker datetimepicker overlay picker polyfill polymer time

Last synced: 4 days ago
JSON representation

A minimal picker for date and time for Polymer, that can use the native input

Host: GitHub
URL: https://github.com/fooloomanzoo/datetime-picker
Owner: fooloomanzoo
License: mit
Created: 2017-01-17T09:19:37.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2018-11-17T00:18:04.000Z (about 6 years ago)
Last Synced: 2024-05-27T22:10:35.374Z (7 months ago)
Topics: calendar, date, datepicker, datetimepicker, overlay, picker, polyfill, polymer, time
Language: JavaScript
Homepage:
Size: 2.68 MB
Stars: 78
Watchers: 8
Forks: 18
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

[![Published on NPM](https://img.shields.io/npm/v/@fooloomanzoo/datetime-picker.svg)](https://www.npmjs.com/package/@fooloomanzoo/datetime-picker)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@fooloomanzoo/datetime-picker)
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/fooloomanzoodatetime-picker)

_[API & Demo](https://fooloomanzoo.github.io/datetime-picker)_

## <datetime-picker>

### What is it for?

`datetime-picker` is a picker for date and time for **[Polymer](https://github.com/Polymer/polymer)** that can use the **native** input, too. If the **native** picker is choosen and is not supported, this element uses the **polyfill** date-picker. The `` and the `` will come in place if the native picker is not available or is not explicitly wanted. A range picker is provided by combining the `min`- and `max`-attributes. A codepen demo is available [here](https://codepen.io/fooloomanzoo/pen/RxqNOb).

```html

```

If you like an **overlay** then use ``, what creates the polyfill in an ``, that extends Polymer's IronOverlayBehavior and will create some of its attribute-bindings.

You can use other pickers and elements, too. In this collection are for:
* **datetime**
* ``
* ``
* **date**
* ``
* ``
* ``
* **time**
* ``
* ``
* ``

Every Element has the same API, so that it would use the given date-properties or for the pickers the native or the polyfill picker. Please see the [docs](https://fooloomanzoo.github.io/datetime-picker/components/datetime-picker/component-page.html#/mixins/DatetimeMixin) for the given attributes.

The **picker**-elements can use the **auto-confirm**-attribute, so that all values will be automatically confirmed when the polyfilled inputs are used. Else the attributes will update like the picker is used but will reset to the old attributes when being canceled and `confirmed-value`-attribute will be set if they are confirmed. `datetime`, `date` and `time` are the equivalent values of the native inputs. Be aware of **timezone**-attribute, when you sync datetime, because the Datetime-Object in the browser will use the local timezone.

If you are looking just for an input for date and/or time, please have a look at [datetime-input](https://github.com/fooloomanzoo/datetime-input).

### Motivation

Internally it tests the browser, if **native** input-types `datetime-local`, `date` or `time` are supported. If it is not, a `` or a `` will be displayed instead, according to the kind of picker you choose. You can decide to use the native or the replacements during runtime. calendar-element and time-element can also be used separately. **Internationalization** of the view in the pickers is inplemented and the attributes remain in **iso8061**-format. You can set the timezone of your datetime-values.

It might be useful for you to use, if you like to keep the native approach of Browsers like in Chrome for Desktop or Mobile, you like to have a different look or you would like to have a guaranteed working **datetime-picker**.

Another use case could be for example, if you want on _mobile devices_ use the native picker, when supported, and on _desktop devices_ this polyfill. For that purpose the attribute `native-on-mobile` is also provided.

```html

```

### How?

The **[component page](https://fooloomanzoo.github.io/datetime-picker/components/datetime-picker/)** explains, which of the attributes you can use and how. You can see there a **[demo](https://fooloomanzoo.github.io/datetime-picker/components/datetime-picker/#/elements/datetime-picker/demos/demo/datetime-elements.html)**, too.

You can use it stand-alone, with overlay or as a range of dates. Examples:

#### Stand-alone calendar and date-input (preset by using its attributes)

```html

date:

datetime:

```

Use `default` or another attribute to preset the date. If `step` is set on a picker, the attribute defines the step a date should be incremented (in seconds). The input for the most inferior standing, that would create an integer step, is used to increment the value.
For example, if the `step` is:
* `0.05`: the millisecond-input will increment the value by 50 (50 milliseconds), the other inputs behave as expected
* `1.05`: the millisecond-input will increment the value by 1050 (1 second and 50 millisecond), the other inputs behave as expected
* `2`: the millisecond-input will be disabled, the second-input will increment the value by 2000 (2 seconds), the other inputs behave as expected
* `180`: the millisecond-input and the second-input will be disabled, the minute-input will increment the value by 180000 (3 minutes), the other inputs behave as expected
If `step="0"` all inputs will be disabled, or when the step is below `0.001` the step will be set to `0.001`. The most superior input that will become the given step is the day-input.

#### Stand-alone time-picker and time-input (preset by using its attributes)

```html

time:

```

Note: If you preset the date by the `default`-attribute and it contains a timezone, This timezone will also used by default.

#### Use the polyfill or the native picker
By default it checks if `datetime-local`, `date` or `time` is supported as input. Set the ``auto-confirm`` attribute to automatically confirm the input. If `native` is set, the native picker will be used instead of the polyfill:

```html
Autoconfirming Polyfill Picker

Native Picker
```

#### Define date ranges
Set cross data bindings to limit the values of the inputs. Use the ``confirmed-value`` or the ``auto-confirm``-attribute to prevent resetting. Please also visit the [demos](https://fooloomanzoo.github.io/datetime-picker/components/datetime-picker/#/elements/datetime-picker/demos/demo/datetime-elements.html):

```html

start: [[min]]

end: [[max]]

```

#### Use it in an overlay
Choose the related elements:
* ``
* ``
* ``

```html

value: [[value]]

```

#### Use locale date formats
The properties `date`, `time`, `datetime` are always in **iso8061** but the visualization will be localized. By default your locale date format from `window.navigator.language` will be used, but you can select another *locale*:

```html

hour12-format:

locale:

english
français
deutsch
español
italiano
русский
Türkçe
العربية
עברית
日本語
中文

datetime: [[datetime]]

```

### Styling
Have a look at [input-picker-pattern#input-picker-shared-style](https://github.com/fooloomanzoo/input-picker-pattern#input-picker-shared-style) and [input-picker-pattern#input-shared-style](https://github.com/fooloomanzoo/input-picker-pattern#input-shared-style) to see how to style the picker and input-elements.

### Installation
```
npm i --save @fooloomanzoo/datetime-picker
```

### Notable Changes
* 2.0.0
- changed properties `dateString` and `timeString` to `date` and `time`
- polyfill is split up in two elements ('calendar-element' and 'time-element')
- minified version available ('build/..', ~18kB)

* 2.0.6 - 7
- `overlay`-element introduced
- shared custom-style-element introduced
- unifying some custom-style-properties
- renaming `position` to `verticalAlign` and `horizontalAlign`

* 2.1.7
- all elements are using `template-strings`
- using `` for all numeric inputs
- `` uses as native input now ``
- fix for `calendar-element` for daylight-saving time
- in `calendar-element` uses a numeric input for `year`-property and a select-box for `month`-property
- `clamp`-property allows to clamp the date-value to a lower limit, e.g. `clamp="day"` means that the month will be clamped to it's first day
- `clamp`-property for pickers enable to hide certain properties from being pickable, e.g. `clamp="day"` hides the day selector
- internationalization/localization for datetime-part-order and separation signs
- abstractions of each element leads to smaller file sizes

* 2.3.5
- `not-native` is deprecated, use `native` to get a native picker
- `dropdown-style.html` moved to `input-picker-pattern`

* 2.4.2
- new elements: `datetime-input`, `date-input` and `date-input`
- extended keyboard navigation support
- `auto-confirm`-attribute is for auto confirming the actual input
- new attributes `confirmed-datetime`, `confirmed-date` and `confirmed-time`

* 2.7.0
- `timezone` attribute
- using `` for the separate parts of the date
- every input and button is reachable by using the `tabulator`-key

* 2.8.0
- `step` attribute
- `parts-hidden` attribute
- style-values have been partially renamed and split up, because the style scoping is not working correctly for browsers other than Chromium-browsers. For example:
+ the picker uses now `--input-picker-color`, `--input-picker-background` instead of `--input-color`, `--input-background` (they stand exclusivly for the polyfill and the native element)
+ the picker-style-values are further split up to `--input-picker-border-radius`, `--input-picker-padding` etc.
+ simular for all mixins: by default are `--input-style`, `--input-focus`, `--input-placeholder`, `--input-invalid` etc. from now on empty and their most important values are separately split up in own values which are applied before the mixins. This might not be the final solution, while the behaviours of `shadycss` and `webcomponents` are still changing.
- changed internationalization implementation
- `default` can also be a `time`-value

* 2.9.2
- the only confirmed-property is `confirmed-value` (but it is possible by changing `propertyForValue` to define the kind of property that is used for `value` and `confirmedValue`)
- new buildup for the calendar, new property `currentActiveDayNode`, using dataset-attributes for the calendar-cells
- performance improvements and test-suites for every element and their dependencies

* 3.0.0
- update to polymer 3.0

### Contribute?
Feel free to send a new issue, a commit, a pull request or just fork it!