Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgravois/esri-leaflet-about
a small utility to add descriptive text to your leaflet map
https://github.com/jgravois/esri-leaflet-about
Last synced: about 12 hours ago
JSON representation
a small utility to add descriptive text to your leaflet map
- Host: GitHub
- URL: https://github.com/jgravois/esri-leaflet-about
- Owner: jgravois
- License: apache-2.0
- Created: 2015-01-10T01:31:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-24T18:55:40.000Z (over 9 years ago)
- Last Synced: 2024-04-13T03:38:42.497Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 297 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Esri Leaflet About
The Esri Leaflet About is a small API helper to add contextual HTML to Leaflet apps.
**Currently Esri Leaflet About is in development and should be thought of as a beta or preview**
Esri Leaflet About doesn't rely on the minimal Esri Leaflet Core, but its still a cool project that you can find out more about on the [Esri Leaflet downloads page](http://esri.github.com/esri-leaflet/downloads).
## Example
```html
Esri Leaflet About
#map {
position: fixed;
top: 0;
bottom: 0;
left: 0;
right: 0;
}
var map = L.map('map').setView([37.74, -121.62], 9);
var tiles = L.esri.basemapLayer('Topographic').addTo(map);
var questionMark = new L.esri.About({message:'<h1>this is important!</h1>'});
questionMark.addTo(map);
```
## L.esri.About
### Constructor
**Extends** [`L.Control`](http://leafletjs.com/reference.html#control)
Constructor | Options | Description
--- | --- | ---
`new L.esri.About(options)`
`L.esri.about(options)` | [``](#options) | Creates a new About control.
### Options
Option | Type | Default | Description
--- | --- | --- | ---
`position` | `String` | `topleft` | One of the valid Leaflet [control positions](http://leafletjs.com/reference.html#control-positions).
`collapseAfterResult` | `Boolean` | `true` | If the geocoder is expanded after a result this will collapse it.
`expanded` | `Boolean` | `true` | Start the control in an expanded state.
`message` | `String` | `
maps are cool.
` | HTML to be displayed when the control is expanded.
`title` | `String` | `Location Search` | Title text for the search input. Shows as tool tip on hover.
### Styling
For reference here is the internal structure of the about control...
```html
this needs tweaked.
```
## Development Instructions
1. [Fork and clone Esri Leaflet Geocoder](https://help.github.com/articles/fork-a-repo)
2. `cd` into the `esri-leaflet-geocoder` folder
5. Install the dependencies with `npm install`
5. The example at `/index.html` should work
6. Make your changes and create a [pull request](https://help.github.com/articles/creating-a-pull-request)
## Dependencies
Esri Leaflet About doesn't rely on the minimal Esri Leaflet Core, but its still a cool project that you can find out more about on the [Esri Leaflet downloads page](http://esri.github.com/esri-leaflet/downloads).
## Resources
* [ArcGIS for Developers](http://developers.arcgis.com)
* [ArcGIS REST Services](http://resources.arcgis.com/en/help/arcgis-rest-api/)
* [twitter@esri](http://twitter.com/esri)
## Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue.
## Contributing
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).
## Terms and Conditions
i don't think there are any.
## Licensing
Copyright 2015 Esri
question mark image found [here](http://icons8.com/)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
> http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
A copy of the license is available in the repository's [license.txt]( https://raw.github.com/Esri/esri-leaflet-geocoder/master/license.txt) file.
[](Esri Tags: ArcGIS Web Mapping Leaflet)
[](Esri Language: JavaScript)