https://github.com/scriptex/calendar-widget
A super simple calendar widget written in TypeScript and SCSS
https://github.com/scriptex/calendar-widget
calendar calendar-widget scss-widget typescript-widget
Last synced: 5 months ago
JSON representation
A super simple calendar widget written in TypeScript and SCSS
- Host: GitHub
- URL: https://github.com/scriptex/calendar-widget
- Owner: scriptex
- License: mit
- Created: 2019-05-03T12:19:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-08-20T20:18:08.000Z (5 months ago)
- Last Synced: 2025-08-20T22:23:38.837Z (5 months ago)
- Topics: calendar, calendar-widget, scss-widget, typescript-widget
- Language: TypeScript
- Homepage: https://calendar-widget.atanas.info/
- Size: 1.29 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/scriptex/calendar-widget)
[](https://github.com/scriptex/calendar-widget/actions?query=workflow%3ABuild)
[](https://www.codacy.com/gh/scriptex/calendar-widget/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/calendar-widget&utm_campaign=Badge_Grade)
[](https://codebeat.co/projects/github-com-scriptex-calendar-widget-master)
[](https://www.codefactor.io/repository/github/scriptex/calendar-widget)
[](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
[](https://github.com/scriptex/calendar-widget/)
# Calendar Widget
> A super simple calendar widget written in TypeScript and SCSS implemented with a11y (accessibility) and i18n (internationalization) in mind.
## Visitor stats
## Code stats
## Demo
If you wish to go directly to the demo, please click [here](https://codepen.io/scriptex/pen/mgLExx) or [here](https://calendar-widget.atanas.info/).
## Options
The widget accepts an object with options which are optional:
1. Start year - number - defaults to current year.
2. Start month - number - defaults to current month (**It is zero based**).
3. ID of the container which will hold the calendar - String - defaults to `body`.
4. An object with strings used for internationalization - Object - defaults to:
```json
{
"days": ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
"months": [
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"Septemer",
"October",
"November",
"December"
],
"prevMonth": "←",
"nextMonth": "→",
"prevMonthTitle": "Previous month",
"nextMonthTitle": "Next month"
}
```
## Install
```sh
# Via NPM
npm i simple-calendar-widget
# Via Yarn
yarn add simple-calendar-widget
```
## Usage
```js
import { renderCalendarWidget } from 'simple-calendar-widget';
// Default settings
renderCalendarWidget();
// Or custom settings
renderCalendarWidget({
startYear: 2018,
startMonth: 0,
container: '#calendar',
translations: {
days: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'],
months: [
'January',
'February',
'March',
'April',
'May',
'June',
'July',
'August',
'Septemer',
'October',
'November',
'December'
],
prevMonth: '←',
nextMonth: '→',
prevMonthTitle: 'Previous month',
nextMonthTitle: 'Next month'
}
});
```
## TypeScript support
The package is written in TypeScript and provides full TypeScript support. The widget exports several types which are automatically found by TypeScript.
## CSS
The widget comes with an optional stylesheet. You can see the default styling in the demo above.
In order to use the default style, you should have used the default settings:
```css
/* If you used the default settings */
@import 'calendar-widget/dist/index.css';
```
If you are using SCSS and wish to use the widget with custom settings, you can import the SCSS mixin and tweak it a bit:
```scss
@import 'calendar-widget/index.scss';
#my-calendar-container {
$calendar-width: 400px;
$calendar-color: rebeccapurple;
@include calendar($calendar-width, $calendar-color);
}
```
You can also include the stylesheet in a `` in your markup:
```html
```
## LICENSE
MIT
---
Connect with me:
---
Support and sponsor my work:
