Skip to content

Commit b84d33c

Browse files
committed
clarify and correct documentation
1 parent 2cd9033 commit b84d33c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,16 @@ Now use the plugin to create a marker like this:
5454
5555
### Properties
5656
57-
| Property | Description | Default Value | Possible values |
58-
| --------------- | ----------------------------------------- | ------------- | ---------------------------------------------------- |
59-
| extraClasses | Additional classes in the created <i> tag | '' | 'fa-rotate90 myclass'; space delimited classes to add |
60-
| icon | Name of the icon WITH prefix | 'fa-home' | see glyphicons or font-awesome (without prefix) |
61-
| iconColor | Color of the icon | 'white' | 'white', 'black' or css code (hex, rgba etc) |
62-
| innerHTML | own HTML code | '' | '<svg>', images, or other HTML; a truthy assignment will override the default html icon creation behavior |
63-
| markerColor | Color of the marker | 'blue' | 'red', 'orange-dark', 'orange', 'yellow', 'blue-dark', 'cyan', 'purple', 'violet', 'pink', 'green-dark', 'green', 'green-light', 'black', or 'white' |
64-
| number | Add a text number to the icon | '' | '1' or 'A', must use icon fa-number |
65-
| prefix | Select de icon library | 'glyphicon' | 'fa' for font-awesome or 'glyphicon' for bootstrap 3 |
66-
| shape | Shape of the marker | 'circle' | 'circle', 'square', 'star', or 'penta' |
57+
| Property | Description | Default Value | Possible values |
58+
| --------------- | ------------------------------------------- | ------------- | ---------------------------------------------------- |
59+
| extraClasses | Additional classes in the created `<i>` tag | `''` | `fa-rotate90 myclass`; space delimited classes to add |
60+
| icon | Name of the icon **with** prefix | `''` | `fa-coffee` see glyphicons or font-awesome |
61+
| iconColor | Color of the icon | `'white'` | `'white'`, `'black'` or css code (hex, rgba etc) |
62+
| innerHTML | Custom HTML code | `''` | `<svg>`, images, or other HTML; a truthy assignment will override the default html icon creation behavior |
63+
| markerColor | Color of the marker (css class) | `'blue'` | `'red'`, `'orange-dark'`, `'orange'`, `'yellow'`, `'blue-dark'`, `'cyan'`, `'purple'`, `'violet'`, `'pink'`, `'green-dark'`, `'green'`, `'green-light'`, `'black'`, or `'white'` |
64+
| number | Instead of an icon, add plain text | `''` | `'1'` or `'A'`, must use icon fa-number |
65+
| prefix | Select the icon library | `'glyphicon'` | `fa` for font-awesome or 'glyphicon' for bootstrap 3 |
66+
| shape | Shape of the marker (css class) | `'circle'` | `'circle'`, `'square'`, `'star'`, or `'penta'` |
6767
6868
## License
6969
- Leaflet.ExtraMarkers and colored markers are licensed under the MIT License - http://opensource.org/licenses/mit-license.html.

0 commit comments

Comments
 (0)