From 8968d75c7d96c52b1f8b3434e6b0e13205091890 Mon Sep 17 00:00:00 2001 From: Jeff Sagal Date: Wed, 9 Mar 2016 15:41:12 -0800 Subject: [PATCH] more doc work --- README.md | 2 +- dist/build.js | 2 +- src/App.vue | 15 +++++++++++---- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1a8588e..628a877 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ export default { - `value` Represents the currently selected value(s). Can be `null`, an empty string, or `[]`. If `multiple` is true, the current value will be represented in an array, otherwise it will be a single string or object, depending on what you've passed for `options`. - twoway: true, - required: true -- `options` Any array of strings or objects to be used as dropdown choices. Supports `['foo','bar']` & `[{label: 'Foo', value: 'foo'}]`. When using the `[{}]` syntax, the objects in the array can have as many properties as you need, as long as the object contains `value` and `label` keys. +- `options` An array of strings or objects to be used as dropdown choices. Supports `['foo','bar']` & `[{label: 'Foo', value: 'foo'}]`. When using the `[{}]` syntax, the objects in the array can have as many properties as you need, as long as the object contains `value` and `label` keys. - type: `Array` - default: `[]` - `maxHeight` Limit the height of the dropdown menu. diff --git a/dist/build.js b/dist/build.js index 2e2e4fc..fbde703 100644 --- a/dist/build.js +++ b/dist/build.js @@ -10250,7 +10250,7 @@ exports.default = { } }; if (module.exports.__esModule) module.exports = module.exports.default -;(typeof module.exports === "function"? module.exports.options: module.exports).template = "

Vue Select

A simple component that provides similar functionality to Select2 without the overhead of jQuery.

View on GitHub
{{ select | json }}

Live Edit play around with the above vue-select



The options property is watched for changes, and the value is reset anytime the options change. This is useful if you have multiple selection boxes that depend on its ancestors values.
Equivalent to the multiple attribute to a <select>. You'll want to clear any selections you have made before changing this option. It's not one that should be changed after render.
Limit the height of the dropdown menu.
Equivalent to the placeholder attribute.

Install & Usage

Install from GitHub using NPM
  <template>\n    <div id=\"myApp\">\n      <v-select :value.sync=\"selected\" :options=\"options\"></v-select>\n    </div>\n  </template>\n\n  <script>\n    import vSelect from 'vue-select'\n    export default {\n      components: {vSelect},\n\n      data() {\n        return {\n          selected: null,\n          options: ['foo','bar','baz']\n        }\n      }\n    }\n  </script>\n

Parameters

  • value Represents the currently selected value(s)
    • type: String
    • required: true
  • maxHeight Limit the height of the dropdown menu
    • type: String
    • default: '400px'
  • searchable Toggle filtering of options
    • type: Boolean
    • default: true
  • multiple Equivalent to multiple attribute on a <select>
    • type: Boolean
    • default: true
  • placeholder Equivalent to placeholder attribute on an <input>
    • type: String
    • default: ''
  • transition Vue transition prop applied to the .dropdown-menu
    • type: Boolean
    • default: true
" +;(typeof module.exports === "function"? module.exports.options: module.exports).template = "

Vue Select

A simple component that provides similar functionality to Select2 without the overhead of jQuery.

View on GitHub
{{ select | json }}

Live Edit play around with the above vue-select



The options property is watched for changes, and the value is reset anytime the options change. This is useful if you have multiple selection boxes that depend on its ancestors values.
Equivalent to the multiple attribute to a <select>. You'll want to clear any selections you have made before changing this option. It's not one that should be changed after render.
Limit the height of the dropdown menu.
Equivalent to the placeholder attribute.

Install & Usage

Install from GitHub using NPM
  <template>\n    <div id=\"myApp\">\n      <v-select :value.sync=\"selected\" :options=\"options\"></v-select>\n    </div>\n  </template>\n\n  <script>\n    import vSelect from 'vue-select'\n    export default {\n      components: {vSelect},\n\n      data() {\n        return {\n          selected: null,\n          options: ['foo','bar','baz']\n        }\n      }\n    }\n  </script>\n

Parameters

  • value Represents the currently selected value(s)
    • type: String
    • required: true
  • options An array of strings or objects to be used as dropdown choices. Supports ['foo','bar'] & [{label: 'Foo', value: 'foo'}]. When using the [{}] syntax, the objects in the array can have as many properties as you need, as long as the object contains value and label keys.
    • type: Array
    • default: []
  • maxHeight Limit the height of the dropdown menu
    • type: String
    • default: '400px'
  • searchable Toggle filtering of options
    • type: Boolean
    • default: true
  • multiple Equivalent to multiple attribute on a <select>
    • type: Boolean
    • default: true
  • placeholder Equivalent to placeholder attribute on an <input>
    • type: String
    • default: ''
  • transition Vue transition prop applied to the .dropdown-menu
    • type: Boolean
    • default: true
" },{"./components/Select.vue":36,"./countries.js":37,"./simpleCountries.js":39,"vue":33,"vueify-insert-css":34}],36:[function(require,module,exports){ var __vueify_style__ = require("vueify-insert-css").insert(".dropdown[_v-3d450ab6]{position:relative}.dropdown-toggle[_v-3d450ab6]{display:block;padding:0;background:none;border:1px solid rgba(60,60,60,.26)}.dropdown-toggle[_v-3d450ab6]:active,.dropdown-toggle[_v-3d450ab6]:focus,.dropdown-toggle[_v-3d450ab6]:hover,.open .dropdown-toggle[_v-3d450ab6]:active,.open .dropdown-toggle[_v-3d450ab6]:focus,.open .dropdown-toggle[_v-3d450ab6]:hover{background:none}.open .dropdown-toggle[_v-3d450ab6]{background:none;border-color:#337ab7;border-bottom:none;border-bottom-left-radius:0;border-bottom-right-radius:0}.dropdown-menu[_v-3d450ab6]{margin:0;width:100%;overflow-y:scroll;border-top:none;border-color:#337ab7;border-top-left-radius:0;border-top-right-radius:0}.alert[_v-3d450ab6]{margin:0;margin-left:6px;padding:.25em}.alert .close[_v-3d450ab6]{float:none;margin-right:0;font-size:20px}input[type=search][_v-3d450ab6]{display:inline-block;border:none;outline:none;margin:0;width:100%;background:none;position:relative;box-shadow:none}input[type=search][_v-3d450ab6]:focus{box-shadow:none}input[type=search].inline[_v-3d450ab6]{width:auto}.dropdown-toggle[_v-3d450ab6]:after{display:block;position:absolute;top:10px;right:10px;display:inline-block;font-family:Glyphicons Halflings;font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;content:\"\\e114\";-webkit-transition:all .15s cubic-bezier(1,-.115,.975,.855);transition:all .15s cubic-bezier(1,-.115,.975,.855);-webkit-transition-timing-function:cubic-bezier(1,-.115,.975,.855);transition-timing-function:cubic-bezier(1,-.115,.975,.855)}.open .dropdown-toggle[_v-3d450ab6]:after{-webkit-transform:rotate(180deg);transform:rotate(180deg)}.form-control[_v-3d450ab6]{border:none}li a[_v-3d450ab6]{cursor:pointer}.active a[_v-3d450ab6]{background:rgba(50,50,50,.1);color:#333}.highlight a[_v-3d450ab6],li:hover a[_v-3d450ab6]{background:#337ab7;color:#fff}") diff --git a/src/App.vue b/src/App.vue index ff4545e..9d85b6b 100644 --- a/src/App.vue +++ b/src/App.vue @@ -88,12 +88,12 @@

The options property is watched for changes, and the value is reset anytime the options change. This is useful if you have multiple selection boxes that depend on its ancestors values. @@ -139,7 +139,7 @@

Install & Usage

Install from GitHub using NPM
- + 
   <template>
       <div id="myApp">
@@ -173,6 +173,14 @@
             
           
 
+          
  • 
+            options An array of strings or objects to be used as dropdown choices. Supports ['foo','bar'] & [{label: 'Foo', value: 'foo'}]. When using the [{}] syntax, the objects in the array can have as many properties as you need, as long as the object contains value and label keys.
+            
      
+              
    • type: Array
      • 
+              
    • default: []
      • 
+            
    
+          
    • 
+
             
  • 
               maxHeight Limit the height of the dropdown menu
               
      
@@ -212,7 +220,6 @@
                 
    • default: true
      • 
               
    
             
    • 
-