Default attribution

[HarelM]

Launch Checklist

• Breaking changes MapLibre GL JS v4 #3052

Update icon, add attribution by default.
I find the configuration a bit too verbose both for the logo and attribution, maybe we could reduce some of the configuration by using a single parameter for each, IDK...

• Confirm your changes do not include backports from Mapbox projects (unless with compliant license) - if you are not sure about this, please ask!
• Briefly describe the changes in this PR.
• Link to related issues.
• Include before/after visuals or gifs if this PR includes visual changes.
• Document any changes to public APIs.
• Add an entry to CHANGELOG.md under the ## main section.

New logo, not on by default:

Default attribution now on:

[HarelM]

CC: @wipfli you can try it out.

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (8ce93cb) 86.91% compared to head (ff1cc97) 87.19%.

Files	Patch %	Lines
src/ui/map.ts	75.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3618      +/-   ##
==========================================
+ Coverage   86.91%   87.19%   +0.27%     
==========================================
  Files         240      240              
  Lines       32211    32214       +3     
  Branches     2092     2093       +1     
==========================================
+ Hits        27997    28088      +91     
+ Misses       3272     3202      -70     
+ Partials      942      924      -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wipfli]

Thanks for writing this pull request @HarelM. I wanted to try it out locally with the examples, but looks like they use the published version of GL JS. Is that right?

[wipfli]

[HarelM]

Use npm run start and surf to the relevant example.
Yes, docs are using the published version.

[wipfli]

So basically to remove the "MapLibre" in the attribution users have to do this:

const map = new maplibregl.Map({
    // ...
    attributionControl: false,
});

map.addControl(new maplibregl.AttributionControl({
    customAttribution: ''
}));

is that correct?

[wipfli]

I think we should use the new logo from #3631 which is gray scale rather than this version here...

[HarelM]

Feel free to push updates to this branch. I have no hard feelings either way.

[HarelM]

Make sure you remove all the extra annotations from the svg to reduce svg size in production.

[louwers]

I think a grayscale logo has a better chance of being used by people.

[HarelM]

I don't think people will voluntarily add the logo to their app, so I think the logo is a better approach in terms of "marketing", but I don't have strong feelings either way.
If we don't add it by default we might as well remove the control, that's what I think at least.
If you don't know what you are doing and all you need is to show a map, it is likely that you'll keep the logo/attributnion.
That's my two cents.
In any case, changing this is very easy.

[louwers]

@HarelM Well Komoot proudly gives MapLibre credit for example.

And not everybody is building an app with MapLibre. When someone includes a map in a blog post for example, I can imagine people don't mind showing the logo.

[HarelM]

So what about the grayscle icon (the other PR which should target this branch)? Should we use it or not?

[louwers]

Yes let's use that one!

[wipfli]

Looks good to me. Thanks for working on this @HarelM!

[breunigs]

Was it intentional for the attribution to be always collapsed by default? I can't quite tell from the PR description. If so, maybe the sentence that recommends to keep it expanded (https://github.com/maplibre/maplibre-gl-js/pull/3618/files#diff-7489f127e6e44739b4d10d3d5102ca30e47ff444ebba85ea9921e558e9468676L14) should be removed, as well guidance on how to get "automatic" mode back (passing anything but a boolean works, but it's not obvious when just reading the docs)

[HarelM]

As can be seen here:
https://maplibre.org/maplibre-gl-js/docs/examples/simple-map/
The default is not collapsed on desktop without moving the map, once the map pans the attribution will collapse or when surfing from a mobile device (small screen).
Feel free to open a PR to update the docs if you think they can be improved.