evolutionFeature jQuery Plugin

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

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

jQuery.fn.evolutionFeature

This plugin supports rendering a feature toggle link that opens the create feature modal.

Usage

$('SELECTOR').evolutionFeature(options)

where 'SELECTOR' is a span.

Options

contentId: (string) content ID
contentTypeId: (string) content type ID
typeId: (string) feature type ID
panelUrl: (string) url to open features explicit panel
contentTypeName: (string) the name of the content type
initialState: (boolean) content is featured
- default false
editFeatureText: Label for the edit feature link. {content_type_name} is replaced with the content's type name.
- default 'Edit {content_type_name} feature'
addFeatureText: Label for the add feature link. {content_type_name} is replaced with the content's type name.
- default 'Feature {content_type_name}'

Example

Given the following span to contain a feature control:

<span id="featureControl"></span>

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

var featureControl = $('#featureControl');
featureControl.evolutionFeature({
    initialState: true,  // content is featured
    contentId: 'C512D1A1-ED6C-442D-BC9d-3587CD711D35',
    contentTypeId: 'F7D226AB-D59F-475C-9D22-4A79E3F0EC07',
    contentTypeName: 'Blog Post',
});