Add customAttribution option to AttributionControl #7033
Conversation
| @@ -111,6 +113,13 @@ class AttributionControl { | |||
| _updateAttributions() { | |||
| if (!this._map.style) return; | |||
| let attributions: Array<string> = []; | |||
| if (this.options.customAttribution) { | |||
| if (this.options.customAttribution instanceof Array) { | |||
There was a problem hiding this comment.
Let's use Array.isArray instead — instanceof Array can sometimes fail.
src/ui/map.js
Outdated
| @@ -61,6 +61,7 @@ type MapOptions = { | |||
| container: HTMLElement | string, | |||
| bearingSnap?: number, | |||
| attributionControl?: boolean, | |||
| customAttribution?: string | string[], | |||
There was a problem hiding this comment.
Let's use Array<string> form for consistency.
|
btw, I noticed that running build locally adds |
|
@mklopets not intentionally, don't worry about it — we'll commit. |
| @@ -16,6 +17,7 @@ type Options = { | |||
| * @implements {IControl} | |||
| * @param {Object} [options] | |||
| * @param {boolean} [options.compact] If `true` force a compact attribution that shows the full attribution on mouse hover, or if `false` force the full attribution control. The default is a responsive attribution that collapses when the map is less than 640 pixels wide. | |||
| * @param {string | Array<string>} [options.customAttribution] String or strings to show ahead of any other attributions. | |||
There was a problem hiding this comment.
It might just be me, but I think after would be easier to understand in this context than ahead.
There was a problem hiding this comment.
Actually, this JSDoc is incorrect, everything is sorted by length anyway – I'll change the doc. Thanks!
|
@mourner could we get this released? Would be much appreciated – needed in production. |
|
@mklopets unfortunately not at the moment — we're on a monthly release cadence so you should expect the new version in about 3 weeks. However, you can always build the |
|
Oh, alright :/ I tried looking up the release cadence from the docs here in the repo but couldn't find anything. Might be good to add a little note to Thanks for the quick response(s)! |
Adds feature: mapbox/mapbox-gl-js#7033
Adds feature: mapbox/mapbox-gl-js#7033
Adds a way to add custom attribution strings to AttributionControl. Also exposes the
customAttributionoption on Map.This implements the feature request in #1485.