Documentation
Everything you need to add Seriph widgets to your site.
Packages
@seriphxyz/astro Recommended Drop-in Astro components for comments, reactions, forms, and subscriptions. Includes a content loader for fetching posts at build time.
@seriphxyz/core Framework-agnostic API client and headless controllers. Use this to build custom integrations or with any framework.
@seriphxyz/react React hooks for comments, reactions, forms, and subscriptions. Works with Next.js, Remix, Vite, and more.
@seriphxyz/solid SolidJS primitives for comments, reactions, forms, and subscriptions. Works with SolidStart, Astro, and standalone apps.
Quick Start (Astro)
1. Install the package
npm install @seriphxyz/astro2. Get your site key
Create a site in your Seriph dashboard and copy your API key.
3. Add components to your pages
---
import Comments from '@seriphxyz/astro/Comments'
import Reactions from '@seriphxyz/astro/Reactions'
import Subscribe from '@seriphxyz/astro/Subscribe'
---
<article>
<!-- your content -->
</article>
<!-- Add comments to your blog posts -->
<Comments siteKey="your-key" pageId="my-post" />
<!-- Add reactions (likes, claps, etc.) -->
<Reactions siteKey="your-key" pageId="my-post" />
<!-- Add a subscription form -->
<Subscribe siteKey="your-key" />Available Widgets
Comments
Threaded discussions with moderation
Reactions
Hearts, claps, and custom reaction types
Forms
Contact forms with spam protection
Subscribe
Email subscriptions with double opt-in
Waitlist
Collect signups before launch
Feedback
Bug reports and feature requests
Polls
Surveys with real-time results
Announcements
Site-wide banners and notices
Views
Page view tracking and analytics
Posts
Content loader for CMS posts
API Reference
All widgets communicate with our REST API. If you're building a custom integration,
you can use the API directly or through the @seriphxyz/core package.