[Symfony UX Map] Create recipes for the package and its bridges by Kocal · Pull Request #1329 · symfony/recipes

Kocal · 2024-07-20T09:12:31Z

Q	A
License	MIT
Doc issue/PR	symfony/symfony-docs#...

Adding recipies for the new Symfony UX Map package and its Bridges, currently being reviewed in symfony/ux#1937.
I've specified version 2.19, but it may be 2.20 instead, let's keep it in draft then.

github-actions · 2024-07-20T09:12:47Z

Thanks for the PR 😍

How to test these changes in your application

Define the SYMFONY_ENDPOINT environment variable:

# On Unix-like (BSD, Linux and macOS)
export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1329/index.json
# On Windows
SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1329/index.json

Install the package(s) related to this recipe:

composer req 'symfony/flex:^1.16'
composer req 'symfony/ux-google-map:^2.19' 'symfony/ux-leaflet-map:^2.19' 'symfony/ux-map:^2.19'

Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

# On Unix-like (BSD, Linux and macOS)
unset SYMFONY_ENDPOINT
# On Windows
SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes.
I'm going keep this comment up to date with any updates of the attached patch.

AlDaFlux · 2024-08-06T12:08:00Z

I try it on a php8.3 / Synfony 6.4

ubuntu@vps-95f47936:~/html/sandbox/dev$ echo $SYMFONY_ENDPOINT
https://raw.githubusercontent.com/symfony/recipes/flex/pull-1329/index.json
ubuntu@vps-95f47936:~/html/sandbox/dev$ composer req 'symfony/flex:^1.16'
./composer.json has been updated
Running composer update symfony/flex
Loading composer repositories with package information
Updating dependencies
Nothing to modify in lock file
....
ubuntu@vps-95f47936:~/html/sandbox/dev$ composer req 'symfony/ux-map:^2.19' 'symfony/ux-map-google:^2.19' 'symfony/ux-map-leaflet:^2.19'
./composer.json has been updated
Running composer update symfony/ux-map symfony/ux-map-google symfony/ux-map-leaflet
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires symfony/ux-map, it could not be found in any version, there may be a typo in the package name.
  Problem 2
    - Root composer.json requires symfony/ux-map-google, it could not be found in any version, there may be a typo in the package name.
  Problem 3
    - Root composer.json requires symfony/ux-map-leaflet, it could not be found in any version, there may be a typo in the package name.

Potential causes:
 - A typo in the package name
 - The package is not available in a stable-enough version according to your minimum-stability setting
   see <https://getcomposer.org/doc/04-schema.md#minimum-stability> for more details.
 - It's a private package and you forgot to add a custom repository to find it

Read <https://getcomposer.org/doc/articles/troubleshooting.md> for further common problems.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.
ubuntu@vps-95f47936:~/html/sandbox/dev$

Kocal · 2024-08-06T13:22:52Z

Yes, the PR is still being reviewed, the packages do not exist yet

This PR was squashed before being merged into the 2.x branch. Discussion ---------- [Map] Create Map component | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes  | Issues | Fix #38  | License | MIT Hi :) This PR is a proposal for #38 a replacement for #39. Symfony UX Map is a new Symfony UX component that makes it easy to create, customize and use interactive JavaScript maps. The package ships with: - a simple and generic way to create a map, with markers and info-windows - two Bridge, [Leaflet](https://leafletjs.com/index.html) and [Google Maps](https://developers.google.com/maps/documentation/javascript) - a way to define provider-specific options - a nice and fluent API - Flex recipes are also ready: symfony/recipes#1329 # Example ## Bridge configuration ```env # .env UX_MAP_DSN=leaflet://default ``` ```yaml # config/packages/ux_map.yaml ux_map: renderer: '%env(UX_MAP_DSN)%' ``` ## Map creation An example to render a map, custom center and zoom, some markers and info windows: ```php namespace App\Controller; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Routing\Attribute\Route; use Symfony\UX\Map\InfoWindow; use Symfony\UX\Map\MapFactoryInterface; use Symfony\UX\Map\Marker; use Symfony\UX\Map\Point; final class ContactController extends AbstractController { #[Route('/contact')] public function __invoke(): Response { // 1. Create a new map instance $myMap = (new Map()); ->center(new Point(46.903354, 1.888334)) ->zoom(6) ; // 2. You can add markers, with an optional info window $myMap ->addMarker(new Marker( position: new Point(48.8566, 2.3522), title: 'Paris' )) ->addMarker(new Marker( position: new Point(45.7640, 4.8357), title: 'Lyon', // With an info window infoWindow: new InfoWindow( headerContent: '<b>Lyon</b>', content: 'The French town in the historic Rhône-Alpes region, located at the junction of the Rhône and Saône rivers.' ) )); // 3. And inject the map in your template to render it return $this->render('contact/index.html.twig', [ 'my_map' => $myMap, ]); } } ``` ## Map rendering You must call `render_map(map)` to render the map: ```twig {{ render_map(map, { style: 'height: 700px; width: 1024px; margin: 10px' }) }} ``` It gives you this interactive Leaflet map: <img width="1524" alt="image" src="https://github.com/user-attachments/assets/cd0f64f3-5bf2-45c6-8b8d-8ad23c6ce183"> Commits ------- 212e61d [Map] Create Map component

