@vanillawc/wc-datepicker
Version:
A web component that wraps a text input element and adds date-picker functionality to it.
284 lines (211 loc) • 11.9 kB
Markdown
<div align="center">
<a href="https://github.com/vanillawc/wc-datepicker/releases"><img src="https://badgen.net/github/tag/vanillawc/wc-datepicker" alt="GitHub Releases"></a>
<a href="https://www.npmjs.com/package/@vanillawc/wc-datepicker"><img src="https://badgen.net/npm/v/@vanillawc/wc-datepicker" alt="NPM Releases"></a>
<a href="https://bundlephobia.com/result?p=@vanillawc/wc-datepicker"><img src="https://badgen.net/bundlephobia/minzip/@vanillawc/wc-datepicker" alt="Bundlephobia"></a>
<a href="https://github.com/vanillawc/wc-datepicker/actions"><img src="https://github.com/vanillawc/wc-datepicker/workflows/Latest/badge.svg" alt="Latest Status"></a>
<a href="https://github.com/vanillawc/wc-datepicker/actions"><img src="https://github.com/vanillawc/wc-datepicker/workflows/Release/badge.svg" alt="Release Status"></a>
<a href="https://discord.gg/aSWYgtybzV"><img alt="Discord" src="https://img.shields.io/discord/723296249121603604?color=%23738ADB"></a>
</div>
# wc-datepicker
A web component that wraps a text input element and adds date-picker functionality to it.
Live demo available [here.](http://135.181.40.67/wc-datepicker/)
## Features
Wc-datepicker is a stand-alone vanilla JS web component that does not use shadow DOM. The component wraps a text input element and adds date-picker functionality to it. The calendar will appear when the input element gets focus.
Component features include:
- highly customizable calendar layout
- configurable names of months and week days
- first day of week selection: sunday or monday
- date format customization
- initial date setting
- written date input & validation
- keyboard accessible calendar (tabindex)
- rapid month/year switching with long press
- Angular compatibility (see below)
## Including the component to an HTML file
1. Import polyfill, this is not needed for modern browsers:
```html
<script src="https://cdnjs.cloudflare.com/ajax/libs/custom-elements/1.4.1/custom-elements.min.js"></script>
```
2. Import custom element:
```html
<script defer src='wc-datepicker.min.js'></script>
```
3. Start using it!
```html
<wc-datepicker>
<input type='text'>
</wc-datepicker>
```
## Including the component from NPM
1. Install and import polyfill, this is not needed for modern browsers:
See https://www.npmjs.com/package/@webcomponents/custom-elements
2. Install wc-datepicker NPM package:
```console
npm i @vanillawc/wc-datepicker
```
3. Import custom element:
```javascript
import '@vanillawc/wc-datepicker'
```
4. Start using it:
```javascript
var picker = document.createElement('wc-datepicker')
var input = document.createElement('input')
input.setAttribute('type', 'text')
picker.appendChild(input)
document.body.appendChild(picker)
```
## Attributes
Currently component has only one custom attribute that can be assigned a value in the HTML tag:
Name | Type | Description | Unit / Values | Default value
-------------- | --------- | ------------------------| -------------------| --------------
init-date | String | Initial date in the input field | Date in "dd.mm.yyyy" format or<br>"current" to select current date | None
Following component attributes are boolean attributes, also known as valueless attributes. The presence of a boolean attribute in the HTML tag represents the true value, and the absence of the attribute represents the false value:
Name | Description | if attribute is defined | If attribute is not defined
-------|-------------|-------------------------|----------------------------
ignore-on-focus | Calendar appearance after the input element gets focus| Calendar won't appear| Calendar appears
sunday-first | First day of the calendar week | Sunday is first | Monday is first
persist-on-select | Calendar visibility after the date has been selected | Calendar won't disappear | Calendar disappears
show-close-icon | Calendar close icon visibility | Icon is visible | Icon is hidden
Usage examples:
```html
<wc-datepicker init-date='28.12.2005' sunday-first>
<input type='text'>
</wc-datepicker>
```
```html
<wc-datepicker init-date='current' persist-on-select>
<input type='text'>
</wc-datepicker>
```
Following custom attributes can be specified at build time or dynamically at runtime:
Name | Type | Description | Unit / Values | Default value
--- | --- | --- | --- | ---
dayNames | Array of strings | Week day names |Week day names from Monday to Sunday | Mon, Tue, Wed, Thu, Fri, Sat, Sun
monthNames | Array of strings | Month names |Month names from January to December | Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
ignoreOnFocus | Boolean | Calendar appearance after the input element gets focus |true for not appearing<br>false for appearing | false
sundayFirst | Boolean | Starting day of the week |true for Sunday<br>false for Monday | false
persistOnSelect | Boolean | Calendar visibility after the date has been selected |true for visible<br>false for hidden | false
showCloseIcon | Boolean | Calendar close icon visibility |true for visible<br>false for hidden | false
initDate | String | Initial date in the input field |Date in "dd.mm.yyyy" format or "current" to select current date | None
longPressThreshold | Number | Month/year switch long press threshold |Milliseconds | 500
longPressInterval | Number | Long press month/year switch interval |Milliseconds | 150
Usage example:
```javascript
var picker = document.createElement('wc-datepicker')
picker.dayNames = ['Mo','Tu','We','Th','Fr','Sa','Su']
picker.initDate = 'current'
var input = document.createElement("input")
input.setAttribute('type', 'text')
picker.appendChild(input)
document.body.appendChild(picker)
```
**Regarding dynamic and runtime usage of the component, custom attributes should always be set before the datepicker element is appended to DOM or initialized.**
Although *init()* method can be called multiple times, not all attributes can be changed after the initial init.
Regarding *init-date* (*initDate*) attribute, notice that the initial date format is determined by *_returnDateString()* and *_parseAndValidateInputStr()* methods, see chapter **Date format and validation** below.
## Methods
### init()
Initializes date-picker functionality. This method is called automatically when the datepicker element is appended to DOM.
This method has no effect, if the element does not have an input element as a child.
If the datepicker is appended to DOM before the input element is appended to datepicker, *init()* must be called to make datepicker work.
### setFocusOnCal()
The calendar will appear and get the focus when this method is called.
On touch UIs this method can be used to prevent the keyboard from appearing, as the text input field won't get the focus.
This method has no effect, if *init()* has not been called. If *ignoreOnFocus* has been set to true, this method is the only way to make the calendar appear.
### getDateString()
Returns the date as string. Default format is "mm.dd.yyyy".
Returns null if the input field does not contain a valid date.
Date format and validity is determined by *_returnDateString()* and *_parseAndValidateInputStr()* methods.
### getDateObject()
Returns the date as standard JS date object.
Returns null if the input field does not contain a valid date.
**Notice:**
Since datepicker returns the object date in local time, UTC getter methods should not be used when processing the returned date further. Neither *Date.toJSON()* nor *Date.toISOString()* methods should be used, as they return the date in UTC format too.
## Date format and validation
Default format is "mm.dd.yyyy".
Date format can be changed by modifying *_returnDateString()* method.
When date is written to input field, it is validated automatically if datepicker is initialized.
If the date format to be used is changed, then the validating method must be modified also.
The validating method to be modified is *_parseAndValidateInputStr()*
It must return an object with either 1 or 4 properties:
* valid - a boolean value indicating whether the date string is valid or not
* day - a number value indicating the day of month (1 - 31) of the valid date string
* month - a number value indicating the month (0-11) of the valid date string
* year - a number value indicating the year of the valid date string
Methods *getDateString()* and *getDateObject()* can also be used for validating the date, see above.
## Events
If the input element loses focus and the date string is not valid, text input element shall dispatch [invalid](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event) event.
When the date string is edited to be a valid date or a new date is selected from the calendar, text input element shall dispatch *dateselect* event, which is a non-standard custom event.
*Notice that event dispatching has changed since version 0.0.3. Starting from version 0.0.4, it is the wrapped input element instead of the custom element that shall dispatch events. Custom event name has been changed from datechange to dateselect.*
## Style and layout
The style is defined in the HTML template string inside the component's contructor.
Styling can be moved to an external CSS file by cutting and pasting everything that's inside style tags and then removing the void tags.
Calendar width and height can be adjusted by modifying font-sizes and paddings:
```css
.calDayName, .calDayStyle, .calAdjacentMonthDay, #calTitle {
padding:5px;
font-size:20px;
text-align:center;
}
.calCtrl {
font-size:20px;
padding:0px 8px;
user-select:none;
}
```
Calendar's adjacent month day numbers can be changed to invisible by replacing the color definition in *.calAdjacentMonthDay* with
```css
visibility:hidden;
```
## Angular usage
Using FLUX dataflow and one-way binding:
```html
<wc-datepicker>
<input
[ngModel]="whatever.date"
(dateselect)="getDate($event)"
(invalid)="notifyError()"
type="text"
/>
</wc-datepicker>
```
Ignoring component's invalid event and validating date externally:
```html
<wc-datepicker>
<input
[ngModel]="whatever.date"
(dateselect)="getDate($event)"
(change)="validateDate($event)"
type="text"
/>
</wc-datepicker>
```
Using distinct icon/button to activate the calendar:
```html
<wc-datepicker #mypicker ignore-on-focus>
<input
[ngModel]="whatever.date"
(dateselect)="getDate($event)"
type="text"
/>
</wc-datepicker>
<div>
<img
src="calendar.jpg"
(click)="mypicker.setFocusOnCal()"
>
</div>
```
## Building
Unminified scripts in the dist folder can be used and modified as such, there are no build scripts available for them.
Building is done by executing the minifier script minify.cmd, which is a Linux bash shell script.
Minify.cmd can be found from dist folder.
Building (minifying) requires [terser](https://github.com/terser/terser) command line tool to be installed. It can be installed with following command:
```console
npm install terser -g
```
## Contributing
Questions, suggestions and bug reports are welcome. Safari testing would be nice.
## License
Copyright (c) 2019-2020 Jussi Utunen
Licensed under the MIT License