Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axyjo/leaflet-rails
This gem provides the leaflet.js map display library for your Rails 5 application.
https://github.com/axyjo/leaflet-rails
Last synced: 2 months ago
JSON representation
This gem provides the leaflet.js map display library for your Rails 5 application.
- Host: GitHub
- URL: https://github.com/axyjo/leaflet-rails
- Owner: axyjo
- License: bsd-2-clause
- Archived: true
- Created: 2012-03-03T20:49:08.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T01:34:25.000Z (6 months ago)
- Last Synced: 2024-10-01T23:38:32.457Z (3 months ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/leaflet-rails
- Size: 20.2 MB
- Stars: 178
- Watchers: 7
- Forks: 71
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-toolbox - leaflet-rails - This gem provides the leaflet.js map display library for your Rails 4 application. (Time & Space / Geocoding & Maps)
README
[](https://travis-ci.org/axyjo/leaflet-rails)
[](http://badge.fury.io/rb/leaflet-rails)
Note: Intent to Deprecate
================
As of 2024-07-14, Rails 5 is long past its EOL. Rails 6+ support alternative Javascript bundling solutions, which work a lot better than this approach does. As such, I intend on marking this project as deprecated on or after 2024-10-01. Any Leaflet upgrades prior to that date will still be honoured.
Quickstart Guide
================
To start using the leaflet-rails gem, follow the steps below (assuming you use the default asset pipeline):
First, add the following code to your `Gemfile`.
```ruby
gem 'leaflet-rails'
```
Then, run `bundle install` from within your project to download the necessary files. Following that, open your application-wide CSS file (`app/assets/stylesheets/application.css`) and add the following line as a comment:
```
= require leaflet
```
After that, open your application-wide Javascript file (typically `app/assets/javascripts/application.js`) and add the following line before requiring files which depend on Leaflet:
```
= require leaflet
```
At this point, you may skip the first two steps of the [Leaflet Quick Start guide](http://leafletjs.com/examples/quick-start/) and start at the third step (adding the map `div` to a view).
Version Parity
==============
`leaflet-rails` keeps version parity with the upstream `leaflet.js` library. Before v0.7.7 the versions were not always in sync, as noted in the table below.
| leaflet-rails | leaflet.js | Reason |
| ------------- | ------------- | ------|
| 0.7.4 | 0.7.3 | Requested in #33 because of large gap between master and rubygems.org.|
| 0.7.5 | 0.7.5 | leaflet.js 0.7.4 was reverted. |
| 0.7.6 | ---- | Skipped to sync with upstream. |
| 0.7.7 | 0.7.7 | Sync version numbers with upstream. |
| 1.9.5 | 1.9.4 | Adding intent to deprecate post-install message. |
Helpers
=======
To get you up and running quickly, you can also use the gem's helper. To get started, add the following lines to a file called `leaflet.rb` in `config/initializers`:
```ruby
Leaflet.tile_layer = "http://{s}.tile.cloudmade.com/YOUR-CLOUDMADE-API-KEY/997/256/{z}/{x}/{y}.png"
# You can also use any other tile layer here if you don't want to use Cloudmade - see http://leafletjs.com/reference.html#tilelayer for more
Leaflet.attribution = "Your attribution statement"
Leaflet.max_zoom = 18
```
If you are using a tile layer which requires non-default subdomains such as [MapQuest-OSM Tiles](http://developer.mapquest.com/web/products/open/map), you can set the subdomains like this:
```ruby
Leaflet.tile_layer = "http://{s}.mqcdn.com/tiles/1.0.0/map/{z}/{x}/{y}.png"
Leaflet.subdomains = ['otile1', 'otile2', 'otile3', 'otile4']
```
You will then be able to call the ```#map``` helper method in a view, and make sure that the helper method is inside an erb tag like so:
```ruby
<%= map(:center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
}) %>
```
You can also add any number of markers like so:
```ruby
map(:center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
},
:markers => [
{
:latlng => [51.52238797921441, -0.08366235665359283],
}
]
)
```
Adding a `:popup` element to a marker hash will also generate a popup for a maker:
```ruby
map(:center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
},
:markers => [
{
:latlng => [51.52238797921441, -0.08366235665359283],
:popup => "Hello!"
}
]
)
```
If you want to override the map settings you have set in the initializer, you can also add them to the helper method:
```ruby
map(:center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
},
:tile_layer => "http://{s}.somedomain.com/somepath/{z}/{x}/{y}.png",
:attribution => "Some other attribution text",
:max_zoom => 4
)
```
If you want to have multiple maps on same page , you should add unique container_id in helper method for each map:
```ruby
map(:container_id => "first_map", :center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
})
map(:container_id => "second_map", :center => {
:latlng => [51.52238797921441, -0.08366235665359283],
:zoom => 18
})
```