fabpot · 2024-08-07T14:45:05Z

@Kocal Not a draft anymore, right?

Kocal · 2024-08-07T14:55:22Z

@fabpot it should be alright now

fabpot · 2024-08-07T14:59:04Z

We now need a 2.19 version of UX. Can I make the releases?

fabpot · 2024-08-07T14:59:14Z

@kbond maybe?

kbond · 2024-08-07T15:42:53Z

@fabpot, can we do it Friday?

fabpot · 2024-08-07T15:43:51Z

@fabpot, can we do it Friday?

Sure, no problems. Just ping me when you're ready.

Kocal · 2024-08-12T19:37:31Z

@fabpot @kbond I've rebased the PR, the recipes are ready to be merged if you want to :)

Checks fail because UX Map is PHP 8.3 only tho

Kocal mentioned this pull request Jul 20, 2024

[Map] Create Map component symfony/ux#1937

Merged

Kocal force-pushed the feat/symfony-ux-map branch from e3712c9 to 0fb2ec6 Compare July 20, 2024 09:32

maxhelias approved these changes Aug 7, 2024

View reviewed changes

Kocal marked this pull request as ready for review August 7, 2024 14:50

symfony-recipes-bot enabled auto-merge (squash) August 7, 2024 14:53

fabpot previously approved these changes Aug 7, 2024

View reviewed changes

auto-merge was automatically disabled August 7, 2024 15:45
Head branch was pushed to by a user without write access

Kocal dismissed fabpot’s stale review via cb80c70 August 7, 2024 15:45

Kocal force-pushed the feat/symfony-ux-map branch from 38226dd to cb80c70 Compare August 7, 2024 15:45

symfony-recipes-bot enabled auto-merge (squash) August 7, 2024 15:46

auto-merge was automatically disabled August 8, 2024 06:33
Head branch was pushed to by a user without write access

Kocal force-pushed the feat/symfony-ux-map branch from cb80c70 to 930ad77 Compare August 8, 2024 06:33

symfony-recipes-bot enabled auto-merge (squash) August 8, 2024 06:33

Kocal added 2 commits August 12, 2024 21:35

[Symfony UX Map] Create recipes for the package and its bridges

c307da3

chore: rename ux-map bridges package

7beee0a

auto-merge was automatically disabled August 12, 2024 19:35
Head branch was pushed to by a user without write access

Kocal force-pushed the feat/symfony-ux-map branch from 930ad77 to 8cc172a Compare August 12, 2024 19:35

symfony-recipes-bot enabled auto-merge (squash) August 12, 2024 19:36

kbond reviewed Aug 12, 2024

View reviewed changes

Comment thread symfony/ux-map/2.19/post-install.txt Outdated

[Map] Specify "renderer" option, even if empty

37f852e

auto-merge was automatically disabled August 12, 2024 19:42
Head branch was pushed to by a user without write access

Kocal force-pushed the feat/symfony-ux-map branch from 8cc172a to 37f852e Compare August 12, 2024 19:42

symfony-recipes-bot enabled auto-merge (squash) August 12, 2024 19:42

fabpot approved these changes Aug 12, 2024

View reviewed changes

fabpot disabled auto-merge August 12, 2024 20:20

fabpot merged commit d618953 into symfony:main Aug 12, 2024

Kocal deleted the feat/symfony-ux-map branch August 13, 2024 04:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Symfony UX Map] Create recipes for the package and its bridges#1329

[Symfony UX Map] Create recipes for the package and its bridges#1329
fabpot merged 3 commits into
symfony:mainfrom
Kocal:feat/symfony-ux-map

Kocal commented Jul 20, 2024

Uh oh!

github-actions Bot commented Jul 20, 2024 •

edited

Loading

Uh oh!

AlDaFlux commented Aug 6, 2024

Uh oh!

Kocal commented Aug 6, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

Kocal commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

kbond commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

Kocal commented Aug 12, 2024 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Uh oh!

Conversation

Kocal commented Jul 20, 2024

Uh oh!

github-actions Bot commented Jul 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to test these changes in your application

Diff between recipe versions

Uh oh!

AlDaFlux commented Aug 6, 2024

Uh oh!

Kocal commented Aug 6, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

Kocal commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

kbond commented Aug 7, 2024

Uh oh!

fabpot commented Aug 7, 2024

Uh oh!

Kocal commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions Bot commented Jul 20, 2024 •

edited

Loading

Kocal commented Aug 12, 2024 •

edited

Loading