https://github.com/fastcomments/fastcomments-vue-next
A Vue 3.0 library for FastComments, a fast and developer friendly comment system.
https://github.com/fastcomments/fastcomments-vue-next
Last synced: about 1 year ago
JSON representation
A Vue 3.0 library for FastComments, a fast and developer friendly comment system.
- Host: GitHub
- URL: https://github.com/fastcomments/fastcomments-vue-next
- Owner: FastComments
- Created: 2020-10-02T03:34:41.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-18T02:19:43.000Z (over 1 year ago)
- Last Synced: 2025-05-06T18:07:17.231Z (about 1 year ago)
- Language: Vue
- Size: 430 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# fastcomments-vue-next
> A Vue 3.0 library for FastComments, a fast and developer friendly comment system.
[](https://www.npmjs.com/package/fastcomments-vue-next) [](https://standardjs.com)
## Installation
### NPM
```bash
npm install --save fastcomments-vue-next
```
### Yarn
```bash
yarn add fastcomments-vue-next
```
## Usage
### The Comment Widget
The FastCommentsVueNext component contains the live FastComments comment widget.
Replace "demo" below with your "tenantId" - available [here](https://fastcomments.com/auth/my-account/api) in the FastComments admin area.
The widget supports a lot of options - see FastCommentsConfig [here](https://github.com/FastComments/fastcomments-typescript/blob/eae973fb7885de4df58b21b7a22a3e40c89feefa/src/fastcomments-config.ts#L14).
```vue
import { FastComments } from 'fastcomments-vue-next'
export default {
name: 'FastCommentsExample',
components: {
FastComments
}
}
```
## Updating The Current Page (SPA Example)
In FastComments we call the article id, or page the comments get tied to, the URL ID as it can be a url or an ID.
Define the URL ID in the following manner. The component watches for changes in config object, and will reload, so you can update the URL ID.
```vue
```
### Account Region (ATTENTION: EU Customers)
If your account is located in the EU, set `region = 'eu'` in the widget configuration, for example:
```vue
```
Otherwise, you do not have to define `region`.
## In Production
You probably don't want to define the config inline if you're passing callbacks etc. Instead, you'll want to define
the config via `computed()`, otherwise each time your callback etc is invoked the entire widget will re-render.
## All Widgets and Documentation
Run the local documentation:
```bash
npm run serve
```
## Contributing
Please check out our [contribution guidelines](CONTRIBUTING.md) before starting on a change. Remember to communicate first!
## License
MIT © [winrid](https://github.com/winrid)