README

Yii 2 LeafletJs Plugin to create map icons using Font Awesome and GlyphIcon Icons.

This Plugin works in conjunction with LeafLet library for Yii 2 framework, Bootstrap and/or Font Awesome iconic font and css toolkit.

In order to make it work with GlyphIcon (included with Bootstrap) or Font Awesome files you need to add the required files your self.

To swap betwen GlyphIcon (default) and FontAwesome, you just need to modify its prefix. Should work with other Font Toolkits as long as it follows the following class signature: "prefix prefix-iconname".

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require "2amigos/yii2-leaflet-awesome-plugin" "*"

or add

"2amigos/yii2-leaflet-awesome-plugin" : "*"

to the require section of your application's composer.json file.

Usage

// LeafLet initialization component
// ...

// Initialize plugin
$awesomeMarkers = new dosamigos\leaflet\plugins\awesome\AwesomeMarker(['name' => 'awesome']);

// install
$leafLet->installPlugin($awesomeMarkers);

// sample location
$center = new dosamigos\leaflet\types\LatLng(['lat' => 51.508, 'lng' => -0.11]);

// generate icon through its icon
$marker = new dosamigos\leaflet\layers\Marker([
    'latLng' => $center,
    'icon' => $leafLet->plugins->awesome->make("star",['markerColor' => "green", 'prefix' => "fa"]),
    'popupContent' => 'Hey! I am a marker'
]);

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The BSD License (BSD). Please see License File for more information.

Web development has never been so fun!
www.2amigos.us

2amigos / yii2-leaflet-awesome-plugin

Maintainers

Details