Commit 20991f70 authored by Elijah Byrd's avatar Elijah Byrd
Browse files

Minor readme modifications for wrapped library.

parent b5366d0a
Pipeline #16031 skipped
......@@ -8,9 +8,9 @@ The shim currently requires jQuery (referenced as 'jQuery,' most versions should
## Installation
To add the shim to your project:
1. Load accessible_gmaps.js and accessible_gmaps.css into any page containing a Google map. Remember that jQuery is also required.
2. When creating markers or adding new markers to the map, call `accessible_gmaps_addMarker(marker)`, where `marker` is the gMaps marker object.
2. When creating markers or adding new markers to the map, call `accessible_gmaps.addMarker(marker)`, where `marker` is the gMaps marker object.
*Each marker object should have a title property attached. This string is used by base gMaps to provide title text for markers, and is used by the accessibility shim to provide information about the marker to screen readers. Set this property with `marker.title='your title here'`*
3. After your map is loaded and has bounds (usually just before you'd display it to the user), call `accessible_gmaps_onload(map, mapIdentifier, options)` with these parameters:
3. After your map is loaded and has bounds (usually just before you'd display it to the user), call `accessible_gmaps.onload(map, mapIdentifier, options)` with these parameters:
+ `map`: the map object (created with new google.maps.Map())
+ `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:
......
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