Filament V3 Map Picker

A custom field for Filament that allows you to effortlessly select a location on a map and retrieve geographical coordinates.

Introduction

Map Picker is a Filament custom field designed to simplify the process of choosing a location on a map and obtaining its geo-coordinates.

• Features include:

  • A Field for Filament-v3 with OpenStreetMap Integration
  • Receive Real-time Coordinates Upon Marker Movement Completion
  • Tailor Controls and Marker Appearance to Your Preferences
  • GeoMan Integration for Advanced Map Editing Capabilities

• Latest versions of PHP and Filament

• Best practices applied:

  • README.md (badges included)
  • LICENSE
  • composer.json
  • .gitignore
  • pint.json

GeoMan Integration

This package now includes integration with GeoMan, a powerful tool for creating and editing geometries on maps. GeoMan allows users to draw various shapes, edit existing geometries, and perform advanced map editing tasks.

GeoMan Features:

• Draw markers, polygons, polylines, and circles
• Edit existing geometries
• Cut polygons
• Rotate shapes
• Drag mode for easy shape manipulation
• Delete layers

Supported Maps

Map Picker currently supports the following map:

1. Open Street Map (OSM)

Additional map options will be added to the package as needed and tested.

Installation

You can easily install the package via Composer:

composer require dotswan/filament-map-picker

Basic Usage

Resource file:

<?php
namespace App\Filament\Resources;
use Filament\Resources\Resource;
use Filament\Resources\Forms\Form;
use Dotswan\MapPicker\Fields\Map;
...

class FilamentResource extends Resource
{
    ...
    public static function form(Form $form)
    {
        return $form->schema([
            Map::make('location')
                ->label('Location')
                ->columnSpanFull()
                // Basic Configuration
                ->defaultLocation(latitude: 40.4168, longitude: -3.7038)
                ->draggable(true)
                ->clickable(true) // click to move marker
                ->zoom(15)
                ->minZoom(0)
                ->maxZoom(28)
                ->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png")
                ->detectRetina(true)
                
                // Marker Configuration
                ->showMarker(true)
                ->markerColor("#3b82f6")
                ->markerHtml('<div class="custom-marker">...</div>')
                ->markerIconUrl('/path/to/marker.png')
                ->markerIconSize([36, 36])
                ->markerIconClassName('my-marker-class')
                ->markerIconAnchor([18, 36])
                
                // Controls
                ->showFullscreenControl(true)
                ->showZoomControl(true)
                
                // Location Features
                ->liveLocation(true, true, 5000)
                ->showMyLocationButton(true)
                ->boundaries(true, 49.5, -11, 61, 2) // Example for British Isles
                ->rangeSelectField('distance')
                
                // GeoMan Integration
                ->geoMan(true)
                ->geoManEditable(true)
                ->geoManPosition('topleft')
                ->drawCircleMarker(true)
                ->rotateMode(true)
                ->drawMarker(true)
                ->drawPolygon(true)
                ->drawPolyline(true)
                ->drawCircle(true)
                ->drawRectangle(true)
                ->drawText(true)
                ->dragMode(true)
                ->cutPolygon(true)
                ->editPolygon(true)
                ->deleteLayer(true)
                ->setColor('#3388ff')
                ->setFilledColor('#cad9ec')
                ->snappable(true, 20)
                
                // Extra Customization
                ->extraStyles([
                    'min-height: 150vh',
                    'border-radius: 50px'
                ])
                ->extraControl(['customControl' => true])
                ->extraTileControl(['customTileOption' => 'value'])
                
                // State Management
                ->afterStateUpdated(function (Set $set, ?array $state): void {
                    $set('latitude', $state['lat']);
                    $set('longitude', $state['lng']);
                    $set('geojson', json_encode($state['geojson']));
                })
                ->afterStateHydrated(function ($state, $record, Set $set): void {
                    $set('location', [
                        'lat' => $record->latitude,
                        'lng' => $record->longitude,
                        'geojson' => json_decode(strip_tags($record->description))
                    ]);
                })
        ]);
    }
    ...
}

If you wish to update the map location and marker either through an action or after altering other input values, you can trigger a refresh of the map using the following approach:

use Filament\Forms\Components\Actions\Action;
use Filament\Forms\Components\Actions;
use Filament\Support\Enums\VerticalAlignment;

