Allow setting order of custom attribution #11196
Conversation
avpeery
changed the title
…ions after checking source attributions
There was a problem hiding this comment.
This looks good. The only unclear thing I'm wondering about is whether any users depend on the deduplication logic for where a custom attribution and an attribution from a tile source may be partial duplicates — this would no longer work as custom attributions are passed as is.
@mourner I thought about this.. It seems to me it would be more on them to not have duplicate attributions in their custom attribution? But yes they would have to modify their current custom attribution if it is a duplicate of a source attribution. |
| @@ -186,6 +174,14 @@ class AttributionControl { | |||
| return true; | |||
| }); | |||
|
|
|||
| if (this.options.customAttribution) { | |||
| if (Array.isArray(this.options.customAttribution)) { | |||
| attributions = [...this.options.customAttribution.filter(s => typeof s === 'string'), ...attributions]; | |||
There was a problem hiding this comment.
BTW, I'm not sure why we did this filter in the first place — it might no longer be relevant, possibly worth removing. Originally introduced in #7444
There was a problem hiding this comment.
without the check for string type, any data type can be passed through customAttribution, but is displayed ok in the attribution if we want to allow for that?
There was a problem hiding this comment.
In theory it shouldn't matter, because we later do attributions.join(' | ') which automatically coerces each item into string.
There was a problem hiding this comment.
Agreed, I removed the string filtering, just pushed the commit
This PR allows users to set an order for their custom attributions to appear on the map. A user may likely expect and want the order of their custom attribution to correspond to the array set in the map constructor (see: #11191).
To do this, filtering and adding custom attributions occurs after cleaning up source attributions. A part of cleaning up the source attributions involves sorting the attributions by length and then searching and removing duplicate substrings. This change was introduced in PR #2453 in order to remove duplicate substrings in the attribution control as a fix for #1804. This change was then also sorting custom attributions by length.
Before:
After:
Launch Checklist
mapbox-gl-jschangelog:<changelog>Allow users to set order of custom attribution</changelog>