TOAST UI Component : Date Picker
Component that selects specific date.
🚩 Table of Contents
- Browser Support
- Features
- Examples
- Install
- Usage
- Pull Request Steps
- Documents
- Contributing
- Dependency
- License
🌏 Browser Support
Chrome | Internet Explorer | Edge | Safari | Firefox |
---|---|---|---|---|
Yes | 8+ | Yes | Yes | Yes |
🎨 Features
- Selects specific year, month, date, and time.
- Creates the calendar that only show date-layer using
createCalendar
API. - Creates the range picker that selects a date period using
createRangePicker
API. - Supports internationalization(i18n).
- Supports custom events.
- Provides the file of default css style.
🐾 Examples
- Basic : Example of using default options.
- Having Timepicker : Example of using a time picker to select a time.
- Calendar : Examples of creating and using calendars.
- RangePicker : Example of creating and using a range picker.
More examples can be found on the left sidebar of each example page, and have fun with it.
💾 Install
TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.
Via Package Manager
TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.
npm
$ npm install --save tui-date-picker # Latest version $ npm install --save tui-date-picker@<version> # Specific version
bower
$ bower install tui-date-picker # Latest version $ bower install tui-date-picker#<tag> # Specific version
Via Contents Delivery Network (CDN)
TOAST UI products are available over a CDN powered by TOAST Cloud.
You can use CDN as below.
<link rel="stylesheet" href="https://uicdn.toast.com/tui.date-picker/latest/tui-date-picker.css"> <script src="https://uicdn.toast.com/tui.date-picker/latest/tui-date-picker.js"></script>
If you want to use a specific version, use the tag name instead of latest
in the url's path.
The CDN directory has the following structure.
tui.date-picker/ ├─ latest │ ├─ tui-date-picker.css │ ├─ tui-date-picker.js │ ├─ tui-date-picker.min.js ├─ v3.0.0/ │ ├─ ...
Download Source Files
🔨 Usage
HTML
You need to add two elements. One is the container element to display a date picker, and the other is a target element in which a date picker is attached. Also add some elements for applying the css style.
<div class="tui-datepicker-input tui-datetime-input tui-has-focus"> <input type="text" id="tui-date-picker-target" aria-label="Date-Time"> <span class="tui-ico-date"></span> </div> <div id="tui-date-picker-container" style="margin-top: -1px;"></div>
JavaScript
This can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.
Using namespace in browser environment
var DatePicker = tui.DatePicker;
Using module format in node environment
var DatePicker = require('tui-date-picker'); /* CommonJS */
import DatePicker from 'tui-date-picker'; /* ES6 */
You can create an instance with options and call various APIs after creating an instance.
var container = document.getElementById('tui-date-picker-container'); var target = document.getElementById('tui-date-picker-target'); var instance = new DatePicker(container, { input: { element: target }, ... }); instance.getDate();
For more information about the API, please see here.
🔧 Pull Request Steps
TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.
Setup
Fork develop
branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.
$ git clone https://github.com/{your-personal-repo}/tui.date-picker.git $ cd tui.date-picker $ npm install $ npm run test
Develop
Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.
Run webpack-dev-server
$ npm run serve $ npm run serve:ie8 # Run on Internet Explorer 8
Run karma test
$ npm run test
Pull Request
Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!
For more information on PR's step, please see links of Contributing section.
📙 Documents
You can also see the older versions of API page on the releases page.
💬 Contributing
🔩 Dependency
- tui-code-snippet >=1.5.0
- tui-time-picker >=1.3.0
- jquery >=1.11.0