diff --git a/README.md b/README.md index 25b2181ef..f091f0897 100644 --- a/README.md +++ b/README.md @@ -45,17 +45,25 @@ http://getbootstrap.com/getting-started/ - 3) Now use the plugin to create a marker like this: ````js -// Creates a red marker with the coffee icon -var redMarker = L.AwesomeMarkers.icon({ - icon: 'coffee', - markerColor: 'red' -}) - -L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); + // Creates a red marker with the coffee icon + var redMarker = L.AwesomeMarkers.icon({ + icon: 'coffee', + markerColor: 'red' + }); + + L.marker([51.941196,4.512291], {icon: redMarker}).addTo(map); ```` +| 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: diff --git a/codekit-config.json b/codekit-config.json index 17391daa6..580c05529 100644 --- a/codekit-config.json +++ b/codekit-config.json @@ -22,16 +22,14 @@ "initialSize" : 535, "fileType" : 8192 }, - "\/dist\/images\/markers-matte.png" : { + "\/examples\/basic-example.html" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/images\/markers-matte.png", - "processed" : 0, - "outputAbbreviatedPath" : "\/dist\/images\/markers-matte.png", - "initialSize" : 14323, - "fileType" : 8192 + "inputAbbreviatedPath" : "\/examples\/basic-example.html", + "outputAbbreviatedPath" : "No Output Path", + "fileType" : 2048 }, "\/dist\/leaflet.awesome-markers.min.js" : { "ignoreWasSetByUser" : 0, @@ -64,6 +62,17 @@ "initialSize" : 218197, "fileType" : 8192 }, + "\/dist\/images\/markers-soft@2x.png" : { + "ignoreWasSetByUser" : 0, + "ignore" : 0, + "hidden" : 0, + "outputPathIsSetByUser" : 0, + "inputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", + "processed" : 0, + "outputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", + "initialSize" : 23106, + "fileType" : 8192 + }, "\/examples\/with-bootstrap.html" : { "ignoreWasSetByUser" : 0, "ignore" : 0, @@ -84,25 +93,16 @@ "initialSize" : 31113, "fileType" : 8192 }, - "\/dist\/leaflet.awesome-markers.js" : { + "\/dist\/images\/markers-matte.png" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.js", - "outputStyle" : 1, - "syntaxCheckerStyle" : 1, - "outputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.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 + "inputAbbreviatedPath" : "\/dist\/images\/markers-matte.png", + "processed" : 0, + "outputAbbreviatedPath" : "\/dist\/images\/markers-matte.png", + "initialSize" : 14323, + "fileType" : 8192 }, "\/dist\/images\/markers-plain.png" : { "ignoreWasSetByUser" : 0, @@ -126,16 +126,16 @@ "initialSize" : 10487, "fileType" : 8192 }, - "\/dist\/images\/markers-soft@2x.png" : { + "\/dist\/leaflet.awesome-markers.js" : { "ignoreWasSetByUser" : 0, "ignore" : 0, "hidden" : 0, "outputPathIsSetByUser" : 0, - "inputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", - "processed" : 0, - "outputAbbreviatedPath" : "\/dist\/images\/markers-soft@2x.png", - "initialSize" : 23106, - "fileType" : 8192 + "inputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.js", + "outputStyle" : 1, + "syntaxCheckerStyle" : 1, + "outputAbbreviatedPath" : "\/dist\/leaflet.awesome-markers.min.js", + "fileType" : 64 }, "\/examples\/random-markers.html" : { "ignoreWasSetByUser" : 0, @@ -157,6 +157,15 @@ "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, @@ -167,15 +176,6 @@ "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" : [