diff --git a/README.md b/README.md index cfe73735b..0ce4a1dc3 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ For Twitter bootstrap: For Twitter bootstrap, steps are here: - http://twitter.github.io/bootstrap/getting-started.html + http://getbootstrap.com/getting-started/ - 2) Next, copy the dist/images directory, awesome-markers.css, and awesome-markers.js to your project and include them: @@ -47,28 +47,22 @@ For Twitter bootstrap: ````js // Creates a red marker with the coffee icon var redMarker = L.AwesomeMarkers.icon({ - icon: 'coffee', - markerColor: 'red' + icon: 'coffee', + prefix: 'fa', // Use "fa" for the font-awesome icons. Use "glyphicon" for the glyphicons from bootstrap 3. + markerColor: 'red', + iconColor: 'white' }) - - L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); +L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); ```` -### Supported marker colors: -**The following colors are supported** - -The 'markerColor' property currently supports these strings: -- 'red' -- 'darkred' -- 'orange' -- 'green' -- 'darkgreen' -- 'blue' -- 'darkblue' -- 'purple' -- 'darkpurple' -- 'cadetblue' +| Property | Description | Default Value | Possible values | +| --------------- | ---------------------- | ------------- | ---------------------------------------------------- | +| icon | Name of the icon | 'home' | See glyphicons or font-awesome | +| prefix | Select de icon library | 'glyphicon' | 'fa' for font-awesome or 'glyphicon' for bootstrap 3 | +| markerColor | Color of the marker | 'blue' | 'red', 'darkred', 'orange', 'green', 'darkgreen', 'blue', 'purple', 'darkpuple', 'cadetblue' | +| iconColor | Color of the icon | 'white' | 'white', 'black' or css code (hex, rgba etc) | +| spin | Make the icon spin | false | true or false. Font-awesome required | ### Supported icons The 'icon' property supports these strings: @@ -77,26 +71,13 @@ The 'icon' property supports these strings: - 'flag' - 'star' - 'bookmark' -- .... and many more, see: http://fortawesome.github.com/Font-Awesome/#icons-new -- Or: http://twitter.github.com/bootstrap/base-css.html#icons - -### Spinning icons (only Font-Awesome) -You can make any icon spin by setting the spin option to true: -````js -// Creates a red marker with the coffee icon -var redMarker = L.AwesomeMarkers.icon({ - icon: 'spinner', - markerColor: 'red', - spin: true -}) - -L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); -```` +- .... and many more, see: http://fortawesome.github.io/Font-Awesome/icons/ +- Or: http://getbootstrap.com/components/#glyphicons ## License - Leaflet.AwesomeMarkers and colored markers are licensed under the MIT License - http://opensource.org/licenses/mit-license.html. -- Font Awesome: http://fortawesome.github.com/Font-Awesome/#license -- Twitter Bootstrap: http://twitter.github.com/bootstrap/ +- Font Awesome: http://fortawesome.github.io/Font-Awesome/license/ +- Twitter Bootstrap: http://getbootstrap.com/ ## Contact - Email: lvoogdt@gmail.com diff --git a/codekit-config.json b/codekit-config.json index 692023266..17391daa6 100644 --- a/codekit-config.json +++ b/codekit-config.json @@ -44,15 +44,6 @@ "outputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.min.min.js", "fileType" : 64 }, - "\/examples\/basic-example.html" : { - "ignoreWasSetByUser" : 0, - "ignore" : 0, - "hidden" : 0, - "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/examples\/basic-example.html", - "outputAbbreviatedPath" : "No Output Path", - "fileType" : 2048 - }, "\/examples\/css\/font-awesome.min.css" : { "ignoreWasSetByUser" : 0, "ignore" : 0, @@ -62,15 +53,35 @@ "outputAbbreviatedPath" : "No Output Path", "fileType" : 16 }, - "\/dist\/images\/markers-soft@2x.png" : { + "\/screenshots\/screenshot-soft.png" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", + "inputAbbreviatedPath" : "\/screenshots\/screenshot-soft.png", "processed" : 0, - "outputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", - "initialSize" : 23106, + "outputAbbreviatedPath" : "\/screenshots\/screenshot-soft.png", + "initialSize" : 218197, + "fileType" : 8192 + }, + "\/examples\/with-bootstrap.html" : { + "ignoreWasSetByUser" : 0, + "ignore" : 0, + "hidden" : 0, + "outputPathIsSetByUser" : 0, + "inputAbbreviatedPath" : "\/examples\/with-bootstrap.html", + "outputAbbreviatedPath" : "No Output Path", + "fileType" : 2048 + }, + "\/dist\/images\/markers-matte@2x.png" : { + "ignoreWasSetByUser" : 0, + "ignore" : 0, + "hidden" : 0, + "outputPathIsSetByUser" : 0, + "inputAbbreviatedPath" : "\/dist\/images\/markers-matte@2x.png", + "processed" : 0, + "outputAbbreviatedPath" : "\/dist\/images\/markers-matte@2x.png", + "initialSize" : 31113, "fileType" : 8192 }, "\/dist\/leaflet.awesome-markers.js" : { @@ -84,26 +95,24 @@ "outputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.min.js", "fileType" : 64 }, - "\/dist\/images\/markers-matte@2x.png" : { + "\/examples\/basic-example.html" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/images\/markers-matte@2x.png", - "processed" : 0, - "outputAbbreviatedPath" : "\/dist\/images\/markers-matte@2x.png", - "initialSize" : 31113, - "fileType" : 8192 + "inputAbbreviatedPath" : "\/examples\/basic-example.html", + "outputAbbreviatedPath" : "No Output Path", + "fileType" : 2048 }, - "\/screenshots\/screenshot-soft.png" : { + "\/dist\/images\/markers-plain.png" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/screenshots\/screenshot-soft.png", + "inputAbbreviatedPath" : "\/dist\/images\/markers-plain.png", "processed" : 0, - "outputAbbreviatedPath" : "\/screenshots\/screenshot-soft.png", - "initialSize" : 218197, + "outputAbbreviatedPath" : "\/dist\/images\/markers-plain.png", + "initialSize" : 7946, "fileType" : 8192 }, "\/dist\/images\/markers-soft.png" : { @@ -117,24 +126,15 @@ "initialSize" : 10487, "fileType" : 8192 }, - "\/examples\/with-bootstrap.html" : { + "\/dist\/images\/markers-soft@2x.png" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/examples\/with-bootstrap.html", - "outputAbbreviatedPath" : "No Output Path", - "fileType" : 2048 - }, - "\/dist\/images\/markers-plain.png" : { - "ignoreWasSetByUser" : 0, - "ignore" : 0, - "hidden" : 0, - "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/images\/markers-plain.png", + "inputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", "processed" : 0, - "outputAbbreviatedPath" : "\/dist\/images\/markers-plain.png", - "initialSize" : 7946, + "outputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", + "initialSize" : 23106, "fileType" : 8192 }, "\/examples\/random-markers.html" : { @@ -157,15 +157,6 @@ "initialSize" : 197696, "fileType" : 8192 }, - "\/dist\/leaflet.awesome-markers.css" : { - "ignoreWasSetByUser" : 0, - "ignore" : 0, - "hidden" : 0, - "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.css", - "outputAbbreviatedPath" : "No Output Path", - "fileType" : 16 - }, "\/dist\/images\/markers-shadow@2x.png" : { "ignoreWasSetByUser" : 0, "ignore" : 0, @@ -176,6 +167,15 @@ "outputAbbreviatedPath" : "\/dist\/images\/markers-shadow@2x.png", "initialSize" : 1469, "fileType" : 8192 + }, + "\/dist\/leaflet.awesome-markers.css" : { + "ignoreWasSetByUser" : 0, + "ignore" : 0, + "hidden" : 0, + "outputPathIsSetByUser" : 0, + "inputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.css", + "outputAbbreviatedPath" : "No Output Path", + "fileType" : 16 } }, "manualImportLinks" : [