Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scriptex/gitlab-calendar
Embed your Gitlab calendar everywhere.
https://github.com/scriptex/gitlab-calendar
calendar contributions-calendar gitlab gitlab-calendar
Last synced: 3 months ago
JSON representation
Embed your Gitlab calendar everywhere.
- Host: GitHub
- URL: https://github.com/scriptex/gitlab-calendar
- Owner: scriptex
- License: mit
- Created: 2021-12-03T10:10:48.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T16:35:31.000Z (4 months ago)
- Last Synced: 2024-09-30T03:05:38.480Z (3 months ago)
- Topics: calendar, contributions-calendar, gitlab, gitlab-calendar
- Language: TypeScript
- Homepage: https://gitlab-calendar.atanas.info/
- Size: 1.24 MB
- Stars: 12
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/scriptex/gitlab-calendar/actions?query=workflow%3ABuild)
[](https://www.codacy.com/gh/scriptex/gitlab-calendar/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/gitlab-calendar&utm_campaign=Badge_Grade)
[](https://codebeat.co/projects/github-com-scriptex-gitlab-calendar-master)
[](https://www.codefactor.io/repository/github/scriptex/gitlab-calendar)
[](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
[](https://github.com/scriptex/gitlab-calendar/)
# Gitlab Calendar
> Embed your Gitlab Contributions Calendar anywhere
This package allows you to embed your Gitlab Contributions Calendar in any website.
The package does not handle network requests, this is left to the developer to decide and implement. Gitlab Calendar requires the data as it is provided by the `calendar` endpoint of the Gitlab API (https://gitlab.com/users/$USER/calendar.json).
**This project was inspired by [Github Calendar](https://github.com/Bloggify/github-calendar).**
## Visitor stats
## Code stats
## Live preview ([link](https://atanas.info/stats))
## Installation
```sh
npm i gitlab-calendar
# or
yarn add gitlab-calendar
```
## Usage
```typescript
import GitlabCalendar from 'gitlab-calendar';
new GitlabCalendar(document.getElementById('gitlab-calendar'), data, options);
```
## Data format
The data is obtained by fetching the `https://gitlab.com/users/$USER/calendar.json` endpoint.
This exercise is left to the developer implementing it.
`gitlab-calendar` requires the data in the following format:
```json
{
"2020-12-07": 1,
"2020-12-09": 2,
"2020-12-10": 5,
...
}
```
## Options
| Name | Type | Default value |
| ------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `daySize` | `number` | 15 |
| `hintText` | `string` | 'Issues, merge requests, pushes, and comments.' |
| `daySpace` | `number` | 1 |
| `utcOffset` | `number` | 0 |
| `dayTitles` | `Record` |
{
monday: 'M',
wednesday: 'W',
friday: 'F',
saturday: 'S',
sunday: 'S'
} |
| `monthsAgo` | `number` | 12 |
| `monthNames` | `string[]` | ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] |
| `inputFormat` | `string` | 'yyyy-MM-dd' |
| `weekdayNames` | `string[]` | ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'] |
| `legendValues` | `ActivityCalendarLegendValue[]` | [
{ title: 'No contributions', min: 0 },
{ title: '1-9 contributions', min: 1 },
{ title: '10-19 contributions', min: 10 },
{ title: '20-29 contributions', min: 20 },
{ title: '30+ contributions', min: 30 }
]
|
| `firstDayOfWeek` | `number` | 0 |
| `tooltipDateFormat` | `string` | 'MMM d, yyyy' |
| `tooltipFormatter` | `(count: number, dayName: string, dateText: string) => string` | (count: number, dayName: string, dateText: string) => {
let contribText = 'No contributions';
if (count > 0) {
contribText = count === 1 ? '1 contribution' : `${count} contributions`;
}return `${contribText} on ${dayName} ${dateText}`;
} |
## LICENSE
MIT
---
Connect with me:
---
Support and sponsor my work:
