Merge pull request #7 from adidas/feature/update-choicesjs

Update ChoicesJS library
adidas · Apr 2, 2019 · 4170773 · 4170773
2 parents 4eb380d + 2e7b1c9
commit 4170773
Show file tree

Hide file tree

Showing 13 changed files with 462 additions and 313 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "plugins": [ "@babel/plugin-syntax-dynamic-import" ]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+# 1.3.0
+
+- Updated StencilJS core to v0.18.1.
+- Updated ChoicesJS to v7.0.0.
+  - `regexFilter` config has been replaced with `addItemFilterFn` function.
+  - `toggleDropdown` method has been removed.
+  - `clearChoices` method has been added.
+- Updated example with new options.
+- Updated documentation with example of framework integration.
+
 ## 1.2.1
 
 - Fixed Travis configuration to publish and create documentation on release tags.

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ The library is based on [ChoicesJS][choicesjs], but it is not bundle along with
 This dependency can be added to the bundle as external library, or it can just be added to the page via GitHub script:
 
 ```html
-<script src="https://rawgit.com/jshjohnson/Choices/v4.1.3/public/assets/scripts/choices.js"></script>
+<script src="https://rawgit.com/jshjohnson/Choices/v7.0.0/public/assets/scripts/choices.js"></script>
 ```
 
 ## Installation and running