Actions::make([
    Action::make('Set Default Location')
        ->icon('heroicon-m-map-pin')
        ->action(function (Set $set, $state, $livewire): void {
            $set('location', ['lat' => '52.35510989541003', 'lng' => '4.883422851562501']);
            $set('latitude', '52.35510989541003');
            $set('longitude', '4.883422851562501');
            $livewire->dispatch('refreshMap');
        })
])->verticalAlignment(VerticalAlignment::Start);

clickable Option

This will allow you to set the point on the map with a click. Default behaviour has the marker centered as the map is dragged underneath. You could, with this, keep the map still and lock the zoom and choose to click to place the marker.

Map::make('location')
  ->defaultLocation(latitude: 40.4168, longitude: -3.7038)
  ->showMarker(true)
  ->clickable(true)
  ->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png")
  ->zoom(12)

rangeSelectField Option

The rangeSelectField Option allows you to specify another field on your form which specifies a range from the point identified by the marker. That field must be in meters. So for example you could do this:

Fieldset::make('Location')
    ->schema([
        Select::make('membership_distance')
            ->enum(MembershipDistance::class)
            ->options(MembershipDistance::class)
            ->required(),

        Map::make('location')
            ->defaultLocation(latitude: 40.4168, longitude: -3.7038)
            ->showMarker(true)
            ->showFullscreenControl(false)
            ->showZoomControl()
            ->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png")
            ->zoom(12)
            ->detectRetina()
            ->rangeSelectField('membership_distance')
            ->setFilledColor('#cad9ec'),
    ])
    ->columns(1),

In this case, as you change the value on the Select a circle of that radius centered on the marker will change to match your drop down.

liveLocation Option

The liveLocation method accepts three parameters:

1. bool $send: Determines if the user's live location should be sent.
2. bool $realtime: Controls whether the live location should be sent to the server periodically.
3. int $milliseconds: Sets the interval (in milliseconds) at which the user's location is updated and sent to the server.

Example:

Map::make('location')
    ->liveLocation(true, true, 10000)  // Updates live location every 10 seconds
    ->showMarker()
    ->draggable()

boundaries Option

The idea here is that you can set a boundary box by defining two points, the southwest most point and the north east most point, and your map will pan back into the panned area if you drag away, such that the points can only be selected if you stay in the map.

You will want to set the minZoom() along with this if you set showZoomControl(true). To choose a good value for minZoom() you will need to consider both the size of the map on the screen and the size of the bounding boxm, and you may find trial and error is the best method.

Map::make('location')
    ->showMarker()
    ->boundaries(true,49,11.1,61.0,2.1)
    ->draggable()

To turn it off again - possibly a strange use case - boundaries(false) is what you want.

setBoundsToBritishIsles Option

This is a convenience function that uses the boundaries option above, setting the boundary box to (49.5,-11) and (61,2)

Options Table

Here's a table describing all available options and their default values:

Option	Description	Default Value
statePath	Path to the state	''
draggable	Allow map dragging	true
showMarker	Display marker on the map	true
tilesUrl	URL for map tiles	'http://tile.openstreetmap.org/{z}/{x}/{y}.png'
attribution	Map attribution text	null
zoomOffset	Zoom offset	-1
tileSize	Tile size	512
detectRetina	Detect and use retina tiles	true
rangeSelectField	Field name for range selection	'distance'
minZoom	Minimum zoom level	0
maxZoom	Maximum zoom level	28
zoom	Default zoom level	15
clickable	Allow clicking to place marker	false
markerColor	Color of the marker	'#3b82f6'
liveLocation	Enable live location updates	false
bounds	Enable map boundaries	false
showMyLocationButton	Show "My Location" button settings	[false, false, 5000]
default	Default location coordinates	['lat' => 0, 'lng' => 0]
markerHtml	Custom HTML for marker	''
markerIconUrl	URL for custom marker icon	null
markerIconSize	Size of marker icon	[36, 36]
markerIconClassName	CSS class for marker icon	''
markerIconAnchor	Anchor point for marker icon	[18, 36]
geoMan.show	Enable GeoMan	false
geoMan.editable	Allow editing with GeoMan	true
geoMan.position	Position of GeoMan controls	'topleft'
geoMan.drawCircleMarker	Allow drawing circle markers	true
geoMan.rotateMode	Enable rotate mode	true
geoMan.drawMarker	Allow drawing markers	true
geoMan.drawPolygon	Allow drawing polygons	true
geoMan.drawPolyline	Allow drawing polylines	true
geoMan.drawCircle	Allow drawing circles	true
geoMan.dragMode	Enable drag mode	true
geoMan.cutPolygon	Allow cutting polygons	true
geoMan.editPolygon	Allow editing polygons	true
geoMan.deleteLayer	Allow deleting layers	true
geoMan.color	Stroke color for drawings	'#3388ff'
geoMan.filledColor	Fill color for drawings	'#cad9ec'
geoMan.snappable	Enable snapping to objects	false
geoMan.snapDistance	Distance for snapping	20
geoMan.drawText	Allow drawing text	true
geoMan.drawRectangle	Allow drawing rectangles	true

