new draft: kudos-with-cabin

2024-11-25 00:12:18 +00:00 · 2024-06-24 21:49:36 -05:00 · 2024-06-24 21:49:36 -05:00 · 42f2116e46
commit 42f2116e46
parent 0367c94c4c
1 changed files with 150 additions and 0 deletions
--- a/content/posts/kudos-with-cabin/index.md
+++ b/content/posts/kudos-with-cabin/index.md
@ -0,0 +1,150 @@
+---
+title: "Kudos With Cabin"
+date: 2024-06-24
+# lastmod: 2024-06-24
+draft: true
+description: "Using Cabin's event tracking to add a simple post upvote widget to my Hugo site."
+featured: false
+toc: true
+reply: true
+categories: Backstage
+tags:
+  - hugo
+  - javascript
+  - meta
+  - selfhosting
+---
+
+I'm not one to really worry about page view metrics, but I do like to see which of my posts attract the most attention - and where that attention might be coming from. That insight has allowed me to find new blogs and sites that have linked to mine, and has tipped me off that maybe I should update that four-year-old post that's suddenly getting renewed traffic from Reddit.
+
+In my quest for such knowledge, last week I switched my various web properties back to using [Cabin](https://withcabin.com/) for "privacy-first, carbon conscious web analytics". I really like how lightweight and deliberately minimal Cabin is, and the portal does a great job of presenting the information that I care about. With this change, though, I gave up the cute little upvote widgets provided by the previous analytics platform.
+
+I recently shared [on my Bear weblog](https://blog.jbowdre.lol/tracking-bear-upvotes-from-my-cabin/) about how I was hijacking Bear's built-in upvote button to send a "kudos" [event](https://docs.withcabin.com/events.html) to Cabin and tally those actions there.
+
+Well today I implemented a similar thing on *this* blog. Without an existing widget to hijack, I needed to create this one from scratch using a combination of HTML in my page template, CSS to style it, and JavaScript to fire the event.
+
+### Layout
+
+My [Hugo](https://gohugo.io/) setup uses `layouts/_default/single.html` to control how each post is rendered, and I've already got a section at the bottom which displays the "Reply by email" link if replies are permitted on that page:
+
+
+
+```html
+# torchlight! {"lineNumbers":true}
+    <div class="content__body"> <!-- [tl! reindex(33))] -->
+        {{ .Content }}
+    </div>
+    {{- $reply := true }}
+    {{- if eq .Site.Params.reply false }}
+      {{- $reply = false }}
+    {{- else if eq .Params.reply false }}
+      {{- $reply = false }}
+    {{- end }}
+    {{- if eq $reply true }}
+    <hr>
+    <span class="post_email_reply"><a href="mailto:replies@example.com?Subject=Re: {{ .Title }}">📧 Reply by email</a></span>
+    {{- end }}
+```
+
+I'll only want the upvote widget to appear on pages where replies are permitted so this makes a logical place to insert the new code:
+
+```html
+# torchlight! {"lineNumbers":true}
+    <div class="content__body"> <!-- [tl! reindex(33)] -->
+        {{ .Content }}
+    </div>
+    {{- $reply := true }}
+    {{- if eq .Site.Params.reply false }}
+      {{- $reply = false }}
+    {{- else if eq .Params.reply false }}
+      {{- $reply = false }}
+    {{- end }}
+    {{- if eq $reply true }}
+    <hr>
+    <div class="kudos-container"> <!-- [tl! ++:5 **:5] -->
+      <button class="kudos-button">
+        <span class="emoji">👍</span>
+      </button>
+      <span class="kudos-text">Enjoyed this?</span>
+    </div>
+    <span class="post_email_reply"><a href="mailto:replies@example.com?Subject=Re: {{ .Title }}">📧 Reply by email</a></span>
+    {{- end }}
+```
+
+The button won't actually do anything yet, but it'll at least appear on the page. I can use some CSS to make it look a bit nicer though.
+
+### CSS
+
+My theme uses `static/css/custom.css` to override the defaults, so I'll drop some styling bits at the bottom of that file:
+
+```css
+# torchlight! {"lineNumbers":true}
+/* Cabin kudos styling [tl! reindex(406)] */
+.kudos-container {
+  display: flex;
+  align-items: center;
+}
+
+.kudos-button {
+  background: none;
+  border: none;
+  cursor: pointer;
+  font-size: 1.2rem;
+  padding: 0;
+  margin-right: 0.25rem;
+}
+
+.kudos-button:disabled {
+  cursor: default;
+}
+
+.kudos-button .emoji {
+  display: inline-block;
+  transition: transform 0.3s ease;
+}
+
+.kudos-button.clicked .emoji {
+  transform: rotate(360deg);
+}
+
+.kudos-text {
+  transition: font-style 0.3s ease;
+}
+
+.kudos-text.thanks {
+  font-style: italic;
+}
+```
+
+I got carried away a little bit and decided to add a fun animation when the button gets clicked. Which brings me to what happens when this thing gets clicked.
+
+### JavaScript
+
+I want the button to do a little bit more than *just* send the event to Cabin so I decided to break that out into a separate script, `assets/js/kudos.js`:
+
+```javascript
+// torchlight! {"lineNumbers":true}
+document.addEventListener('DOMContentLoaded', () => {
+  // select the elements to manipulate
+  var kudosButton = document.querySelector('.kudos-button');
+  var kudosText = document.querySelector('.kudos-text');
+  var emojiSpan = kudosButton.querySelector('.emoji');
+
+  kudosButton.addEventListener('click', () => {
+    cabin.event('kudos')
+    kudosButton.disabled = true;
+    kudosButton.classList.add('clicked');
+
+    kudosText.textContent = 'Thanks!';
+    kudosText.classList.add('thanks');
+
+    // Rotate the emoji
+    emojiSpan.style.transform = 'rotate(360deg)';
+
+    // Change the emoji after rotation
+    setTimeout(() => {
+      emojiSpan.textContent = '🎉';
+    }, 150);  // Half of the transition time for a smooth mid-rotation change
+  });
+});
+```