Skip to content

ranelpadon/ckeditor-leaflet

Repository files navigation

ckeditor-leaflet

OVERVIEW:
This CKEditor Leaflet Maps plugin has three workhorse files:

  • Plugin Core: Defines the plugin and attaches the plugin to the CKEditor toolbar.
  • Dialog Script: Displays the map options when creating and editing existing maps.
  • Map Renderer: Parses the map options via URL and renders the map accordingly.

This plugin utilizes the following technologies/libraries:

Main features/highlights:

  • Auto-searching of map coordinates using Google Search with Geocoding.
  • 10 available map tiles, featuring OpenStreetMap.
  • Map could include a minimap/overview map for better map context.
  • Map could be responsive (100% width).
  • Map could be customized with the specified width and height dimensions.
  • Map could be aligned to the left or right, or be placed at the center of the page.
  • Map zoom level could be changed using the mouse wheel, zoom buttons, or zoom dialog options.
  • Map zoom level could be customized per map and saved.
  • Marker's popup text could be customized.
  • Marker could be dragged and its last position will be saved.
  • Map re-centers the view on-the-fly as the user drags the marker, for better UX.
  • Supports both http and https protocols.
  • Supports English, Russian, and Basque languages/translations
  • Bundles a stand-alone demo page that fetches the CDN-hosted CKEditor files (including the dependencies and languages). It also includes a handy language switcher for demonstrating the various translations of the plugin.

LIVE DEMO PAGE:
Demo page could be found here. It is comprehensive and showcases the various translations and map options, including the draggable marker, customizable pop-up text, and responsive behavior (see the bottom map example in the demo).

PROJECTS INTEGRATING THIS PLUGIN:

INSTALLATION:
Kindly refer to Installation Guide.

HOW TO USE:
Kindly refer to How to Create and Edit Leaflet Maps.

CHANGELOG:
Kindly refer to the Release Notes.

ROAD MAP (Planned stuff to do):

  • IFRAME-less implementation for faster rendering in pages with lots of maps.
  • Render widget only on demand or as the page scrolls for optimal page performance.
  • Integration with Inline/In-Place Editing.
  • Option to show the cursor's map coordinates and scale bar.
  • State of the panned map's view must be saved.
  • Ability to add map caption/annotation
  • Display the map preview in the Dialog window.
  • Handle multiple markers.
  • Add and delete markers.
  • Has option to add Panoromio (panoramio.com) layer.
  • Add other tile providers.
  • R&D other Leaflet plugins that might be useful.

LICENSE and CREDITS:

License: LGPLv2.1 or later should apply. Note that LGPLv2.1+ is also compatible with GPLv2.
Copyright 2016 by Engr. Ranel O. Padon
ranel.padon@gmail.com

Plugin's icon is a property of simpleicon. As indicated in their website, use of their icon is allowed as long as it includes proper credit and backlink.

Thanks to CKEditor, Leaflet, and other great open-source softwares and their unsung developers.

Special thanks also to the insights, guidance, and collaborative support of our CNN Travel team:
Senior Web Development Manager:
Brent A. Deverman

Senior Software Engineer:
Adrian Christopher B. Cruz

Senior QA Analyst:
Jonathan A. Jacinto

=======================================================

About

Leaflet Maps Plugin for CKEditor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published