mirror of
https://github.com/Paillat-dev/svelte-github-calendar.git
synced 2026-01-02 17:24:56 +00:00
Compare commits
4 Commits
v0.1.0-alp
...
v0.1.0-alp
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
71af282bd2 | ||
|
|
be3af1f676 | ||
|
|
bacfd12dfc | ||
|
|
d16e4b2f1f |
24
README.md
24
README.md
@@ -14,7 +14,7 @@ npm install svelte-github-calendar
|
|||||||
|
|
||||||
```svelte
|
```svelte
|
||||||
<script>
|
<script>
|
||||||
import { GithubCalendar } from 'svelte-github-calendar';
|
import { GithubCalendar } from 'svelte-github-calendar';
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<GithubCalendar username="yourusername" />
|
<GithubCalendar username="yourusername" />
|
||||||
@@ -24,24 +24,24 @@ npm install svelte-github-calendar
|
|||||||
|
|
||||||
```svelte
|
```svelte
|
||||||
<script>
|
<script>
|
||||||
import { GithubCalendar } from 'svelte-github-calendar';
|
import { GithubCalendar } from 'svelte-github-calendar';
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<GithubCalendar
|
<GithubCalendar
|
||||||
username="yourusername"
|
username="yourusername"
|
||||||
summary_text="Summary of {name}'s GitHub activity"
|
summary_text="Summary of {name}'s GitHub activity"
|
||||||
global_stats={true}
|
global_stats={true}
|
||||||
responsive={true}
|
responsive={true}
|
||||||
tooltips={true}
|
tooltips={true}
|
||||||
cache={60}
|
cache={60}
|
||||||
class="my-custom-class"
|
class="my-custom-class"
|
||||||
/>
|
/>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Props
|
## Props
|
||||||
|
|
||||||
| Prop | Type | Default | Description |
|
| Prop | Type | Default | Description |
|
||||||
|----------------|------------|--------------|------------------------------------------|
|
| -------------- | ---------- | ------------ | ---------------------------------------- |
|
||||||
| `username` | `string` | **Required** | GitHub username to display calendar for |
|
| `username` | `string` | **Required** | GitHub username to display calendar for |
|
||||||
| `summary_text` | `string` | `undefined` | Custom summary text template. |
|
| `summary_text` | `string` | `undefined` | Custom summary text template. |
|
||||||
| `proxy` | `function` | `undefined` | Custom proxy function for API requests |
|
| `proxy` | `function` | `undefined` | Custom proxy function for API requests |
|
||||||
@@ -65,6 +65,7 @@ This library is licensed under the MIT License. See the [LICENSE](LICENSE) file
|
|||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are welcome! Feel free to:
|
Contributions are welcome! Feel free to:
|
||||||
|
|
||||||
- Report bugs
|
- Report bugs
|
||||||
- Suggest new features
|
- Suggest new features
|
||||||
- Submit pull requests
|
- Submit pull requests
|
||||||
@@ -73,5 +74,6 @@ Contributions are welcome! Feel free to:
|
|||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Calendar not loading
|
### Calendar not loading
|
||||||
|
|
||||||
- Ensure the username is valid and public
|
- Ensure the username is valid and public
|
||||||
- Verify network connectivity
|
- Verify network connectivity
|
||||||
|
|||||||
@@ -58,6 +58,7 @@
|
|||||||
|
|
||||||
table.ContributionCalendar-grid {
|
table.ContributionCalendar-grid {
|
||||||
margin-bottom: 0pt !important;
|
margin-bottom: 0pt !important;
|
||||||
|
border-collapse: separate !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
table.ContributionCalendar-grid td {
|
table.ContributionCalendar-grid td {
|
||||||
@@ -144,6 +145,10 @@
|
|||||||
font-size: 11px !important;
|
font-size: 11px !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.contrib-column span {
|
||||||
|
color: #000 !important;
|
||||||
|
}
|
||||||
|
|
||||||
.contrib-column-first {
|
.contrib-column-first {
|
||||||
border-left: 0 !important;
|
border-left: 0 !important;
|
||||||
}
|
}
|
||||||
@@ -191,6 +196,10 @@
|
|||||||
height: 26px !important;
|
height: 26px !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.calendar .text-muted {
|
||||||
|
color: inherit !important;
|
||||||
|
}
|
||||||
|
|
||||||
.left.text-muted {
|
.left.text-muted {
|
||||||
float: left !important;
|
float: left !important;
|
||||||
margin-left: 9px !important;
|
margin-left: 9px !important;
|
||||||
|
|||||||
Reference in New Issue
Block a user