Repository files navigation

Duet Date Picker is an open source version of Duet Design System’saccessible date picker. Duet Date Picker can be implemented and used across any JavaScript framework or no framework at all. We accomplish this by using standardized web platform APIs and Web Components.

Why yet another date picker? Our team working onDuet Design System couldn’t find an existing date picker that would’ve ticked all the requirements we had for accessibility(supporting WCAG 2.1 as well as we can), so we decided to build one and open source it so that others could benefit from this work as well.

Duet Date Picker comes with built-in functionality that allows you to set a minimum and a maximum allowed date. These settings can be combined or used alone, depending on the need. Please note that the date values must be passed in IS0-8601 format:YYYY-MM-DD.

Read getting started instructions ›
Learn more about Duet ›

• https://duetds.github.io/date-picker/

• Can be used with any JavaScript framework.
• No external dependencies.
• Weighs only ~10kb minified and Gzip’ed (this includes all styles and icons).
• Built with accessibility in mind.
• Supports all modern browsers and screen readers.
• Additionally, limited support offered for IE11 and Edge 17+.
• Allows theming using CSS Custom Properties.
• Support for localization.
• Customizable date parsing and formatting.
• Support for changing the first day of the week.
• Comes with modified interface for mobile devices to provide better user experience.
• Supports touch gestures for changing months and closing the picker.
• Built usingStencil.js and Web Components.
• Free to use under the MIT license.

• Google Chrome 61+
• Apple Safari 10+
• Firefox 63+
• Microsoft Edge 17+
• Opera 63+
• Samsung Browser 8.2+
• Internet Explorer 11

We offer support for the following screen readers. For more information about the level of support and possible issues with the implementation, please refer to the includedaccessibility audit.

• VoiceOver on macOS and iOS
• TalkBack on Android
• NVDA on Windows
• Jaws on Windows

Duet Date Picker’s keyboard support is built to closely followW3C Date Picker Dialog example with some small exceptions to e.g. better support iOS VoiceOver and Android TalkBack.

• Space, Enter: Opens the date picker dialog and moves focus to the first select menu in the dialog.

• Esc: Closes the date picker dialog and moves focus back to the “choose date” button.
• Tab: Moves focus to the next element in the dialog. Please note since the calendar usesrole="grid", only one button in the calendar grid is in the tab sequence. Additionally, if focus is on the last focusable element, focus is next moved back to the first focusable element inside the date picker dialog.
• Shift + Tab: Same as above, but in reverse order.

• Space, Enter: Changes the month and/or year displayed.

• Space, Enter: Selects a date, closes the dialog, and moves focus back to the “Choose Date” button. Additionally updates the value of the Duet Date Picker input with the selected date, and adds selected date to “Choose Date” button label.
• Arrow up: Moves focus to the same day of the previous week.
• Arrow down: Moves focus to the same day of the next week.
• Arrow right: Moves focus to the next day.
• Arrow left: Moves focus to the previous day.
• Home: Moves focus to the first day (e.g Monday) of the current week.
• End: Moves focus to the last day (e.g. Sunday) of the current week.
• Page Up: Changes the grid of dates to the previous month and sets focus on the same day of the same week.
• Shift + Page Up: Changes the grid of dates to the previous year and sets focus on the same day of the same week.
• Page Down: Changes the grid of dates to the next month and sets focus on the same day of the same week.
• Shift + Page Down: Changes the grid of dates to the next year and sets focus on the same day of the same week.

• Space, Enter: Closes the dialog, moves focus to “choose date” button, but does not update the date in input.

Integrating Duet Date Picker to a project without a JavaScript framework is very straight forward. If you’re working on a simple HTML page, you can start using Duet Date Picker immediately by adding these tags to the<head>:

<scripttype="module"src="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/duet.esm.js"></script><scriptnomodulesrc="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/duet.js"></script><linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/themes/default.css"/>

Once included, Duet Date Picker can be used in your markup like any other regular HTML element:

<labelfor="date">Choose a date</label><duet-date-pickeridentifier="date"></duet-date-picker>

Please note: Importing the CSS file is optional and only needed if you’re planning on using the default theme. Seetheming section for more information. Additionally, while the above method is the easiest and fastest way to get started, you can also install Duet Date Picker via NPM. Scroll down for theinstallation instructions.

Hide the calendar modal. SetmoveFocusToButton to false to prevent focusreturning to the date picker's button. Default is true.

