Commit 97020b9e authored by Elijah Byrd's avatar Elijah Byrd
Browse files

Added known issues to readme.md

parent 20991f70
Pipeline #16269 skipped
......@@ -15,4 +15,16 @@ To add the shim to your project:
+ `mapIdentifier`: a CSS identifier unique to your map, used by jQuery to add the shim elements.
+ `options`: an array of settings for the shim. Current options are:
+ `infowindows`: if set to TRUE, will create keyboard-accessible infowindows attached to map markers.
*This option expects each marker object to have a windowContent property, which contains an HTML string to use as the infowindow content (minus the window header, which is automatically generated from the marker's title attribute). Set this property with `marker.windowContent='your content here'`*
\ No newline at end of file
*This option expects each marker object to have a windowContent property, which contains an HTML string to use as the infowindow content (minus the window header, which is automatically generated from the marker's title attribute). Set this property with `marker.windowContent='your content here'`*
## Known issues:
+ The shim has some serious performance impact on maps with lots of markers. Repositioning all of the overlay divs is time-intensive - this needs to be optimized.
+ The marker overlays have some drawbacks over traditional mouse navigation:
+ They capture scroll wheel input to scroll the whole page, rather than zoom the map, when they're in hover.
+ It can be very difficult to select markers that are hidden behind other markers.
+ They aren't dynamically sized to the marker's size, so they're unwieldy if your markers are nonstandard.
+ There's no way to add new markers to the map after the onload function is called.
+ You can only remove markers by setting them as invisible; actually removing them from the map will break the shim.
+ Any infowindows that exist on the page other than the one created by this map (including in other maps on the page) might break the map.
+ There's no way to have two accessible maps on the same page.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment