UNPKG

7.88 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) | [සිංහල](./docs/si/README-si.md) | [עברית](./docs/he/README-he.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://bundlephobia.com/package/dayjs"><img
9 src="https://img.shields.io/bundlephobia/minzip/dayjs?style=flat-square&color=%2345cc11"
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://github.com/iamkun/dayjs/actions/workflows/check.yml"><img
14 src="https://img.shields.io/github/actions/workflow/status/iamkun/dayjs/check.yml?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 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
86📚[Internationalization](https://day.js.org/docs/en/i18n/i18n)
87
88### Plugin
89
90A plugin is an independent module that can be added to Day.js to extend functionality or add new features.
91
92```javascript
93import advancedFormat from 'dayjs/plugin/advancedFormat' // load on demand
94
95dayjs.extend(advancedFormat) // use plugin
96
97dayjs().format('Q Do k kk X x') // more available formats
98```
99
100📚[Plugin List](https://day.js.org/docs/en/plugin/plugin)
101
102### Usage Trend
103
104<a href="https://npm-compare.com/moment,dayjs/#timeRange=THREE_YEARS" target="_blank">
105 <img src="https://user-images.githubusercontent.com/3455798/270162667-c7bd2ebe-675e-45c6-a2c9-dc67f3b65d6e.png">
106</a>
107
108## Sponsors
109
110Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
111
112[[Become a sponsor via Github](https://github.com/sponsors/iamkun/)] [[Become a sponsor via OpenCollective](https://opencollective.com/dayjs#sponsor)]
113
114<a href="https://toyokumo.co.jp" target="_blank">
115 <img width="70" src="https://user-images.githubusercontent.com/17680888/197092231-2367b5eb-1e43-467e-a311-23f7cd97b086.png">
116</a>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
118<a href="https://github.com/ken-swyfft" target="_blank">
119 <img width="70" src="https://avatars.githubusercontent.com/u/65305317?v=4">
120</a>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122<a href="https://opencollective.com/sight-and-sound-ministries" target="_blank">
123 <img width="70" src="https://user-images.githubusercontent.com/17680888/232316426-cb99b4cf-0ccb-4e73-a6ce-e16dba6aadf4.png">
124</a>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126<a href="https://chudovo.com/" target="_blank">
127 <img width="70" src="https://images.opencollective.com/chudovo/3c866f5/logo/256.png?height=256">
128</a>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130<a href="https://www.honrev.com" target="_blank">
131 <img width="70" src="https://github.com/user-attachments/assets/b3203350-34c1-4637-b8b1-d9b8bab346d3">
132</a>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134<a href="https://github.com/alan-eu" target="_blank">
135 <img width="70" src="https://avatars.githubusercontent.com/u/18175329?s=52&v=4">
136</a>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138<a href="https://www.exoflare.com/open-source/?utm_source=dayjs&utm_campaign=open_source" target="_blank">
139 <img width="70" src="https://user-images.githubusercontent.com/17680888/162761622-1407a849-0c41-4591-8aa9-f98114ec2092.png">
140</a>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142<a href="https://github.com/storyblok" target="_blank">
143 <img width="70" src="https://avatars.githubusercontent.com/u/13880908?s=200&v=4">
144</a>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146<a href="https://bestkru.com/" target="_blank">
147 <img width="70" src="https://avatars.githubusercontent.com/u/159320286" alt="BestKru">
148</a>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150<a href="https://route4me.com/" target="_blank">
151 <img width="70" src="https://github.com/user-attachments/assets/3fbc86c5-98a9-49c2-beae-1969026fcd76" alt="Route Optimizer and Route Planner Software">
152</a>
153
154
155## Contributors
156
157This project exists thanks to all the people who contribute.
158
159Please give us a 💖 star 💖 to support us. Thank you.
160
161And thank you to all our backers! 🙏
162
163<a href="https://opencollective.com/dayjs/backer/0/website?requireActive=false" target="_blank"><img width="35" src="https://opencollective.com/dayjs/backer/0/avatar.svg?requireActive=false"></a>
164<a href="https://opencollective.com/dayjs/backer/1/website?requireActive=false" target="_blank"><img width="35" src="https://opencollective.com/dayjs/backer/1/avatar.svg?requireActive=false"></a>
165<a href="https://opencollective.com/dayjs/backer/2/website?requireActive=false" target="_blank"><img width="35" src="https://opencollective.com/dayjs/backer/2/avatar.svg?requireActive=false"></a>
166<a href="https://opencollective.com/dayjs/backer/3/website?requireActive=false" target="_blank"><img width="35" src="https://opencollective.com/dayjs/backer/3/avatar.svg?requireActive=false"></a>
167<br />
168<a href="https://opencollective.com/dayjs#backers" target="_blank"><img src="https://opencollective.com/dayjs/contributors.svg?width=890" /></a>
169
170## License
171
172Day.js is licensed under a [MIT License](./LICENSE).