Add collapsedOnInit to options.

consbio · Jul 26, 2017 · b0fd453 · b0fd453
1 parent 7aee221
commit b0fd453
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+0.2.1 (2017-07-26)
+  * Add `collapsedOnInit` to `options`
+    - A new option that allows users to initialize an instance in expanded or collapsed mode.
diff --git a/L.Control.HtmlLegend.js b/L.Control.HtmlLegend.js
@@ -6,7 +6,8 @@ L.Control.HtmlLegend = L.Control.extend({
         position: 'topright',
         legends: [],   // array of legend entries - see README for format
         collapseSimple: false,  // if true, legend entries that are from a simple renderer will use compact presentation
-        detectStretched: false,  // if true, will test to see if legend entries look stretched.  These are usually in sets of 3 with the middle element having no label.
+        detectStretched: false,  // if true, will test to see if legend entries look stretched; these are usually in sets of 3 with the middle element having no label.
+        collapsedOnInit: false,  // if true, legends will be collapsed when a new instance is initialized.
         defaultOpacity: 1,
         visibleIcon: 'leaflet-html-legend-icon-eye',
         hiddenIcon: 'leaflet-html-legend-icon-eye-slash',
@@ -59,6 +60,10 @@ L.Control.HtmlLegend = L.Control.extend({
                 L.DomUtil.create('div', 'legend-caret', header);
                 L.DomUtil.create('span', null, header).innerHTML = legend.name;
 
+                if (this.options.collapsedOnInit) {
+                    L.DomUtil.addClass(header, 'closed');
+                }
+
                 L.DomEvent.on(header, 'click', function () {
                     if (L.DomUtil.hasClass(header, 'closed')) {
                         L.DomUtil.removeClass(header, 'closed');

diff --git a/L.Control.HtmlLegend.min.js b/L.Control.HtmlLegend.min.js
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ Options:
     legends: [],   // array of legend entries. see below for the structure
     collapseSimple: false,  // if true, legend entries that are from a simple renderer will use compact presentation
     detectStretched: false,  // if true, will test to see if legend entries look stretched.  These are usually in sets of 3 with the middle element having no label.
+    collapsedOnInit: false,  // if true, legends will be collapsed when a new instance is initialized.
     defaultOpacity: 1, // default opacity for layers in specified in legends.
     visibleIcon: 'leaflet-html-legend-icon-eye',  // css class for the visible icon on opacity slider
     hiddenIcon: 'leaflet-html-legend-icon-eye-slash',  // css class for the hidden icon on opacity slider

diff --git a/index.html b/index.html
@@ -266,6 +266,7 @@
         }],
         collapseSimple: true,
         detectStretched: true,
+        collapsedOnInit: true,
         defaultOpacity: 0.7,
         visibleIcon: 'icon icon-eye',
         hiddenIcon: 'icon icon-eye-slash'

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "leaflet-html-legend",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Leaflet legend plugin using html elements",
   "homepage": "http://github.com/consbio/Leaflet.HtmlLegend",
   "author": {