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 and ol-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 🙌🏼

Release 1.0.0-next.9

• docs: add compability notes (57b3f09)
• refactor(ol-context-menu-control): make ol-contextmenu dependency optional (9994329)
• fix: Interactions.click not working (da52f53)

Potential BREAKING CHANGES

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" // optional

Release 1.0.0-next.10

• chore: rollback eslint-plugin-prettier update (e97b1cf)
• chore: update (dev-)dependencies (4d4952f)
• docs: update requirements (3490009)
• fix(ol-feature): do not create a new Feature on props.properties change (98900c7)
• Revert "refactor(ol-context-menu-control): make ol-contextmenu dependency optional" (3f7f313)

Release 1.0.0-next.8

• docs(ol-animation-path): add missing documentation page (7faf76b)
• docs(ol-style-flowline): add missing documentation page (b4e1b31)
• feat(ol-style): define and export OverrideStyleFunction which now also includes the resolution as third parameter (c69f4e8)

Release 1.0.0-next.7

• feat(ol-geolocation): pass-through original events (44249b5)

BREAKING CHANGES

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.

Example

<template>
<!-- ... -->
-   <ol-geolocation :projection="projection" @positionChanged="geoLocChange">
+   <ol-geolocation :projection="projection" @change:position="geoLocChange">
<!-- ... -->
</template>

<script setup lang="ts">
+ import type { ObjectEvent } from "ol/Object";
// ...
- function geoLocChange(loc: number[]) {
-   view.value?.setCenter(loc);
- }
+ function geoLocChange(loc: ObjectEvent) {
+   view.value?.setCenter(event.target?.getPosition()); 
+ };
</script>

Release 1.0.0-next.6

• feat(ol-interaction-*): expose interactions to be able to call their ref's (c1f2f9b)
• refactor(ol-zone-control): pass through original Options and updated docs (1ebf4b0)
• refactor(styles): make selectors more specific and prevent usage of !important (e06b795)

Release 1.0.0-next.5

• refactor: handle generic event pass-through without warnings (2a44017)
• refactor(ol-interaction-clusterselect): pass through original Options and updated docs (d98803d)

Release 1.0.0-next.4

• style: remove event log (fa6f8e2)

Release 1.0.0-next.3

• refactor: fix @ts-ignore's (7b426ae)
• refactor(ol-source-tianditu): pass-through all props and events from ol/source/WMTS (f50461c)
• refactor(ol-source-xyz): pass-through all props and events from ol/source/XYZ (b60b5bc)
• refactor(ol-source-wmts): pass-through all props and events from ol/source/WMTS (415e40b)
• refactor(ol-source-webglpoints): pass-through all props and events from ol/source/Vector (f68fe9c)
• refactor(ol-source-vector): pass-through all props and events from ol/source/Vector (e6dca45)
• refactor: move FEATURE_EVENTS into constant (12e4fba)
• fix: add missing image events (98bec45)
• refactor(ol-source-tile-wms): pass-through all props and events from ol/source/TileWMS (29086b4)
• refactor(ol-source-tile-arcgis-rest): pass-through all props and events from ol/source/TileArcGISRest (f83b847)
• docs: make custom styles scoped (bd56541)
• docs: enable search feature (15d15ef)
• docs: fix links to source code files (d774c65)
• docs: update to latest vitepress version (dbe79c8)
• docs: add logo (1582a2f)
• refactor(ol-source-osm): pass-through all props and events from ol/source/OSM (95b7cbf)
• docs: include source code snippets directly from files (05511b6)