evolutionBookmark jQuery Plugin

Ben Tiedt — Fri, 08 Mar 2024 17:51:32 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:51:32

jQuery.fn.evolutionBookmark

This plugin supports rendering a bookmark toggle link, allowing the user to bookmark or unbookmark content.

Usage

$('SELECTOR').evolutionBookmark(options)

where 'SELECTOR' is a span.

Options

contentId: (string) content ID
contentTypeId: (string) content type ID
typeId: (string) bookmark type ID
contentTypeName: (string) the name of the content type
initialState: (boolean) content is bookmarked
- default false
onBookmark: (function) callback function when a selection is made. The function is passed contentId, contentTypeId, typeId, and a callback function to call when processing is complete
onUnbookmark: (function) callback function when a selection is made. The function is passed contentId, contentTypeId, typeId, and a callback function to call when processing is complete
deleteBookmarkText: Label for the unbookmark link. {content_type_name} is replaced with the content's type name.
- default 'Unbookmark {content_type_name}'
addBookmarkText: Label for the bookmark link. {content_type_name} is replaced with the content's type name.
- default 'Bookmark this {content_type_name}'
processingText: Label for the link when it is processing. {content_type_name} is replaced with the content's type name.
- default '...'
addBookmarkCssClass: CSS class to apply to the bookmark link.
- default 'internal-link favorite-off'
deleteBookmarkCssClass: CSS class to apply to the unbookmark link.
- default 'internal-link favorite-on'
processingCssCLass: CSS class to apply to the link when processing.
- default 'internal-link processing'

Example

Given the following span to contain a bookmark control:

<span id="bookmarkControl"></span>

The following will initialize a bookmark control, using defaults for most options

var bookmarkControl = $('#bookmarkControl');
bookmarkControl.evolutionBookmark({
    initialState: true,  // content is bookmarked
    contentId: 'C512D1A1-ED6C-442D-BC9d-3587CD711D35',
    contentTypeId: 'F7D226AB-D59F-475C-9D22-4A79E3F0EC07',
    contentTypeName: 'Blog Post',
    onBookmark: function(contentId, contentTypeId, typeId, callback) {
        alert(contentId + ' bookmarked!');

        // ...perform AJAX-based saving of bookmark here...

        // After a successful save, callback to notify the bookmark plugin
        callback();
    },
    onUnbookmark: function(contentId, contentTypeId, typeId, callback) {
        alert(contentId + ' unbookmarked!');

        // ...perform AJAX-based saving of bookmark here...

        // After a successful save, callback to notify the bookmark plugin
        callback();
    }
});