Type:Promise<void>

Sets focus on the date picker's input. Use this method instead of the globalfocus().

Type:Promise<void>

Show the calendar modal, moving focus to the calendar inside.

Type:Promise<void>

Before moving further, please make sure you haveNode.js installed on your machine. You can install the latest version throughtheir website. If you’re planning on using Duet Date Picker in a project that doesn’t yet useNode Package Manager, you’ll have to first create apackage.json file. To do so, runnpm init and follow the steps provided.

Once finished, you can install Duet Date Picker by running:

# WEB COMPONENT for HTML, Ember, Vue.js, React, Angular and Vanilla JS:npm install @duetds/date-picker

Please note: We recommend the usage of CDN like JSDelivr over the below approach if you’re notserver side rendering Duet Date Picker. Seegetting started section to find the correct script tags.

Once you’ve installed@duetds/date-picker package into your project, it’s recommended to create a copy task that copies Duet Date Picker component fromnode_modules to a location you’ve specified. One such tool that can do this isNCP. You can installncp by running:

npm install ncp --save-dev

Once installed, add a script to your package.json that copies the component library from Duet’s package into a location you’ve specified:

"scripts": {"copy:duet-date-picker":"ncp node_modules/@duetds/date-picker/dist src/SPECIFY_PATH"}

You can call this script while starting up your app to make sure you’ve always got the latest code copied over. If you’re using an UNIX-like environment, you can use& as the separator:

"start":"copy:duet-date-picker & dev"

Otherwise, if you need a cross-platform solution, usenpm-run-all module:

"start":"npm-run-all copy:duet-date-picker dev"

Once you have a copy task in place and have copied Duet Date Picker over, you can put tags similar to these in the<head> of yourindex.html (importing the CSS file is optional and only needed if you’re planning on using the default theme. Seetheming section for more information):

<scripttype="module"src="SPECIFY_YOUR_PATH/duet.esm.js"></script><scriptnomodulesrc="SPECIFY_YOUR_PATH/duet.js"></script><linkrel="stylesheet"href="SPECIFY_YOUR_PATH/duet.css"/>

Once included, Duet Date Picker can be used in your basic HTML markup as in the following example:

<labelfor="date">Choose a date</label><duet-date-pickeridentifier="date"></duet-date-picker>

To know when this tag name becomes defined, you can usewindow.customElements.whenDefined(). It returns a Promise that resolves when the element becomes defined:

customElements.whenDefined("duet-date-picker").then(()=>{document.querySelector("duet-date-picker").show()});

Before you can use Duet Date Picker in Angular, you must import and add Angular’sCUSTOM_ELEMENTS_SCHEMA. This allows the use of Web Components in HTML markup, without the compiler producing errors. TheCUSTOM_ELEMENTS_SCHEMA needs to be included in any module that uses custom elements. Typically, this can be added toAppModule:

// ...// Import custom elements schemaimport{CUSTOM_ELEMENTS_SCHEMA}from"@angular/core";@NgModule({// ...// Add custom elements schema to NgModuleschemas:[CUSTOM_ELEMENTS_SCHEMA]})exportclassAppModule{}

The final step is to load and register Duet Date Picker in the browser.@duetds/date-picker includes a main function that handles this. That function is calleddefineCustomElements() and it needs to be called once during the bootstrapping of your application. One convenient place to do this is inmain.ts as such:

// Import Duet Date Pickerimport{defineCustomElements}from"@duetds/date-picker/dist/loader";// ...// Register Duet Date PickerdefineCustomElements(window);

Once included, Duet Date Picker can be used in your HTML markup as in the following example:

<labelfor="date">Choose a date</label><duet-date-pickeridentifier="date"></duet-date-picker>

Please note that you need to also importduet.css separately if you want to use the default theme. Seetheming section for more information.

Once included, components could also be referenced in your code usingViewChild andViewChildren as shown in theStencil.js documentation.

To integrate@duetds/date-picker into aVue.js application, editsrc/main.js to include:

// Import Duet Date Pickerimport{defineCustomElements}from"@duetds/date-picker/dist/loader";// ...// configure Vue.js to ignore Duet Date PickerVue.config.ignoredElements=[/duet-\w*/];// Register Duet Date PickerdefineCustomElements(window);newVue({render:h=>h(App)}).$mount("#app");

Once included, Duet Date Picker can be used in your HTML markup as in the following example:

