evolutionModerate jQuery Plugin

Ben Tiedt — Tue, 19 Nov 2019 20:28:38 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:28:38

jQuery.fn.evolutionModerate

This plugin implements a control which enables a user to report a piece of content as abusive via a drop-down menu which displays when hovered over. When reported, a [[notifications JavaScript API Module|notification]] is displayed to the reporting user. It also supports displaying other actions alongside abuse reporting. Raises and responds to [[ui.reportabuse Client Message|ui.reportabuse]] messages. It is typically not invoked directly, but rather by the [[moderate UI Component|moderate UI component]].

Usage

Initializes the moderation plugin where SELECTOR is a .

$('SELECTOR').evolutionModerate(options)

Options

contentId: (string) Content Id
contentTypeId: (string) Content Type Id
initialState: (boolean) Currently reported by the accessing user
linkClassName: (string) CSS class to apply to the link
onReport: function which implements abuse reporting. Passed parameters:
- contentId: Content Id being reported
- contentTypeId: Content Type Id being reported
- complete: Callback to invoke when reporting has completed.
onGetAdditionalLinks: function which, when invoked, can asynchronously provide additional links to display alongside abuse reporting within the same menu. Passed parameters:
- complete: Callback to invoke to pass an array of link objects back to the plugin. Each object should contain keys defining the link's href and text, and optionally the className.
notificationDuration: (number) milliseconds to display notification after reporting abuse.
- default: 5000
supportsAbuse: (boolean) whether the content supports abuse and should embed abuse reporting within its menu
- default: true
reportLinkText: (string) menu label to display when content is not reported. Evolution sets this automatically, localized.
- default: 'Report as abusive'
reportedLinkText: (string) menu label to display when content has already been reported. Evolution sets this automatically, localized.
- default: 'Reported as abusive'
reportedNotificationMessageText: (string) message to display in the notification after reporting. Evolution sets this automatically, localized.
- default: '{NAME}'s post has been reported. Thank you for your feedback.'
moderationLinkTemplate: (string) Template to use when rendering a moderation link. Evolution sets this automatically.
- default: '<a href="#" class="<%: linkClassName %>"><%= resources.moderateLinkText %></a>'
notificationTemplate: (string) Template to use when rendering a notification of reporting back to the reporting user. Evolution sets this automatically.
- default: '<%= resources.reportedNotificationMessageText %>'
moderationMenuTemplate: (string) Template to use when rendering a moderation menu. Evolution sets this automatically.

Default:

<ul class="navigation-list">
    <% foreach(links, function(link){ %>
        <li class="navigation-item">
            <a href="<%: (link.href || "#") %>" class="<%: (link.className || "") %>"><%= link.text %></a>
        </li>
    <% }); %>
</ul>