Skip to content

[Map] Add possibility to configure extra options #2810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Map/src/Bridge/Google/assets/dist/map_controller.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import type { LoaderOptions } from '@googlemaps/js-api-loader';
import AbstractMapController from '@symfony/ux-map';
import type { Icon, InfoWindowWithoutPositionDefinition, MarkerDefinition, Point, PolygonDefinition, PolylineDefinition } from '@symfony/ux-map';
type MapOptions = Pick<google.maps.MapOptions, 'mapId' | 'gestureHandling' | 'backgroundColor' | 'disableDoubleClickZoom' | 'zoomControl' | 'zoomControlOptions' | 'mapTypeControl' | 'mapTypeControlOptions' | 'streetViewControl' | 'streetViewControlOptions' | 'fullscreenControl' | 'fullscreenControlOptions'>;
type MapOptions = Pick<google.maps.MapOptions, 'mapId' | 'gestureHandling' | 'backgroundColor' | 'disableDoubleClickZoom' | 'zoomControl' | 'zoomControlOptions' | 'mapTypeControl' | 'mapTypeControlOptions' | 'streetViewControl' | 'streetViewControlOptions' | 'fullscreenControl' | 'fullscreenControlOptions'> & {
extra?: Record<string, unknown>;
};
export default class extends AbstractMapController<MapOptions, google.maps.Map, google.maps.marker.AdvancedMarkerElementOptions, google.maps.marker.AdvancedMarkerElement, google.maps.InfoWindowOptions, google.maps.InfoWindow, google.maps.PolygonOptions, google.maps.Polygon, google.maps.PolylineOptions, google.maps.Polyline> {
providerOptionsValue: Pick<LoaderOptions, 'apiKey' | 'id' | 'language' | 'region' | 'nonce' | 'retries' | 'url' | 'version' | 'libraries'>;
map: google.maps.Map;
Expand Down
1 change: 1 addition & 0 deletions src/Map/src/Bridge/Google/assets/dist/map_controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ class map_controller extends default_1 {
options.fullscreenControl = typeof options.fullscreenControlOptions !== 'undefined';
return new _google.maps.Map(this.element, {
...options,
...options.extra,
center,
zoom,
});
Expand Down
5 changes: 4 additions & 1 deletion src/Map/src/Bridge/Google/assets/src/map_controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ type MapOptions = Pick<
| 'streetViewControlOptions'
| 'fullscreenControl'
| 'fullscreenControlOptions'
>;
> & {
extra?: Record<string, unknown>;
};

let _google: typeof google;

Expand Down Expand Up @@ -135,6 +137,7 @@ export default class extends AbstractMapController<

return new _google.maps.Map(this.element, {
...options,
...options.extra,
center,
zoom,
});
Expand Down
9 changes: 9 additions & 0 deletions src/Map/src/Bridge/Google/src/GoogleOptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public function __construct(
private StreetViewControlOptions $streetViewControlOptions = new StreetViewControlOptions(),
private bool $fullscreenControl = true,
private FullscreenControlOptions $fullscreenControlOptions = new FullscreenControlOptions(),
private array $extra = [],
) {
}

Expand Down Expand Up @@ -132,6 +133,13 @@ public function fullscreenControlOptions(FullscreenControlOptions $fullscreenCon
return $this;
}

public function extra(array $extra): self
{
$this->extra = $extra;

return $this;
}

/**
* @internal
*/
Expand Down Expand Up @@ -174,6 +182,7 @@ public function toArray(): array
'gestureHandling' => $this->gestureHandling->value,
'backgroundColor' => $this->backgroundColor,
'disableDoubleClickZoom' => $this->disableDoubleClickZoom,
'extra' => $this->extra,
];

if ($this->zoomControl) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ type MapOptions = Pick<LeafletMapOptions, 'center' | 'zoom'> & {
attribution: string;
options: Record<string, unknown>;
} | false;
extra?: Record<string, unknown>;
};
export default class extends AbstractMapController<MapOptions, L.Map, MarkerOptions, L.Marker, PopupOptions, L.Popup, PolygonOptions, L.Polygon, PolylineOptions, L.Polyline> {
map: L.Map;
Expand Down
1 change: 1 addition & 0 deletions src/Map/src/Bridge/Leaflet/assets/dist/map_controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ class map_controller extends default_1 {
doCreateMap({ center, zoom, options, }) {
const map = L.map(this.element, {
...options,
...options.extra,
center: center === null ? undefined : center,
zoom: zoom === null ? undefined : zoom,
});
Expand Down
2 changes: 2 additions & 0 deletions src/Map/src/Bridge/Leaflet/assets/src/map_controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import type {

type MapOptions = Pick<LeafletMapOptions, 'center' | 'zoom'> & {
tileLayer: { url: string; attribution: string; options: Record<string, unknown> } | false;
extra?: Record<string, unknown>;
};

export default class extends AbstractMapController<
Expand Down Expand Up @@ -77,6 +78,7 @@ export default class extends AbstractMapController<
}: { center: Point | null; zoom: number | null; options: MapOptions }): L.Map {
const map = L.map(this.element, {
...options,
...options.extra,
center: center === null ? undefined : center,
zoom: zoom === null ? undefined : zoom,
});
Expand Down
10 changes: 10 additions & 0 deletions src/Map/src/Bridge/Leaflet/src/LeafletOptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public function __construct(
url: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
attribution: '© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a>',
),
private array $extra = [],
) {
}

Expand All @@ -34,13 +35,21 @@ public function tileLayer(TileLayer|false $tileLayer): self
return $this;
}

public function extra(array $extra): self
{
$this->extra = $extra;

return $this;
}

/**
* @internal
*/
public static function fromArray(array $array): MapOptionsInterface
{
return new self(
tileLayer: $array['tileLayer'] ? TileLayer::fromArray($array['tileLayer']) : false,
extra: $array['extra'] ?? []
);
}

Expand All @@ -51,6 +60,7 @@ public function toArray(): array
{
return [
'tileLayer' => $this->tileLayer ? $this->tileLayer->toArray() : false,
'extra' => $this->extra,
];
}
}
Loading