ESH/jquery.sumoselect-master/docs/params.json

{"name":"Jquery.sumoselect","tagline":"A jQuery Single/Multi Select plugin to which can be used on almost any device","body":"jquery.sumoselect\r\n=============\r\n\r\n\r\njquery.sumoselect.js - A cross device Single/Multi Select jQuery Select plugin.\r\n-------------------------------------------------------------------------------\r\n\r\nSumoselect full :  [jquery.sumoselect.js](https://github.com/HemantNegi/jquery.sumoselect/blob/master/jquery.sumoselect.js)\r\n\r\nMinified : [jquery.sumoselect.min.js](https://github.com/HemantNegi/jquery.sumoselect/blob/master/jquery.sumoselect.min.js)\r\n\r\n\r\nA jQuery plugin that progressively enhances an HTML Select Box into a Single/Multiple option dropdown list. The dropdown list can be fully customiseable using siple css properties.\r\nIt can adapt itself according to any deveice, keeping in mind that the User Experience is not broken. \r\n\r\n\r\n**Notable Features**\r\n  \r\n   - Single and Multi select option.\r\n\r\n   - Fully customizable by simple css.\r\n\r\n   - Supports almost all devices (Till now i didnt found one)\r\n\r\n   - Intelligently Renders itself according to the devices.\r\n\r\n   - Renders native Single/Multiple pop up on Android, ios, Windows and other devices.\r\n   \r\n   - Custom postback data format (Multiple select data can be passed either as csv or default select)\r\n\r\n   - Selected, Disabled, and Placeholder Support\r\n\r\n   - Easily extendable to allow developers to create new widgets\r\n\r\n\r\n##Requirements\r\njQuery 1.8.3+ (It is always recommended to use the latest version of jQuery)\r\n\r\n\r\n##Desktop Browser Support\r\nIE8+, Firefox 4+, Chrome, Safari 4+, Opera 11+ (Other browsers may work, but I did not test on them)\r\n\r\n\r\n##Mobile/Tablet Browser Support\r\niOs 3+, Android 2.1+ , Windows Mobile (Other browsers may work, but I did not test on them)\r\n\r\n\r\n##Forking\r\nIf you find that you need a feature that SumoSelect does not currently support, either let me know via the SumoSelect issue tracker, or fork SumoSelect on Github and easily extend SumoSelect to create your own widget!\r\n\r\n##Usage\r\n\r\n*To just go with the default options simply do*\r\n\r\n```javascript\r\n $(document).ready(function () {\r\n            $('.SlectBox').SumoSelect();\r\n     });\r\n```\r\n\r\n*To provide optional settings, simply pass settings object to SumoSelect()*\r\n\r\n```javascript\r\n $(document).ready(function () {\r\n            $('.SlectBox').SumoSelect({placeholder: 'This is a placeholder', csvDispCount: 3 });\r\n        });\r\n```\r\n\r\n**Settings**\r\n\r\nThe following settings are available now:\r\n\r\n-  `placeholder` `(string)`  The palceholder text to be displayed in the rendered select widget (on priority basis). *Maximum priority is given to native placeholder attribute in select tag i.e.  - `<select placeholder=\"this is a placeholder\" />`  - Then the option with disabled and selected attribute i.e. `<option disabled selected value=\"foo\" >`  - Last to to the given placeholder attribute in the settings. *\r\n\r\n- `csvDispCount` `(int)`  The number of items to be displayed in the widget seperated by a `,` after that the text will be warped as *3+ Selected*. Set `0` for all the options.\r\n\r\n- `floatWidth` `(int)` Minimum screen width of device below which the options list is rendered in floating popup fashion.\r\n\r\n- `forceCustomRendering`  `(boolean)` Force the custom modal ( Floating list ) on all devices below floatWidth resolution.\r\n\r\n- `nativeOnDevice`  `(Array[string])` The keywords to identify a mobile device from useragent string. The system default select list is rendered on the matched device.\r\n\r\n- `outputAsCSV` `(boolean)` `true` to POST data as csv ( false for deafault select )\r\n\r\n- `csvSepChar` `(string)`  Seperation char if `outputAsCSV`  is set to `true`\r\n\r\n- `okCancelInMulti` `(boolean)` Displays Ok Cancel buttons in desktop mode multiselect also. \r\n\r\n- `triggerChangeCombined` `(boolean)` In Multiselect mode whether to trigger change event on individual selection of each item or on combined selection ( pressing of OK or Cancel button ).\r\n\r\n\r\n**The default settings are :**\r\n\r\n```javascript\r\n{\r\n    placeholder: 'Select Here',\r\n    csvDispCount: 3,\r\n    floatWidth: 500,\r\n    forceCustomRendering: false,\r\n    nativeOnDevice: ['Android', 'BlackBerry', 'iPhone', 'iPad', 'iPod', 'Opera Mini', 'IEMobile', 'Silk'],\r\n    outputAsCSV : true,\r\n    csvSepChar : ',', \r\n    okCancelInMulti: true, \r\n    triggerChangeCombined : true\r\n}\r\n```\r\n\r\n## License\r\n\r\nCopyright (c) 2014 Hemant Negi Licensed under the MIT license.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}