Browse Source

added README and extension.json

Hop 9 years ago
parent
commit
710c40696c

+ 17 - 0
docs/data/extensions.json

@@ -233,6 +233,23 @@
         }
         }
     },
     },
     {
     {
+        "name": "Multi Column Toggle",
+        "version": "1.0.0",
+        "description": "Allows allows hiding and showing of multiple columns at once.",
+        "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/multi-column-toggle",
+        "example": "http://issues.wenzhixin.net.cn/bootstrap-table/#extensions/multi-column-toggle.html",
+
+        "plugins": [{
+            "name": "multi-column-toggle",
+            "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/multi-column-toggle"
+        }],
+
+        "author": {
+            "name": "Homer Glascock",
+            "image": "https://avatars1.githubusercontent.com/u/5546710"
+        }
+    },
+    {
         "name": "Natural Sorting",
         "name": "Natural Sorting",
         "version": "1.0.0",
         "version": "1.0.0",
         "description": "Plugin to support the natural sorting.",
         "description": "Plugin to support the natural sorting.",

+ 36 - 0
src/extensions/multi-column-toggle/README.md

@@ -0,0 +1,36 @@
+# Multi Column Toggle
+
+Use Plugin: [multi-column-toggle](https://github.com/wenzhixin/bootstrap-table/tree/develop/src/extensions/multi-column-toggle)
+
+Adds a button to the toolbar that hides and shows all collumns that are 'switchable'.
+
+## Usage
+
+```html
+<script src="extensions/multi-column-toggle/bootstrap-table-multi-toggle.js"></script>
+```
+
+## Options
+
+### showToggleBtn
+
+* type: Boolean
+* description: Set true to show the toggle button. This button toggles hiding and showing of multiple columns at once.
+* default: `false`
+
+### multiToggleDefaults
+
+* type: Array of Strings
+* description: Defines 'default' columns that will never be hidden with this extension. These are diffrent from 
+* default: `[]`
+* example html: `data-multi-toggle-defaults='["column1", "column2"]'`
+
+## Methods
+
+### copyColumnsToClipboard
+
+* copys the contents of the selected rows to the clipboard.
+
+### copyColumnsToClipboardWithHidden
+
+* copys the contents of the selected rows to the clipboard, *including hidden rows*.

src/extensions/multi-column-toggle/multi-column-toggle.js → src/extensions/multi-column-toggle/bootstrap-table-multi-toggle.js


+ 17 - 0
src/extensions/multi-column-toggle/extension.json

@@ -0,0 +1,17 @@
+{
+  "name": "Multi Column Toggle",
+  "version": "1.0.0",
+  "description": "Allows allows hiding and showing of multiple columns at once.",
+  "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/multi-column-toggle",
+  "example": "http://issues.wenzhixin.net.cn/bootstrap-table/#extensions/multi-column-toggle.html",
+
+  "plugins": [{
+    "name": "multi-column-toggle",
+    "url": "https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/multi-column-toggle"
+  }],
+
+  "author": {
+    "name": "Homer Glascock",
+    "image": "https://avatars1.githubusercontent.com/u/5546710"
+  }
+}