https://github.com/fastcomments/fastcomments-svelte
FastComments Svelte Components
https://github.com/fastcomments/fastcomments-svelte
Last synced: 2 months ago
JSON representation
FastComments Svelte Components
- Host: GitHub
- URL: https://github.com/fastcomments/fastcomments-svelte
- Owner: FastComments
- License: mit
- Created: 2023-10-06T03:47:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-16T21:27:06.000Z (4 months ago)
- Last Synced: 2026-02-17T04:25:34.154Z (4 months ago)
- Language: Svelte
- Size: 1.26 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fastcomments-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
```svelte
import CommentWidget from "fastcomments-svelte/CommentWidget.svelte";
import type { FastCommentsCommentWidgetConfig } from "fastcomments-typescript";
let config: FastCommentsCommentWidgetConfig = {
tenantId: "demo",
urlId: "my-page"
};
```
## Widgets
This library currently contains the following widgets:
- [Collab Chat](./src/lib/CollabChatWidget.svelte)
- [Comment Count (single)](./src/lib/CommentCountWidget.svelte)
- [Comment Widget](./src/lib/CommentWidget.svelte)
- [Image Chat](./src/lib/ImageChatWidget.svelte)
- [Streaming Chat](./src/lib/StreamingChatWidget.svelte)
- [User Activity Feed](./src/lib/UserActivityFeedWidget.svelte)
It also features examples for:
- [Callbacks](./src/routes/callbacks-example/+page.svelte)
- [Dark Mode](./src/routes/dark-mode-example/+page.svelte)
- [EU](./src/routes/eu-example/+page.svelte)
- [Paginating Products or Blog Posts](./src/routes/paginated-example/+page.svelte)
- [Secure SSO](./src/routes/secure-sso-example/+page.svelte)
- [Simple SSO](./src/routes/simple-sso-example/+page.svelte)
## Developing
Once you've installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
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:
```bash
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](https://blog.fastcomments.com/) for updates. Breaking API changes or features will never be shipped to the underlying core library without a version bump in this library.