feature UI Component

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

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

jQuery.telligent.evolution.ui.components.feature

[[ui JavaScript API Module|UI Component]] which handles presentation of feature behavior for content. Transforms the output from $core_v2_ui.Feature(), which is a <span class="ui-feature"></span> stub. The default implementation uses the [[evolutionFeature jQuery Plugin|evolutionFeature plugin]]. [[ui JavaScript API Module|Overrides can be provided]] at the theme level to present features differently.

Options

Data made available to instances of the component:

contenttypeid: (string) Content Type Id Guid
contentid: (string) Content Id Guid
typeid: (string) Feature Type Id Guid
value: (string) If the content is featured or not by the accessing user (true or false)
contenttypename: (string) Type name for this content

Example

A barebones UI component override which would result in rendering a read-only message of 'Featured? Yes/No' for a given call to $core_v2_ui.Feature().

$.telligent.evolution.ui.components.feature = {
    setup: function() {
    },
    add: function(elm, options) {
        $(elm).html('Featured? ' + (options.value == 'true' ? 'Yes' : 'No'));

        console.log('ContentId: ' + options.contentid);
        console.log('ContentTypeId: ' + options.contenttypeid);
        console.log('TypeId: ' + options.typeid);
        console.log('PanelUrl: ' + options.panelurl);
        console.log('Value: ' + options.value);
        console.log('ContentTypeName: ' + options.contenttypename);
    }
}

Default Implementation

For reference purposes or as the basis for an override:

$.telligent.evolution.ui.components.feature = {
    setup: function() {
    },
    add: function(elm, options) {

        elm.empty();

        var config = {
            contentId: options.contentid,
            contentTypeId: options.contenttypeid,
            typeId: options.typeid,
            panelUrl: options.panelurl,
            initialState: options.value == 'true',
            contentTypeName: options.contenttypename,
            onClick: function(panelUrl, complete) {