Add Comments to Your Svelte App

This is the official Svelte Library for FastComments.

Embed live commenting, chat, and review widgets in your Svelte app.

Repository

Live Demo

Try every widget live at https://fastcomments.com/commenting-system-for-svelte.

A set of Svelte widgets and wrappers for FastComments. src/routes contains runnable examples - simply run:

npm install
npm run dev

Then you can see all the widgets and edit them - for example to put in your own tenant id or try different configuration.

TypeScript has been used so that you can inspect the config objects for each widget to see what options they take.

Quick Start

<script lang="ts">
  import CommentWidget from "fastcomments-svelte/CommentWidget.svelte";
  import type { FastCommentsCommentWidgetConfig } from "fastcomments-typescript";

  let config: FastCommentsCommentWidgetConfig = {
    tenantId: "demo",
    urlId: "my-page"
  };
</script>

<CommentWidget config={config} />

Widgets

This library currently contains the following widgets:

It also features examples for:

Developing

Once you've installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of the library, everything inside src/routes is the showcase.

Building

To build:

npm run package

Maintenance Status

These components are wrappers around our core VanillaJS components. We can automatically update these components (fix bugs, add features) without publishing this library, so while it may not be published for a while that does not mean FastComments is not under active development! Feel free to check our blog for updates. Breaking API changes or features will never be shipped to the underlying core library without a version bump in this library.

Need Help?

If you encounter any issues or have questions about the Svelte Library, please:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.

Language 🇺🇸 English

Documentation