https://github.com/hello-week/hello-week

Hello Week - Lightweight and simple calendar with no dependencies.
https://github.com/hello-week/hello-week

calendar css datepicker html javascript linter plugin scss typescript vue webpack yarn

Last synced: about 2 months ago
JSON representation

Hello Week - Lightweight and simple calendar with no dependencies.

• Host: GitHub
• URL: https://github.com/hello-week/hello-week
• Owner: hello-week
• License: mit
• Created: 2018-03-05T15:40:54.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T16:10:42.000Z (10 months ago)
• Last Synced: 2025-05-07T08:09:39.432Z (about 2 months ago)
• Topics: calendar, css, datepicker, html, javascript, linter, plugin, scss, typescript, vue, webpack, yarn
• Language: TypeScript
• Homepage: https://hello-week.com/
• Size: 2.27 MB
• Stars: 92
• Watchers: 7
• Forks: 27
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![Hello Week](public/images/helloweek.png)

[![GitHub Tag](https://img.shields.io/github/release/mauroreisvieira/hello-week.svg?style=for-the-badge)](https://github.com/mauroreisvieira/hello-week/releases)

[![npm](https://img.shields.io/npm/dt/hello-week.svg?style=for-the-badge)](https://www.npmjs.com/package/hello-week)

[![GitHub issues](https://img.shields.io/github/issues/mauroreisvieira/hello-week.svg?style=for-the-badge)](https://github.com/mauroreisvieira/hello-week/issues)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](https://github.com/mauroreisvieira/hello-week/blob/master/LICENSE)

## Quick start

#### Installation

```bash

npm install hello-week --save

```

```bash

yarn add hello-week

```

#### Including Files:

**CSS**

```html

```

**JS**

```html

    import HelloWeek from 'hello.week.esm.js';

    new HelloWeek();

```

**HTML Markup**

```html



    


        Prev

        


        Next

    

    


    




```


## Options

HelloWeek comes with a few (optional) settings that you can change by passing an object as an argument.

Default values are presented below.

```js

new HelloWeek({

    selector: '.hello-week',

    lang: 'en',

    langFolder: './dist/langs/',

    format: 'DD/MM/YYYY',

    weekShort: true,

    monthShort: false,

    multiplePick: false,

    defaultDate: null,

    minDate: null,

    maxDate: null,

    disabledDaysOfWeek: null,

    disableDates: null,

    weekStart: 0, // week start on Sunday

    timezoneOffset: new Date().getTimezoneOffset(),

    daysSelected: null,

    daysHighlight: null,

    disablePastDays: false,

    todayHighlight: true,

    range: false,

    locked: false,

    rtl: false,

    nav: ['◀', '▶'],

    onClear: () => {},

    onLoad: () => {},

    onNavigation: () => {},

    onSelect: () => {},

    beforeCreateDay: (node) => {},

});

```

### Useful links

-   [Demos](https://hello-week.com/#/)

-   [Changelog](CHANGELOG.md)

-   [Contributing](CONTRIBUTING.md)

### Supported Browsers:

-   Chrome 49

-   Firefox 31

-   Opera 36

-   Safari 9.3

-   Edge 17

-   iOS Safari 6.0

### License

**Hello Week** is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)