Skip to content

Commit 849c635

Browse files
iamjr15claude
andcommitted
feat: add data attributes for show/hide options
- Add data-show-thumbnail, data-show-header, data-show-footer attributes - Update index.html code snippets with new options - Update README with data attributes documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 3b0bdfa commit 849c635

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed

assets/js/gh.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ <h2>// INTEGRATION</h2>
5858
<span class="code-tag">&lt;/style&gt;</span>
5959

6060
<span class="code-tag">&lt;!-- 2. Create the container --&gt;</span>
61-
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span> <span class="code-attr">data-login</span>=<span class="code-string">"<span class="dynamic-username">iamjr15</span>"</span><span class="code-tag">&gt;&lt;/div&gt;</span>
61+
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span>
62+
<span class="code-attr">data-login</span>=<span class="code-string">"<span class="dynamic-username">iamjr15</span>"</span>
63+
<span class="code-attr">data-show-thumbnail</span>=<span class="code-string">"true"</span><span class="code-tag">&gt;&lt;/div&gt;</span>
64+
<span class="code-tag">&lt;!-- Optional: data-show-thumbnail="false" to hide GitHub logo --&gt;</span>
6265

6366
<span class="code-tag">&lt;!-- 3. Include the script --&gt;</span>
6467
<span class="code-tag">&lt;script</span> <span class="code-attr">src</span>=<span class="code-string">"https://github-contribution-graph.netlify.app/assets/js/gh.js"</span><span class="code-tag">&gt;&lt;/script&gt;</span></code></pre>
@@ -99,7 +102,9 @@ <h2>// INTEGRATION</h2>
99102
--gh-border-card-color: #333333;</span>
100103
}
101104
`}<span class="code-tag">&lt;/style&gt;</span>
102-
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span> <span class="code-attr">data-login</span>=<span class="code-string">"<span class="dynamic-username">iamjr15</span>"</span> /<span class="code-tag">&gt;</span>
105+
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span>
106+
<span class="code-attr">data-login</span>=<span class="code-string">"<span class="dynamic-username">iamjr15</span>"</span>
107+
<span class="code-attr">data-show-thumbnail</span>=<span class="code-string">"true"</span> /<span class="code-tag">&gt;</span>
103108
<span class="code-tag">&lt;/&gt;</span>
104109
);
105110
};</code></pre>
@@ -111,7 +116,9 @@ <h2>// INTEGRATION</h2>
111116
<button class="copy-btn" data-target="snippet-vue">COPY</button>
112117
</div>
113118
<pre><code id="snippet-vue"><span class="code-tag">&lt;template&gt;</span>
114-
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span> <span class="code-attr">:data-login</span>=<span class="code-string">"username"</span><span class="code-tag">&gt;&lt;/div&gt;</span>
119+
<span class="code-tag">&lt;div</span> <span class="code-attr">id</span>=<span class="code-string">"gh"</span>
120+
<span class="code-attr">:data-login</span>=<span class="code-string">"username"</span>
121+
<span class="code-attr">data-show-thumbnail</span>=<span class="code-string">"true"</span><span class="code-tag">&gt;&lt;/div&gt;</span>
115122
<span class="code-tag">&lt;/template&gt;</span>
116123

117124
<span class="code-tag">&lt;script setup&gt;</span>

packages/github-contribution-graph/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,23 @@ widget.render();
5050

5151
```html
5252
<link rel="stylesheet" href="https://unpkg.com/github-contribution-graph/dist/gh.css">
53-
<div id="gh" data-login="octocat"></div>
53+
<div id="gh"
54+
data-login="octocat"
55+
data-show-thumbnail="true"
56+
data-show-header="true"
57+
data-show-footer="true"></div>
5458
<script src="https://unpkg.com/github-contribution-graph/dist/browser.global.js"></script>
5559
```
5660

61+
#### Data Attributes
62+
63+
| Attribute | Default | Description |
64+
|-----------|---------|-------------|
65+
| `data-login` | required | GitHub username |
66+
| `data-show-thumbnail` | `"true"` | Show/hide GitHub logo below graph |
67+
| `data-show-header` | `"true"` | Show/hide contribution count header |
68+
| `data-show-footer` | `"true"` | Show/hide legend footer |
69+
5770
## React API
5871

5972
### GitHubContributionGraph

packages/github-contribution-graph/src/vanilla/browser.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,17 @@ export function autoInit(): void {
3030
const username = container.dataset.login;
3131
if (!username) return;
3232

33+
// Parse data attributes for options
34+
const showThumbnail = container.dataset.showThumbnail !== 'false';
35+
const showHeader = container.dataset.showHeader !== 'false';
36+
const showFooter = container.dataset.showFooter !== 'false';
37+
3338
const widget = new GitHubContributionWidget({
3439
username,
3540
container,
41+
showThumbnail,
42+
showHeader,
43+
showFooter,
3644
});
3745

3846
widget.render();

0 commit comments

Comments
 (0)