fix html encoding in render examples

patrickkunka · Dec 8, 2016 · c3cea5c · c3cea5c
1 parent 8f322f4
commit c3cea5c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/dist/mixitup.js b/dist/mixitup.js
@@ -1,7 +1,7 @@
 /**!
  * MixItUp v3.0.0-beta
  * A high-performance, dependency-free library for animated filtering, sorting and more
- * Build 6b06fe81-4ea9-43cd-95ec-e53682227df3
+ * Build 99b3485b-815f-4996-b892-3d3fa7457de9
  *
  * @copyright Copyright 2014-2016 KunkaLabs Limited.
  * @author    KunkaLabs Limited.
@@ -7811,7 +7811,7 @@
          * @public
          * @instance
          * @since       2.0.0
-         * @param       {(string|HTMLElement|Array.<HTMLElement>|mixitup.CommandFilter)} selector
+         * @param       {(string|HTMLElement|Array.<HTMLElement>)} selector
          *      Any valid CSS selector (i.e. `'.category-a'`), or the values `'all'` or `'none'`. The filter method also accepts a reference to single target element or a collection of target elements to show.
          * @param       {boolean}   [animate=true]
          *      An optional boolean dictating whether the operation should animate, or occur syncronously with no animation. `true` by default.

diff --git a/src/config-render.js b/src/config-render.js
@@ -31,9 +31,9 @@ mixitup.ConfigRender = function() {
      * var mixer = mixitup(containerEl, {
      *     render: {
      *         target: function(item) {
-     *             return '<div class="mix">' +
-     *                 '<h2>' + item.title + '</h2>' +
-     *             '</div>';
+     *             return '&lt;div class="mix"&gt;' +
+     *                 '&lt;h2&gt;' + item.title + '&lt;/h2&gt;' +
+     *             '&lt;/div&gt;';
      *         }
      *     }
      * });
@@ -43,16 +43,16 @@ mixitup.ConfigRender = function() {
      * var mixer = mixitup(containerEl, {
      *     render: {
      *         target: function(item) {
-     *             return `<div class="mix">
-     *                 <h2>${item.title}</h2>
-     *             </div>`;
+     *             return `&lt;div class="mix"&gt;
+     *                 &lt;h2&gt;${item.title}&lt;/h2&gt;
+     *             &lt;/div&gt;`;
      *         }
      *     }
      * });
      *
      * @example <caption>Example 3: Using a Handlebars template</caption>
      * {{{{raw}}}}
-     * var targetTemplate = Handlebars.compile('<div class="mix"><h2>{{title}}</h2></div>');
+     * var targetTemplate = Handlebars.compile('&lt;div class="mix"&gt;&lt;h2&gt;{{title}}&lt;/h2&gt;&lt;/div&gt;');
      * {{{{/raw}}}}
      *
      * var mixer = mixitup(containerEl, {

diff --git a/src/mixer.js b/src/mixer.js
@@ -2984,7 +2984,7 @@ h.extend(mixitup.Mixer.prototype,
      * @public
      * @instance
      * @since       2.0.0
-     * @param       {(string|HTMLElement|Array.<HTMLElement>|mixitup.CommandFilter)} selector
+     * @param       {(string|HTMLElement|Array.<HTMLElement>)} selector
      *      Any valid CSS selector (i.e. `'.category-a'`), or the values `'all'` or `'none'`. The filter method also accepts a reference to single target element or a collection of target elements to show.
      * @param       {boolean}   [animate=true]
      *      An optional boolean dictating whether the operation should animate, or occur syncronously with no animation. `true` by default.