diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 60e7665..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2016 Greg Allensworth - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 14b79e4..0000000 --- a/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# L.Control.JQueryDialog - -A simple Leaflet control to open a jQuery UI dialog. - -Popupo dialogs, especially modal ones, are great for help panels, or for feedback forms, or for displaying a legend that doesn't need to take up screen space all the time. And if you want a Leaflet-styled button on your map, which would trigger this dialog... here's the plugin for you. - -# Usage - -For a quick start, see the *example* folder, or the live demo: http://gregallensworth.github.io/L.Control.jQueryDialog/ - -Assuming that you already have already have a Leaflet map running and a jQuery UI Dialog set up, the control runs like this: - -``` -new L.Control.jQueryDialog({ - dialogId: 'dialog-help', - tooltip: "How to use this thing", - iconClass: 'fa fa-question-circle' -}).addTo(MAP); -``` - -Parameters are: - -* **dialogId** -- The DOM ID of the DIV element, e.g. what you put inside the id="" part. **Required** - -* **tooltip** -- A tooltip to be displayed when the user hovers their mouse over the button. **Optional** - -* **iconClass** -- Additional CSS class/classesfor adding an icon. jQuery UI doesn't come with a built-in set of icons, so you have to supply your own. Example if you use FontAwesome: *fa fa-info-circle* - -# Icons and iconClass - -jQuery UI doesn't come with a built-in set of icons, so you have to supply your own. Some very popular icon sets are: - -* **FontAwesome** https://fortawesome.github.io/Font-Awesome/icons/ -- Your *iconClass* would include the *fa-* bits, for example: *fa fa-question-circle* - -* **Bootstrap Glyphicons** http://getbootstrap.com/components/#glyphicons -- Your *iconClass* would include the *glyphicon-* bits, for example: *glyphicon glyphicon-search* diff --git a/example/index.html b/index.html similarity index 92% rename from example/index.html rename to index.html index 528d8fb..24a7a7b 100644 --- a/example/index.html +++ b/index.html @@ -23,8 +23,8 @@ - - + +