@jamwidgets/astro

Note: This repo is a read-only mirror. Source lives in a private monorepo. For issues/PRs, please open them here and we'll sync changes back.

Astro components and content loader for JamWidgets - widgets for static sites.

Installation

npm install @jamwidgets/astro

Setup

Add your JamWidgets site key to your .env:

JAMWIDGETS_SITE_KEY=your_site_key_here

Content Loader (Posts)

Fetch posts from JamWidgets at build time using Astro's content collections:

// src/content.config.ts
import { defineCollection } from "astro:content";
import { jamwidgetsPostsLoader } from "@jamwidgets/astro/loader";

const posts = defineCollection({
  loader: jamwidgetsPostsLoader({
    siteKey: import.meta.env.JAMWIDGETS_SITE_KEY,
  }),
});

export const collections = { posts };

Then use in your pages:

---
import { getCollection } from "astro:content";
const posts = await getCollection("posts");
---

{posts.map((post) => (
  <article>
    <h2>{post.data.title}</h2>
    <p>{post.data.excerpt}</p>
  </article>
))}

Loader Options

jamwidgetsPostsLoader({
  siteKey: string;        // Required - your JamWidgets site key
  endpoint?: string;      // Default: 'https://jamwidgets.com'
  tag?: string;           // Filter posts by tag
  limit?: number;         // Max posts to fetch (default: 500)
  onError?: 'throw' | 'warn' | 'ignore';  // Error handling
})

Components

Form

A wrapper component for contact forms with built-in spam protection:

---
import Form from "@jamwidgets/astro/Form";
---

<Form siteKey={import.meta.env.JAMWIDGETS_SITE_KEY} formSlug="contact">
  <input name="name" placeholder="Name" required />
  <input name="email" type="email" placeholder="Email" required />
  <textarea name="message" placeholder="Message" required></textarea>
  <button type="submit">Send</button>
</Form>

Props:

• siteKey (required) - Your JamWidgets site key
• formSlug (required) - The form slug as configured in JamWidgets
• endpoint - Base URL (default: https://jamwidgets.com)
• theme - 'light' | 'dark' | 'auto' (default: 'light')
• class - Additional CSS class

Events:

• jamwidgets:loading - Form submission started
• jamwidgets:success - Submission successful (detail contains response)
• jamwidgets:error - Submission failed (detail contains error)

Comments

Threaded comments with a submission form:

---
import Comments from "@jamwidgets/astro/Comments";
---

<Comments
  siteKey={import.meta.env.JAMWIDGETS_SITE_KEY}
  pageId={Astro.url.pathname}
/>

Props:

• siteKey (required) - Your JamWidgets site key
• pageId (required) - Unique page identifier (e.g., URL path)
• endpoint - Base URL (default: https://jamwidgets.com)
• theme - 'light' | 'dark' | 'auto' (default: 'light')
• class - Additional CSS class

Events:

• jamwidgets:comment-posted - Comment submitted (detail contains comment)

Reactions

Reaction buttons (like, love, clap, etc.):

---
import Reactions from "@jamwidgets/astro/Reactions";
---

<Reactions
  siteKey={import.meta.env.JAMWIDGETS_SITE_KEY}
  pageId={Astro.url.pathname}
  reactions={["like", "love", "clap"]}
/>

Props:

• siteKey (required) - Your JamWidgets site key
• pageId (required) - Unique page identifier
• reactions - Array of reaction types (default: ['like'])
• icons - Custom icons: { like: '👍', love: '❤️' }
• endpoint - Base URL (default: https://jamwidgets.com)
• theme - 'light' | 'dark' | 'auto' (default: 'light')
• class - Additional CSS class

Built-in icons: like, love, clap, fire, think, sad, laugh

Events:

• jamwidgets:reaction-added - Reaction added
• jamwidgets:reaction-removed - Reaction removed

Subscribe

Email subscription form with double opt-in:

---
import Subscribe from "@jamwidgets/astro/Subscribe";
---

<Subscribe
  siteKey={import.meta.env.JAMWIDGETS_SITE_KEY}
  buttonText="Subscribe"
  placeholder="[email protected]"
/>

Props:

• siteKey (required) - Your JamWidgets site key
• endpoint - Base URL (default: https://jamwidgets.com)
• buttonText - Submit button text (default: 'Subscribe')
• placeholder - Email input placeholder
• successMessage - Custom success message
• theme - 'light' | 'dark' | 'auto' (default: 'light')
• class - Additional CSS class

Events:

• jamwidgets:subscribed - Subscription successful

SubscribeForm

A more flexible subscription form that wraps your own markup:

---
import SubscribeForm from "@jamwidgets/astro/SubscribeForm";
---

<SubscribeForm siteKey={import.meta.env.JAMWIDGETS_SITE_KEY}>
  <input name="email" type="email" placeholder="Email" required />
  <button type="submit">Join newsletter</button>
</SubscribeForm>

JavaScript API

For advanced use cases, use the JavaScript API directly:

import {
  submitForm,
  fetchComments,
  postComment,
  fetchReactions,
  addReaction,
  fetchPosts,
  fetchPost,
} from "@jamwidgets/astro";

// Submit a form
await submitForm({
  siteKey: "your_key",
  formSlug: "contact",
  data: { name: "John", email: "[email protected]", message: "Hello!" },
});

// Fetch comments
const comments = await fetchComments({
  siteKey: "your_key",
  pageId: "/blog/my-post",
});

// Add a reaction
await addReaction({
  siteKey: "your_key",
  pageId: "/blog/my-post",
  reactionType: "like",
});

Styling

Components use CSS custom properties for theming. Override them to match your site:

.jamwidgets-comments {
  --jamwidgets-border-color: #e5e7eb;
  --jamwidgets-bg-color: #f9fafb;
  --jamwidgets-text-color: inherit;
  --jamwidgets-button-bg: #3b82f6;
  /* ... see component source for all variables */
}

License

MIT