Releases: MelihAltintas/vue3-openlayers
Release 2.0.0
2.0.0 (2023-09-14)
Bug Fixes
- allow multiple plugin installation (#247) (9a3b133)
- allow using controls as childs of bar (#248) (8d59c76)
- correctly remove controls onUnmounted (3756fbb), closes #246
chore
- update dependency to openlayers 8.0.0 (a76dd57)
Code Refactoring
- ol-source-stadia-maps: replace old ol-stamen component (ff9e373)
- ol-style-icon: pass-through properties from OpenLayers (84232e9)
- ol-webgl-points-layer: use new flat style format (02b8d1f)
BREAKING CHANGES
- ol-webgl-points-layer: use the new introduced flat format from OpenLayers 8
- ol-style-icon: properties are passed-through from OpenLayers directly and property
imgSize
has been removed since it's removed from OpenLayers 8 - ol-source-stadia-maps: The new component
ol-source-stadia-maps
replaced the oldol-source-stamen
component. Please checkout the official OpenLayers 8 release notes for further information. - You need to have a peerDependency of
ol
>=8.0.0
installed
Features
Release 1.3.0
Release 2.0.0-1
2.0.0-1 (2023-09-08)
Bug Fixes
chore
- update dependency to openlayers 8.0.0 (cdd9267)
Code Refactoring
- ol-source-stadia-maps: replace old ol-stamen component (3d303e2)
- ol-style-icon: pass-through properties from OpenLayers (aba89f3)
- ol-webgl-points-layer: use new flat style format (8c9dc48)
BREAKING CHANGES
- ol-webgl-points-layer: use the new introduced flat format from OpenLayers 8
- ol-style-icon: properties are passed-through from OpenLayers directly and property
imgSize
has been removed since it's removed from OpenLayers 8 - ol-source-stadia-maps: The new component
ol-source-stadia-maps
replaced the oldol-source-stamen
component. Please checkout the official OpenLayers 8 release notes for further information. - You need to have a peerDependency of
ol
>=8.0.0
installed
Release 1.2.2
Release 2.0.0-0
2.0.0-0 (2023-09-04)
chore
- update dependency to openlayers 8.0.0 (a76dd57)
Code Refactoring
- ol-source-stadia-maps: replace old ol-stamen component (ff9e373)
- ol-style-icon: pass-through properties from OpenLayers (84232e9)
- ol-webgl-points-layer: use new flat style format (02b8d1f)
BREAKING CHANGES
- ol-webgl-points-layer: use the new introduced flat format from OpenLayers 8
- ol-style-icon: properties are passed-through from OpenLayers directly and property
imgSize
has been removed since it's removed from OpenLayers 8 - ol-source-stadia-maps: The new component
ol-source-stadia-maps
replaced the oldol-source-stamen
component. Please checkout the official OpenLayers 8 release notes for further information. - You need to have a peerDependency of
ol
>=8.0.0
installed
Release 1.2.1
Release 1.2.0
Release 1.1.0
- chore(maintenance): update dependencies (258e396)
- docs(ol-map): add documentation for prop (b54312c)
- fix(ol-feature): prevent unresponsive map lag (989bc90)
- fix(ol-zone-control): define props with default values as optional (8275202)
- docs(ol-interaction-snap): add demo case for draw interaction (e588a5f)
- Update animatedclusterlayer, improve wording and fluency of explanation (#226) (3191963)
- docs(ol-geolocation): display icon position correctly (6ae205b)
- feat(ol-style-text): added backgroundFill and backgroundStroke props (#223) (6f521c9)
Release 1.0.1
- chore: disable eslint for process access in version script (78455b0)
- docs: add note for output.globals (c4c6d0f)
- fix(build): update vite-plugin-dts and configure output.globals (#218) (fe739c4)
- refactor(ol-view): use ViewOptions interface and remove unneeded composable (5d139eb)
- refactor: remove unused useLayerControl (3ea0a99)
- fix(ol-geolocation): prevent Extraneous non-emits event listeners warning (11c14f1)
- docs: describe how to access ol/Map (5ab6231)
- docs: updated contribution guidelines (0c38dc3)
- docs: update getting started (65fed43)
- chore: update ISSUE_TEMPLATE (a0cf678)
- docs: update requirements automatically (cdbd12f)
- docs: replace 'Openlayers' with 'OpenLayers' (bd59efc)
Release 1.0.0 🎉 🗺️
Version 1.0.0
was completely refactored and aligned with the features and also BREAKING CHANGES from OpenLayers 7.x.x.
Please be sure to checkout the Changelog of OpenLayers as well.
Properties are mostly reflected 1:1 from OpenLayers as Component Properties for the related vue3-openlayers
components. The same applies for the default values. Deviating properties with their values and description are listed in the documentation for each component.
Summary (compared to version 0.5.1
)
- 🛠️ migrated all components and features to TypeScript
- 👩🏻🔧 migrated all components to use
<script setup>
syntax - 🗺️ aligned API with OpenLayers 7.4.0
- 📘 updated & restructured the whole documentation
- 🧩 added new components:
ol-layer-group
,ol-source-tile-json
,ol-source-stamen
andol-vector-image-layer
- 🚀 expose all interactions to be able to call access them via
ref
in templates - 🐞 lot's of bug fixes
- 📖 improved the documentation
- ✨ better types for improved developer experience
Compability
Please be sure to install the following peerDependencies in your project:
"ol": "^7.4.0",
"ol-contextmenu": "^5.2.1",
"ol-ext": "^4.0.8"
Breaking Changes
general: dropped support for Openlayers 6 and below. Please use Openlayers 7.x.x
general: lot's of property types have been updated to match with the types in Openlayers. This may lead to TypeScript issues that must be fixed. Please have a look at all Changelog notes from the alpha and next releases before.
ol-geolocation: pass-through original events from Openlayers directly and remove legacy events
The following events are not emitted anymore and replaced with the events from Openlayers.
All new events receive a generic ObjectEvent
.
This means, changing only the event name in your templates isn't enough, you must adopt the implementations of the handler functions, so the will receive an ObjectEvent
as first parameter.
positionChanged
->change:position
speedChanged
->change:speed
headingChanged
->change:heading
altitudeChanged
->change:altitude
altitudeAccuracyChanged
->change:altitudeAccuracy
accuracyGeometryChanged
->change:accuracyGeometry
Please refer to the official Openlayers docs for Geolocation for details of the emitted event data format.
Special Thanks 👏🏼
Special thanks goes to:
- @MelihAltintas for creating this awesome project, making it open source and enable other maintainers (like @d-koppenhagen) to improve it
- @mathiash98 for digging deep into the code and fixing tricky issues like #128 and #175
- @209, for the time invested and the laborious migration of the code base (PR #149 was the basis for all the related commits)
- @lukas-zaugg and @pjreed for other important bug fixes and new features
- all other people who were not mentioned here but who also contributed to version 1.0.0 with their questions and issues 🙌🏼