Skip to content
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.

Sign up for GitHub

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

1.5.0-beta.1 #8879

Merged
merged 6 commits into from
Oct 17, 2019
Merged

1.5.0-beta.1 #8879

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f3c6c6
Add changelog for gl js repo
Oct 16, 2019
b0b1331
Set appropriate package version
Oct 16, 2019
72261b9
Cleanup and add #8868.
Oct 16, 2019
ba71da9
Update description for #8863
Oct 17, 2019
fc28897
Address comments, change language to use verbs.
Oct 17, 2019
a7efd4d
Move `text-variable-anchor` text to bug-fix section
Oct 17, 2019
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
21 changes: 21 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
## 1.5.0-beta.1

## ✨ Features
* GeolocateControl displays a `disabled` icon if user denies geolocation permission. [#8871](https://github.com/mapbox/mapbox-gl-js/pull/8871))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: preferably entries all start with a verb that indicates what we did. so in this case, perhaps: "Add disabled icon to GeolocateControl if user denies geolocation permission."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also what makes this change in the "Features" section but the other change to GeolocateControl in the "Improvements" section? I'm having a hard time distinguishing between the two sections 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved it into the Features section, that does make more sense.

* Add `mapboxgl.getRTLTextPluginStatus()` to query the current status of the `rtl-text-plugin` ([#8864](https://github.com/mapbox/mapbox-gl-js/pull/8864))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what benefit does this provide for the customer? what can I do now with the RTL text plugin that I couldn't do before?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased, and referenced the issue as well.

* `hash` Map option can now be set as a string which sets the map hash to a custom query parameter. ([#8603](https://github.com/mapbox/mapbox-gl-js/pull/8603)) (h/t [SebCorbin](https://github.com/SebCorbin))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: remove "now", it's unnecessary


## 🍏 Improvements
* `icon-text-fit` now properly respects `text-writing-mode`:`vertical` ([#8835](https://github.com/mapbox/mapbox-gl-js/pull/8835))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: not really sure if there's a rule here, but I have a slight preference for "Add support for icon-text-fit with vertical labels."

Also I'm thinking whether this is an improvement or bug fix...?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tis a bug fix

* GeolocateControl emits an `outofmaxbounds` and cancels the geolocate `flyTo` if the user is outside of `map.maxBounds` ([#8756](https://github.com/mapbox/mapbox-gl-js/pull/8756)) (h/t [MoradiDavijani](https://github.com/MoradiDavijani))
* Symbols fade faster when zooming out quickly, reducing overlap. ([#8628](https://github.com/mapbox/mapbox-gl-js/pull/8628))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if we want to preserve consistency in starting with a verb, "Fade symbols faster..."

* Reduce memory usage on mouseenter event in vector tile layer's with large strings. ( [#8863](https://github.com/mapbox/mapbox-gl-js/pull/8863))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description is a symptom of the root problem, maybe instead: "Reduce memory usage for vector tiles that contain long strings in feature properties."

* Improved icon density for `text-variable-anchor` by trying additional placements when icon gets collided out. ([#8803](https://github.com/mapbox/mapbox-gl-js/pull/8803))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, just from reading this changelog entry, I'm a bit confused what the change was in this release because this entry seems to describe the intention of the variable label placement feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change is in the icon part, we wouldn't try additional placements if the icon associated with the text got collided out, I made the description a bit clearer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Reading your updated entry, I also think it's more of a bug fix, as when we release new style spec properties i.e. text-variable-anchor, the expectation is that they work with all existing properties i.e. icon-text-fit. (aside: In retrospect, maybe symbol-variable-anchor would have been a better name rather than text-variable-anchor if this property affects icons too.. 💭 )

I might rephrase as:

Fix text-variable-anchor not trying multiple placements during collision detection for icons when icon-text-fit is enabled.


## 🐞 Bug Fixes

* Fix opacity interpolation for composition expressions. ([#8818](https://github.com/mapbox/mapbox-gl-js/pull/8818))
* Fix rotate and pitch events being fired at the same time. ([#8872](https://github.com/mapbox/mapbox-gl-js/pull/8872))
* Fix memory leaks w.r.t tile loading and map removal.([#8813](https://github.com/mapbox/mapbox-gl-js/pull/8813) and [#8850](https://github.com/mapbox/mapbox-gl-js/pull/8850))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think it's less confusing, esp to a global audience, to avoid using abbreviations like w.r.t.

How is "Fix memory leaks in tile loading and map removal." ?

* Fix web-worker transfer of `ArrayBuffers` in environments where `instanceof ArrayBuffer` fails.(e.g `cypress`) ([#8868](https://github.com/mapbox/mapbox-gl-js/pull/8868))

## 1.4.1

## 🐞 Bug Fixes
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mapbox-gl",
"description": "A WebGL interactive maps library",
"version": "1.5.0-dev",
"version": "1.5.0-beta.1",
"main": "dist/mapbox-gl.js",
"style": "dist/mapbox-gl.css",
"license": "SEE LICENSE IN LICENSE.txt",
Expand Down