Comments component
<wy-comments> | WyComments
The comments component renders a complete and functional user interface for adding comments to something like a product page, blog post etc.
Importing
If you installed the UIKit with npm you can use the following snippet to import the component into your project.
Otherwise, if you installed the UIKit as a <script> you can ignore this section.
import { WyComments } from "@weavy/uikit-web";
Examples
As seen in this example, specifying the app identifier (uid) is required, and automatically creates a corresponding app on your Weavy environment when the component is first initialized.
<wy-comments uid="test-comments" name="Test comments"></wy-comments>
It's often useful to base the
uidon something that identifies the location where the component is rendered. Typically you would use something like a product id, page id, path or URL.
Properties
Most properties are optional and/or has sensible default values. Required properties are indicated with an asterix (*).
| Property | Type | Description |
|---|---|---|
uid* |
string |
Unique identifier for the app. |
name |
string |
Optional display name for the app (used in notifications etc.) |
notifications |
"button-list" | "none" |
Set the appearance of notifications. Defaults to "button-list". |
notificationsBadge |
"count" | "dot" | "none" |
Set the appearance of the notification badge. Defaults to "count". |
noAttachments |
boolean |
Disable the possibility to upload local attachments. |
noCloudFiles |
boolean |
Disable the cloud files integration. |
noMeetings |
boolean |
Disable the video meetings integration. |
noMentions |
boolean |
Disable the possibility to mention other people. |
noPreviews |
boolean |
Disable previews of files. |
noReactions |
boolean |
Disable the possibility to add emoji reactions. |
Learn more about attributes and properties.
Events
| Name | Description |
|---|---|
wy:link |
Emitted when a notification is clicked. |
Learn more about events.