UNPKG

6.34 kBMarkdownView Raw
1English | [简体中文](./docs/zh-cn/README.zh-CN.md) | [日本語](./docs/ja/README-ja.md) | [Português Brasileiro](./docs/pt-br/README-pt-br.md) | [한국어](./docs/ko/README-ko.md) | [Español (España)](./docs/es-es/README-es-es.md) | [Русский](./docs/ru/README-ru.md) | [Türkçe](./docs/tr/README-tr.md)
2
3<p align="center"><a href="https://day.js.org/" target="_blank" rel="noopener noreferrer"><img width="550"
4 src="https://user-images.githubusercontent.com/17680888/39081119-3057bbe2-456e-11e8-862c-646133ad4b43.png"
5 alt="Day.js"></a></p>
6<p align="center">Fast <b>2kB</b> alternative to Moment.js with the same modern API</p>
7<p align="center">
8 <a href="https://unpkg.com/dayjs/dayjs.min.js"><img
9 src="https://img.badgesize.io/https://unpkg.com/dayjs/dayjs.min.js?compression=gzip&style=flat-square"
10 alt="Gzip Size"></a>
11 <a href="https://www.npmjs.com/package/dayjs"><img src="https://img.shields.io/npm/v/dayjs.svg?style=flat-square&colorB=51C838"
12 alt="NPM Version"></a>
13 <a href="https://travis-ci.com/iamkun/dayjs"><img
14 src="https://img.shields.io/travis/iamkun/dayjs/master.svg?style=flat-square" alt="Build Status"></a>
15 <a href="https://codecov.io/gh/iamkun/dayjs"><img
16 src="https://img.shields.io/codecov/c/github/iamkun/dayjs/master.svg?style=flat-square" alt="Codecov"></a>
17 <a href="https://github.com/iamkun/dayjs/blob/master/LICENSE"><img
18 src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="License"></a>
19 <br>
20 <a href="https://saucelabs.com/u/dayjs">
21 <img width="750" src="https://user-images.githubusercontent.com/17680888/40040137-8e3323a6-584b-11e8-9dba-bbe577ee8a7b.png" alt="Sauce Test Status">
22 </a>
23</p>
24
25> Day.js is a minimalist JavaScript library that parses, validates, manipulates, and displays dates and times for modern browsers with a largely Moment.js-compatible API. If you use Moment.js, you already know how to use Day.js.
26
27```js
28dayjs().startOf('month').add(1, 'day').set('year', 2018).format('YYYY-MM-DD HH:mm:ss');
29```
30
31* 🕒 Familiar Moment.js API & patterns
32* 💪 Immutable
33* 🔥 Chainable
34* 🌐 I18n support
35* 📦 2kb mini library
36* 👫 All browsers supported
37
38---
39
40## Getting Started
41
42### Documentation
43
44You can find for more details, API, and other docs on [day.js.org](https://day.js.org/) website.
45
46### Installation
47
48```console
49npm install dayjs --save
50```
51
52📚[Installation Guide](https://day.js.org/docs/en/installation/installation)
53
54### API
55
56It's easy to use Day.js APIs to parse, validate, manipulate, and display dates and times.
57
58```javascript
59dayjs('2018-08-08') // parse
60
61dayjs().format('{YYYY} MM-DDTHH:mm:ss SSS [Z] A') // display
62
63dayjs().set('month', 3).month() // get & set
64
65dayjs().add(1, 'year') // manipulate
66
67dayjs().isBefore(dayjs()) // query
68```
69
70📚[API Reference](https://day.js.org/docs/en/parse/parse)
71
72### I18n
73
74Day.js has great support for internationalization.
75
76But none of them will be included in your build unless you use it.
77
78```javascript
79import 'dayjs/locale/es' // load on demand
80
81dayjs.locale('es') // use Spanish locale globally
82
83dayjs('2018-05-05').locale('zh-cn').format() // use Chinese Simplified locale in a specific instance
84```
85📚[Internationalization](https://day.js.org/docs/en/i18n/i18n)
86
87### Plugin
88
89A plugin is an independent module that can be added to Day.js to extend functionality or add new features.
90
91```javascript
92import advancedFormat from 'dayjs/plugin/advancedFormat' // load on demand
93
94dayjs.extend(advancedFormat) // use plugin
95
96dayjs().format('Q Do k kk X x') // more available formats
97```
98
99📚[Plugin List](https://day.js.org/docs/en/plugin/plugin)
100
101## Sponsors
102
103Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
104
105[[Become a sponsor via Github](https://github.com/sponsors/iamkun/)] [[Become a sponsor via OpenCollective](https://opencollective.com/dayjs#sponsor)]
106
107<a href="https://www.exoflare.com/open-source/?utm_source=dayjs&utm_campaign=open_source" target="_blank">
108 <img width="70" src="https://user-images.githubusercontent.com/17680888/162761622-1407a849-0c41-4591-8aa9-f98114ec2092.png">
109</a>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111<a href="https://github.com/vendure-ecommerce" target="_blank"><img width="70" src="https://avatars.githubusercontent.com/u/39629390?s=52&v=4"></a>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113<a href="https://github.com/Velc" target="_blank"><img width="70" src="https://avatars.githubusercontent.com/u/1551649?s=52&v=4"></a>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115<a href="https://github.com/projectdiscovery" target="_blank"><img width="70" src="https://avatars.githubusercontent.com/u/50994705?s=52&v=4"></a>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
117<a href="https://opencollective.com/datawrapper" target="_blank"><img width="70" src="https://images.opencollective.com/datawrapper/c13e229/logo.png"></a>
118
119## Contributors
120
121This project exists thanks to all the people who contribute.
122
123Please give us a 💖 star 💖 to support us. Thank you.
124
125And thank you to all our backers! 🙏
126
127<a href="https://opencollective.com/dayjs/backer/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/dayjs/backer/0/avatar.svg?requireActive=false"></a>
128<a href="https://opencollective.com/dayjs/backer/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/dayjs/backer/1/avatar.svg?requireActive=false"></a>
129<a href="https://opencollective.com/dayjs/backer/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/dayjs/backer/2/avatar.svg?requireActive=false"></a>
130<a href="https://opencollective.com/dayjs/backer/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/dayjs/backer/3/avatar.svg?requireActive=false"></a>
131<a href="https://opencollective.com/dayjs#backers" target="_blank"><img src="https://opencollective.com/dayjs/contributors.svg?width=890" /></a>
132
133## License
134
135Day.js is licensed under a [MIT License](./LICENSE).