<template><labelfor="date">Choose a date</label><duet-date-pickeridentifier="date":localization.prop="localisation_uk"></duet-date-picker></template><script>constlocalisation_uk={buttonLabel:'Choose date',placeholder:'DD/MM/YYYY',selectedDateMessage:'Selected date is',prevMonthLabel:'Previous month',nextMonthLabel:'Next month',monthSelectLabel:'Month',yearSelectLabel:'Year',closeLabel:'Close window',calendarHeading:'Choose a date',dayNames:['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday'],monthNames:['January','February','March','April','May','June','July','August','September','October','November','December'],monthNamesShort:['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],}</script>

Please note that you need to also importduet.css separately if you want to use the default theme. Seetheming section for more information.

Please also note that in order to use duet-date-picker's own custom properties (as seen on the properties section), vue must recognise that such options are being passed down as properties rather than attributes, hence the.prop at the end.

With an application built using thecreate-react-app script the easiest way to include Duet Date Picker is to calldefineCustomElements(window) from theindex.js file:

// Import Duet Date Pickerimport{defineCustomElements}from"@duetds/date-picker/dist/loader";// ...// Register Duet Date PickerdefineCustomElements(window);

Then you can create a thin React wrapper component to handle listening for events, cleanup, passing properties etc:

importReact,{useEffect,useRef}from"react";functionuseListener(ref,eventName,handler){useEffect(()=>{if(ref.current){constelement=ref.current;element.addEventListener(eventName,handler)return()=>element.removeEventListener(eventName,handler)}},[eventName,handler,ref])}exportfunctionDatePicker({  onChange,  onFocus,  onBlur,  onOpen,  onClose,  dateAdapter,  localization,  ...props}){constref=useRef(null)useListener(ref,"duetChange",onChange)useListener(ref,"duetFocus",onFocus)useListener(ref,"duetBlur",onBlur)useListener(ref,"duetOpen",onOpen)useListener(ref,"duetClose",onClose)useEffect(()=>{ref.current.localization=localizationref.current.dateAdapter=dateAdapter},[localization,dateAdapter])return<duet-date-pickerref={ref}{...props}></duet-date-picker>}

Then the wrapper can be used like any other React component:

<DatePickervalue="2020-08-24"onChange={e=>console.log(e.detail)}/>

Please note that you need to also importduet.css separately if you want to use the default theme. Seetheming section for more information.

Duet Date Picker can be easily integrated into Ember thanks to theember-cli-stencil addon that handles:

• Importing the required files into yourvendor.js
• Copying the component definitions into yourassets directory
• Optionally generating a wrapper component for improved compatibility with older Ember versions

Start by installing the Ember addon:

ember install ember-cli-stencil ember-auto-import

When you build your application, Stencil collections in your dependencies will be automatically discovered and pulled into your application. You might get aCan't resolve error when building. The easiest way to resolve that issue is by adding an alias to yourember-cli-build.js file.

autoImport:{alias:{'@duetds/date-picker/loader':'@duetds/date-picker/dist/loader/index.cjs',},},

For more information, seeember-cli-stencil documentation.

Ember octane example:

<labelfor="date">Choose a date.</label><duet-date-pickeridentifier="date"{{proplocalization=this.localization}}></duet-date-picker>

importControllerfrom"@ember/controller";import{action}from"@ember/object";import{tracked}from"@glimmer/tracking";exportdefaultclassExampleControllerextendsController{  @trackedlocalization={buttonLabel:"Choose date",placeholder:"mm/dd/yyyy",selectedDateMessage:"Selected date is",prevMonthLabel:"Previous month",nextMonthLabel:"Next month",monthSelectLabel:"Month",yearSelectLabel:"Year",closeLabel:"Close window",calendarHeading:"Choose a date",dayNames:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],monthNames:["January","February","March","April","May","June","July","August","September","October","November","December"],monthNamesShort:["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],};}

If you want the Duet Date Picker custom element to work on older browser, you need to add theapplyPolyfills() that surround thedefineCustomElements() function:

import{applyPolyfills,defineCustomElements}from"@duetds/date-picker/lib/loader";// ...applyPolyfills().then(()=>{defineCustomElements(window)})

We encourage the use of DOM events, but additionally provide custom events to make handling of certain event types easier. All custom events are documented in this same readmeunder the “Events” heading.

Duet Date Picker provides e.g. a custom event calledduetChange. This custom event includes an object calleddetail which includes for example the selected date:

// Select the date picker componentconstdate=document.querySelector("duet-date-picker")// Listen for when date is selecteddate.addEventListener("duetChange",function(e){console.log("selected date",e.detail.valueAsDate)})

The console output for the above code looks like this:

selected date Sat Aug 15 2020 00:00:00 GMT+0300 (Eastern European Summer Time)

Duet Date Picker uses CSS Custom Properties to make it easy to theme the picker. The component ships with a default theme that you can import either from the NPM package or directly from a CDN like JSDelivr:

<linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/themes/default.css"/>

The above CSS file provides the following Custom Properties that you can override with your own properties:

:root {--duet-color-primary:#005fcc;--duet-color-text:#333;--duet-color-text-active:#fff;--duet-color-placeholder:#666;--duet-color-button:#f5f5f5;--duet-color-surface:#fff;--duet-color-overlay:rgba(0,0,0,0.8);--duet-color-border:#333;--duet-font: -apple-system, BlinkMacSystemFont,"Segoe UI", Roboto, Helvetica, Arial, sans-serif;--duet-font-normal:400;--duet-font-bold:600;--duet-radius:4px;--duet-z-index:600;}

If you wish to customize any of the default properties shown above,we recommend to NOT import or link to the provided CSS, but instead copying the above code into your own stylesheet and replacing the values used there.

Additionally, you’re able to override Duet Date Picker’s default styles by using e.g..duet-date__input selector in your own stylesheet. This allows you to give the form input and e.g. date picker toggle button a visual look that matches the rest of your website.

Duet Date Picker offers full support for localization. This includes the text labels and date formats used. Below is an example of a date picker that is using Finnish date format and localization.

<labelfor="date">Valitse päivämäärä</label><duet-date-pickeridentifier="date"></duet-date-picker><script>constpicker=document.querySelector("duet-date-picker")constDATE_FORMAT=/^(\d{1,2})\.(\d{1,2})\.(\d{4})$/picker.dateAdapter={parse(value="",createDate){constmatches=value.match(DATE_FORMAT)if(matches){returncreateDate(matches[3],matches[2],matches[1])}},format(date){return`${date.getDate()}.${date.getMonth()+1}.${date.getFullYear()}`},}picker.localization={buttonLabel:"Valitse päivämäärä",placeholder:"pp.kk.vvvv",selectedDateMessage:"Valittu päivämäärä on",prevMonthLabel:"Edellinen kuukausi",nextMonthLabel:"Seuraava kuukausi",monthSelectLabel:"Kuukausi",yearSelectLabel:"Vuosi",closeLabel:"Sulje ikkuna",calendarHeading:"Valitse päivämäärä",dayNames:["Sunnuntai","Maanantai","Tiistai","Keskiviikko","Torstai","Perjantai","Lauantai"],monthNames:["Tammikuu","Helmikuu","Maaliskuu","Huhtikuu","Toukokuu","Kesäkuu","Heinäkuu","Elokuu","Syyskuu","Lokakuu","Marraskuu","Joulukuu"],monthNamesShort:["Tammi","Helmi","Maalis","Huhti","Touko","Kesä","Heinä","Elo","Syys","Loka","Marras","Joulu"],locale:"fi-FI",}</script>

Please note that you must provide the entirety of the localization properties in the object when overriding with your custom localization.

Duet Date Picker allows you to disable the selection of specific days. Below is an example of a date picker that is disabling weekends.

Be aware, this only disables selection of dates in the popup calendar. You must still handle the case where a user manually enters a disallowed date into the input.

<labelfor="date">Choose a date</label><duet-date-pickeridentifier="date"></duet-date-picker><script>functionisWeekend(date){returndate.getDay()===0||date.getDay()===6}constpickerDisableWeekend=document.querySelector("duet-date-picker")pickerDisableWeekend.isDateDisabled=isWeekendpickerDisableWeekend.addEventListener("duetChange",function(e){if(isWeekend(e.detail.valueAsDate)){alert("Please select a weekday")}})</script>

Duet Date Picker package includes a hydrate app that is a bundle of the same components, but compiled so that they can be hydrated on a NodeJS server and generate static HTML and CSS. To get started, import the hydrate app into your server’s code like so:

importhydratefrom"@duetds/date-picker/hydrate"

If you are using for exampleEleventy, you could now add a transform into.eleventy.js configuration file that takes content as an input and processes it using Duet’s hydrate app:

eleventyConfig.addTransform("hydrate",async(content,outputPath)=>{if(process.env.ELEVENTY_ENV=="production"){if(outputPath.endsWith(".html")){try{constresults=awaithydrate.renderToString(content,{clientHydrateAnnotations:true,removeScripts:false,removeUnusedStyles:false})returnresults.html}catch(error){returnerror}}}returncontent})

The above transform gives you server side rendered components that function without JavaScript. Please note that you need to separately pre-render the content for each theme you want to support.

Duet Date Picker also offers a single file bundle without the polyfills and other additional functionality included in the default output. To import that instead of the default output, use:

import{DuetDatePicker}from"@duetds/date-picker/custom-element";customElements.define("duet-date-picker",DuetDatePicker);

Please note that this custom-element output does not automatically define the custom elements or apply any polyfills which is why we’re defining the custom element above ourselves.

For more details, please seeStencil.js documentation.

If you wish to make sure Duet Date Picker shows up as quickly as possible when loading the scripts from JSDelivr CDN, you can preload the key parts using linkrel="preload". To do this, add these tags in the<head> of your webpage before any other<script> or<link> tags:

<linkrel="preload"href="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/duet.esm.js"as="script"crossorigin="anonymous"/><linkrel="preload"href="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/duet-date-picker.entry.js"as="script"crossorigin="anonymous"/>

In case you’re also using one of the included themes, you can preload them the same way using the below tag:

<linkrel="preload"href="https://cdn.jsdelivr.net/npm/@duetds/date-picker@1.4.0/dist/duet/themes/default.css"as="style"/>

• Clone the repository by runninggit clone git@github.com:duetds/duet-date-picker.git.
• Once cloned, open the directory and runnpm install.
• Runnpm start to get the development server and watch tasks up and running. This will also automatically open a new browser window with an example page.
• To edit the example page’s source, see./src/index.html.

• To run the unit, end-to-end and visual diff tests usenpm run test.
• To build the project usenpm run build.

NOTE: this section is for maintainers and can be ignored by contributors.

The process for publishing a stable or a beta release differs.

To publish a newstable release, use thenpm version command. The npm docs for theversion command explains in detail how this command works.

E.g. to publish a new minor version:

npm version minor

This will run tests, build the project, bump the minor version in package.json, commit and tag the changes, publish to npm, and finally push any commits to github.

To publish a newbeta release, do the following:

1. Bump version inpackage.json and elsewhere.
2. Commit your changes.
3. Tag new release by runninggit tag -a 1.2.0-beta.0 -m "1.2.0-beta.0".
4. Push your changes to Git and then runnpm publish --tag beta.
5. Push to git:git push --tags --no-verify.

• 1.4.0:
  • Add support for disabling arbitrary dates in the calendar viaisDateDisabled prop (#52 and#80).
  • Disable month options in dropdown that would fall outside of min/max (#82).
  • DropkeyboardInstruction text - it is redundant since we now use a standard<table> element. (#87).
• 1.3.0:
  • Add new theme variable--duet-border-color for customising the input's border color. Falls back to previous value--duet-color-text if not set (#70).
  • Improve handling of disallowed characters so that cursor position is maintained.
  • Add newduetOpen andduetClose events to correspond with opening and closing the calendar (#73).
  • Fix click outside logic so that it works when nested in a shadow DOM (#65).
• 1.2.0:
  • Improvements to screen reader accessibility.
    • Ensure table can be navigated with table navigation commands.
    • Ensure column headers are announced out when navigating table columns.
    • Ensure month/year is announced whenever it changes.
    • Improve how dates are presented to screen readers. Use formats like "17 November 2020" instead of "2020-11-17".
  • Year dropdown now shows every year that satisfies min/max range.
• 1.1.0: Adds support forrequired attribute. Ensures date is always submitted in ISO format. Updates @stencil/core to 2.3.0.
• 1.0.4: Improves stability for NVDA + Chrome on Windows. Also fixes an issue which caused build attempts to fail due to snapshot mismatch.
• 1.0.2: Documentation improvements.
• 1.0.1: Hitting arrow keys on year select on Windows without first opening the dropdown previously causes odd results. This is now fixed.
• 1.0.0: Initial release.

• Better examples on how to do date ranges, handle validation and so on.
• Better theming and basic code examples.
• Making it possible to pass in your own input component.

Copyright © 2020 LocalTapiola Services Ltd /Duet Design System.

Licensed under theMIT license.