wix-comments-view

comments-wix-view

Properties

propName	propType	defaultValue	isRequired	description
settings	array	[]	-	Configuration of the app Settings. See table below
style	array	[]	-	Configuration of the app Style. See table below
commentsToShow	array	-	-	array of comments to show
totalComments	number	-	-	total number of all comments
numberOfPreviousComments	number	-	-	number of Comments to load when clicking 'View more comments'
currentUser	array	-	-	The current logged in user. See table below
isLoggedIn	bool	-	-	if the user is logged in or not
isInCommunity	bool	-	-	if the user in the cummunity or not
memberAuth	func	-	-	A callback method to be called to check if user is loged-in and in community. if he does loged-in, it cal to the callback with the args. Signature: memberAuth(args, cb)

Callbacks

propName	propType	defaultValue	isRequired	description
onShowPreviousComments	func	-	-	A callback when previous comments requested by the user.
onPreviousReplies	func	-	-	A callback when previous replies requested by the user. onPreviousReplies(nextPage)
onReactionChange	func	-	-	A callback when reaction (like) is clicked onReactionChange(comment, isActive, callBack)
onShowMoreAction	func	-	-	A func that open 'more actions' popup for a comment (or reply) onShowMoreAction(comment, isComment, replyContainerCommentId)
onShowReportedAction	func	-	-	A func that open 'reported action' popup for a comment (or reply) onShowReportedAction(comment)
onCommentAdded	func	-	-	Create a new comment onCommentAdded(content, isTop)
onReplyAdded	func	-	-	Create a new reply onReplyAdded(commentId, rawContent)
updateComment	func	-	-	Update a comment or reply

Settings

propName	propType	defaultValue	isRequired	description
commentsToDisplay	number	5	-	Max number of Comments to display
repliesToDisplay	number	3	-	Max number of Replies to display (per Comment)
textDirection	-	'ltr'	-	Text direction
language	json	{}	-	Language to display
repliesToLoadOnShowMore	-	10	-	Number of Replies to load when clicking 'View more'
enableReplies	bool	true	-	Can visitors add replies
enableLikes	bool	true	-	Can visitors like Comments / Reviews / Replies
enableShare	bool	true	-	Can visitors share Comments / Reviews / Replies
showRepliesByDefault	bool	true	-	Show Replies expended OR collapsed by default

Style

propName	propType	defaultValue	isRequired	description
-	-	-	-	-

User

propName	propType	defaultValue	isRequired	description
id	string	-	-	The user id
name	string	-	-	The user name
avatar	string	-	-	The user avatar url
isAdmin	bool	false	-	If the user is admin