@@ -97,6 +97,64 @@ Some of this component properties must be set via JavaScript (non primitive type
 </script>
 ```
 
+### Framework integration
+
+It is a good decision to create a wrapper of the Web Component to be ready to use by the application framework.
+
+The wrapper has to cover at least:
+
+- Properties:
+  - `type`: type of selector (see values in configuration section).
+  - `choices`: values to display in the selector.
+  - `name?`: name of the element (recommended).
+  - Other Web Component properties can be fixed or set dynamically.
+- Listeners:
+  - Changes on `choices` property to update the values of `choices` in the Web Component:
+  - `change` event of the Web Component to be able to propagate it.
+
+#### Example for VueJS framework
+
+```javascript
+// Loading ChoicesJS library and ChoicesJS Stencil Web Component
+import 'expose-loader?Choices!choices.js';
+import { defineCustomElements } from 'choicesjs-stencil/dist/loader';
+
+defineCustomElements(window);
+
+// VueJS component
+<template>
+  <choicesjs-stencil class="choicesjs-stencil"
+      :type="type"
+      :name="name"
+      ...
+  />
+</template>
+
+<script>
+export default {
+  props: [ 'type', 'name', 'choices' ],
+  watch: {
+    choices: {
+      immediate: true,
+      handler(newChoices, oldChoices) {
+        const select = this.$el;
+
+        if (select && oldChoices !== newChoices) {
+          select.choices = newChoices;
+        }
+      }
+    }
+  },
+  mounted() {
+    const select = this.$el;
+
+    select.choices = this.choices;
+    select.addEventListener('change', () => this.$emit('change'));
+  }
+};
+</script>
+```
+
 ### Configuration
 
 - `type`: the type of selector to render, defaults to `text`. Options: `text`, `single`, `multiple`.

diff --git a/index.html b/index.html
@@ -6,7 +6,7 @@
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css">
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script>
-    <script src="https://rawgit.com/jshjohnson/Choices/v4.1.3/public/assets/scripts/choices.js"></script>
+    <script src="https://rawgit.com/jshjohnson/Choices/v7.0.0/public/assets/scripts/choices.js"></script>
     <script src="dist/choicesjsstencil.js"></script>
     <style>
       html {
@@ -335,18 +335,17 @@ <h2 class="col-sm-12">ChoicesJS Web Component: test page</h2>
               </span>
               <input type="text" class="form-control" name="searchFields" value="[&quot;label&quot;, &quot;value&quot;]">
             </div>
-            <div class="form-group type type--text">
-              <label for="regexFilter">
-                Regex Filter
+            <div class="form-group">
+              <label for="addItemFilterFn">
+                addItemFilterFn(value) {
               </label>
-              <span class="description" data-toggle="tooltip" title="A filter that will need to pass for a user to successfully add an item.">
+              <span class="description" data-toggle="tooltip" title="The function that will need to pass for a user to successfully add an item.">
                 <span class="glyphicon glyphicon glyphicon-question-sign"></span>
               </span>
-              <div class="input-group">
-                <span class="input-group-addon">/</span>
-                <input type="text" class="form-control" name="regexFilter">
-                <span class="input-group-addon">/</span>
-              </div>
+              <textarea class="form-control textarea--vertical" name="addItemFilterFn" rows="2">
+return /^[^\s]+$/.test(value);
+              </textarea>
+              <label for="addItemFilterFn">}</label>
             </div>
             <div class="form-group type type--single type--multiple">
               <label for="position">
@@ -483,7 +482,9 @@ <h2 class="col-sm-12">ChoicesJS Web Component: test page</h2>
               <span class="description" data-toggle="tooltip" title="Function to run once Choices initialises.">
                 <span class="glyphicon glyphicon glyphicon-question-sign"></span>
               </span>
-              <textarea class="form-control textarea--vertical" name="callbackOnInit" rows="2"></textarea>
+              <textarea class="form-control textarea--vertical" name="callbackOnInit" rows="2">
+console.info('ChoicesJS Stencil Web Component ready!');
+              </textarea>
               <label for="callbackOnInit">}</label>
             </div>
             <div class="form-group">
@@ -493,10 +494,12 @@ <h2 class="col-sm-12">ChoicesJS Web Component: test page</h2>
               <span class="description" data-toggle="tooltip" title="Function to run on template creation. Through this callback it is possible to provide custom templates for the various components of Choices (see terminology). For Choices to work with custom templates, it is important you maintain the various data attributes defined in the reference link below.">
                 <span class="glyphicon glyphicon glyphicon-question-sign"></span>
               </span>
-              <textarea class="form-control textarea--vertical" name="callbackOnCreateTemplates" rows="2"></textarea>
+              <textarea class="form-control textarea--vertical" name="callbackOnCreateTemplates" rows="2">
+return template;
+              </textarea>
               <label for="callbackOnCreateTemplates">}</label>
               <br/>
-              <a href="https://github.com/jshjohnson/Choices/blob/67f29c286aa21d88847adfcd6304dc7d068dc01f/assets/scripts/src/choices.js#L1993-L2067">
+              <a href="https://github.com/jshjohnson/Choices/blob/v7.0.0/public/assets/scripts/choices.js#L713-L788" target="_blank">
                 Templates reference
               </a>
             </div>
@@ -520,7 +523,11 @@ <h2 class="col-sm-12">ChoicesJS Web Component: test page</h2>
       <div class="container">
         <div class="row">
           <div class="col-md-12">
-            <p class="text-center pad-top">See full documentation in <a href="https://www.npmjs.com/package/choices.js">choices.js</a> npm package.</p>
+            <p class="text-center pad-top">
+              See full documentation in
+              <a href="https://www.npmjs.com/package/choices.js/v/7.0.0" target="_blank">choices.js</a>
+              npm package.
+            </p>
           </div>
         </div>
       </div>
@@ -603,7 +610,9 @@ <h4 class="modal-title">Custom Styles</h4>
               <h4 class="modal-title">Search options</h4>
           </div>
           <div class="modal-body">
-            <h5 class="text-center pad-bottom">See full Fuse documentation in <a href="https://github.com/krisk/Fuse/tree/v2.7.4#options">GitHub</a>.</h5>
+            <h5 class="text-center pad-bottom">
+              See full Fuse documentation in <a href="https://fusejs.io/" target="_blank">GitHub</a>.
+            </h5>
             <form name="custom-search-form">
               <div class="form-group">
                 <div class="row">
@@ -789,7 +798,9 @@ <h5 class="text-center pad-bottom">See full Fuse documentation in <a href="https
             choices: jsonParser,
             items: jsonParser,
             searchFields: jsonParser,
-            regexFilter: regexParser(),
+            addItemFilterFn: function(value) {
+              return new Function('value', value.trim());
+            },
             renderChoiceLimit: Number,
             maxItemCount: Number,
             searchFloor: Number,