Usage As Infolist Field

The MapEntry Infolist field displays a map with all the same configuration options available in the form field. Here's an example:

use Dotswan\MapPicker\Infolists\MapEntry;

public static function infolist(Infolist $infolist): Infolist
{
    return $infolist
        ->schema([
            MapEntry::make('location')
                // Basic Configuration
                ->defaultLocation(latitude: 40.4168, longitude: -3.7038)
                ->draggable(false) // Usually false for infolist view
                ->zoom(15)
                ->minZoom(0)
                ->maxZoom(28)
                ->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png")
                ->detectRetina(true)
                
                // Marker Configuration
                ->showMarker(true)
                ->markerColor("#22c55eff")
                ->markerHtml('<div class="custom-marker">...</div>')
                ->markerIconUrl('/path/to/marker.png')
                ->markerIconSize([36, 36])
                ->markerIconClassName('my-marker-class')
                ->markerIconAnchor([18, 36])
                
                // Controls
                ->showFullscreenControl(true)
                ->showZoomControl(true)
                
                // GeoMan Integration (if needed for viewing)
                ->geoMan(true)
                ->geoManEditable(false) // Usually false for infolist view
                ->geoManPosition('topleft')
                ->drawCircleMarker(true)
                ->drawMarker(true)
                ->drawPolygon(true)
                ->drawPolyline(true)
                ->drawCircle(true)
                ->drawRectangle(true)
                ->drawText(true)
                
                // Styling
                ->extraStyles([
                    'min-height: 50vh',
                    'border-radius: 50px'
                ])
                
                // State Management
                ->state(fn ($record) => [
                    'lat' => $record?->latitude,
                    'lng' => $record?->longitude,
                    'geojson' => $record?->geojson ? json_decode($record->geojson) : null
                ])
        ]);
}

Note: In infolist context, it's common to:

• Set draggable(false) since it's typically used for viewing only
• Set geoManEditable(false) if GeoMan is enabled
• Use state() instead of afterStateHydrated()/afterStateUpdated()
• Adjust the height to be smaller than in forms (e.g., 50vh vs 150vh)

Usage Guide for Handling Map Locations

This section explains how to handle and display map locations within your application using this package.

Step 1: Define Your Database Schema

Ensure your database table includes latitude and longitude columns. This is essential for storing the coordinates of your locations. You can define your table schema as follows:

$table->double('latitude')->nullable();
$table->double('longitude')->nullable();

Step 2: Retrieve and Set Coordinates

When loading a record, ensure you correctly retrieve and set the latitude and longitude values. Use the following method within your form component:

->afterStateHydrated(function ($state, $record, Set $set): void {
    $set('location', ['lat' => $record?->latitude, 'lng' => $record?->longitude]);
})

Step 3: Add Form Fields for Latitude and Longitude

Add hidden form fields for latitude and longitude to your form. This ensures the values are present but not visible to the user:

TextInput::make('latitude')
    ->hiddenLabel()
    ->hidden(),

TextInput::make('longitude')
    ->hiddenLabel()
    ->hidden()

If you prefer to display these values in a read-only format, replace hidden() with readOnly().

Alternative Approach: Using a Single Location Attribute

If you prefer to handle the location as a single field, you can define a custom attribute in your model. This method avoids the need for separate latitude and longitude columns:

class YourModel extends Model
{
    protected function location(): Attribute
    {
        return Attribute::make(
            get: fn (mixed $value, array $attributes) => [
                'latitude' => $attributes['latitude'],
                'longitude' => $attributes['longitude']
            ],
            set: fn (array $value) => [
                'latitude' => $value['latitude'],
                'longitude' => $value['longitude']
            ],
        );
    }
}

This approach encapsulates both latitude and longitude within a single location attribute, streamlining your code.

License

MIT License © Dotswan

Security

We take security seriously. If you discover any bugs or security issues, please help us maintain a secure project by reporting them through our GitHub issue tracker. You can also contact us directly at [email protected].

Contribution

We welcome contributions! contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request