All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Fix #280,
<RContol.RCustom>
cannot be used as anchor for inserting new elements
- Fixed
package-lock.json
- OpenLayers 10.2.0 support
- Fix #276, extending
rlayers
example needsol-mapbox-style
- OpenLayers 10 support
- Fix #270, dynamic
<RStyle>
elements with arender
property do not always update properly
- Drop React 16/17, React 18 is now required
- For OpenLayers 9.2.3
- Do not support multiple OpenLayers versions, link each
rlayers
to one OpenLayers minor version - Support light-weight
RenderFeature
s, these are opt-out for vector tile layers and opt-in for vector layers - Use the same level of typing as OpenLayers
- For OpenLayers 9.2.2
- Fix #252, stop event propagation when the event handler returns
false
- Add React 18.3 as a test target
- Support OpenLayers 9.1.0
- Fix #220, use correct event names for
RModify
in TypeScript
- Support OpenLayers 9.0.0
- Support OpenLayers 8.2.0
- Support using TypeScript generics to specify the feature geometry type for vector layers
- Support OpenLayers 8.0.0 and 8.1.0
- Replace
RLayerStamen
withRLayerStadia
which requires OpenLayers 8.0.0
- Vastly improved event handling performance avoiding expensive
forEachFeatureAtPixel
on layers that do not have event handlers - Add the
useOL()
anduseRLayersComponent()
component hooks allowing to easily access the containing OpenLayers and rlayers components - Layer event handlers are now independent of feature event handlers, if both the feature and its containing layer have declared an event handler, both will be called
- Fix
onClick
handlers onRLayerVectorTiles
layers - Use TypeScript
protected
andprivate
to restrict methods that are not expected to be directly used from user code - Support all positioning options in
ROverlay
- Support OpenLayers 7.5.1
- Fix #169, support TypeScript 5.x
- Add
onFeaturesLoadStart
andonFeaturesLoadError
events to all vector layers - Fix #163, DOMException when removing an
ROverlay
- Support OpenLayers 7.4.0
- Declare
RLayerRasterMBTiles
andRLayerVectorMBTiles
as public exports
- Add remote
.mbtiles
support withol-mbtiles
- Add new rlayers-specific events to
RLayerWMTS
andRLayerRasterMBTiles
to distinguish them from the OpenLayersonSourceReady
events - Fix #149,
RLayerWMTS
visible
property does not trigger a refresh - Add
onPointerLeave
handlers for vector tiles
- Support OpenLayers 7.3.0
- Allow using projections other than Web Mercator with
RVectorTile
(the vector tile projection must still match the view projection) - Fix [#133], certain layer properties do not update if they transition from a defined value to
undefined
- Fix #144, update WMTS layers only when the metadata is changed
- Add a
RLayerGeoTIFF
custom component, resolves #145
- Support additional
<RMap>
properties, including disabling of the rotation - Fix [#109], interactions do not support JSX styles
- Add event callbacks to
RDraw
andRModify
- Allow setting of
wrapX
for vector layers - Fix [#121], reprojected tile layers do not automatically refresh when setting the URL
- Support OpenLayers 7.2.2
- Support OpenLayers 7.2.0
- Add
RLayerImage
for displaying a static image as a map - Add
RBackground
for setting background properties ofRText
- Support all
Text
parameters in OpenLayers - Add
RGraticule
for displaying a graticule
- Fix [#85], dynamic properties of
RText
are not updated - Fix [#89], support inline styles in
RLayerVectorTile
- Support OpenLayers 7.1.0
- Fix [#80], error when compiling the layers control with TypeScript 4.8
- Fix [#82], direct enumeration of features does not work with clustering
- Support OpenLayers 7.0.0
- Support React 18.2
- Correctly use
 
as a default placeholder value forRMousePosition
- Support OpenLayers 6.15 and 6.15.1
- Allow direct import of
rlayers/control/layers.css
- Provide an alternative ES6 modules version of rlayers with a
package.json
exports map - Provide a CDN bundle version for direct inclusion in static pages
- Render the examples in React 18 mode when available
- New documentation subsystem based on
documentation.js
withdocumentation-hipster
- Expose the interpolation option for
RLayerTile
andRLayerTileWebGL
[#59] - Add
RMousePosition
control forol.control.MousePosition
[#60] - Add
RZoomToExtent
control forol.control.ZoomToExtent
[#61] - Always use
ProjectionLike
type for projections [#62] - Support setting and reading the resolution in
RView
- TypeScript compatibility with
@types/react@18.0.0
- Support React 18
- Support OpenLayers 6.14.1
- Support OpenLayers 6.14
- Fix [#37], build directly in package root
- Support OpenLayers 6.13
- Add
RLayerVectorImage
supporting OpenLayersVectorImage
layers
- Support OpenLayers 6.12
- Initial WebGL support
- Fix [#27], do not lose the event handlers when updating properties that require replacing the underlying OpenLayers object, impacts the interactions and
RFeature
withfeature=
property
- Restrict OpenLayers to 6.6 to 6.9.99 for the rlayers 1.2 branch, OpenLayers 6.10 requires rlayers 1.3
- Fix [#20], renderBuffer parameter ignored
- Have strict types for
this
andevent.target
whenever possible in the event handlers - Support replacing the bound OpenLayers feature object when updating an
RFeature
- Fix wrong
this
object inRLayerWMTS.onSourceReady
- Implement collapsing via React property setting for
RAttribution
andROverview
, waiting on openlayers/openlayers#13050 for a two-way external control
- Fix published package
- Drop support for OpenLayers <6.6
- Switch to the built-in TypeScript bindings in OpenLayers >=6.6
- Add basic WMS/TileWMS support
- Support
zIndex
inRStyle
- Fix [#13]: Dynamic rendering in
RStyleArray
- Fix [#14]: Set the projection in
RLayerTileWMS
- Fix [#15]: Properly unmount vector layers
- Fix [#3]: Path to the example css for the layers control
- Fix [#4]: More tsc
strict: true
mode compatibility fixes for React 17
- Fix [#2]: Support importing from tsc with
strict: true
- Fix [#1]: Crash when removing
<RFeature>
from<RLayerVector>
, reported by @jonas-peeters
- Solve a version conflict in the NPM registry
- First release