Skip to content

Commit

Permalink
refactor: rename components
Browse files Browse the repository at this point in the history
BREAKING CHANGE:
Several components have been renamed. Adjustments are **only** necessary when not consuming these components as a plugin but directly. When using a plugin for global component availability, nothing has been changed. This change was necessary to align the names of directly importable and usable components with the global names provided by the plugins.
- `<Animations.OLAnimationDrop>` was renamed to `<Animations.OlAnimationDrop>`
- `<Interaction.OlClusterSelectInteraction>` was renamed to `<Interaction.OlInteractionClusterselect>`
- `<Interaction.OlDragBoxInteraction>` was renamed to `<Interaction.OlInteractionDragbox>`
- `<Interaction.OlDragRotateInteraction>` was renamed to `<Interaction.OlInteractionDragrotate>`
- `<Interaction.OlDragRotateZoomInteraction>` was renamed to `<Interaction.OlInteractionDragrotatezoom>`
- `<Interaction.OlLinktInteraction>` was renamed to `<Interaction.OlInteractionLink>`
- `<Interaction.OlSelectInteraction>` was renamed to `<Interaction.OlInteractionSelect>`
- `<Interaction.OlDrawInteraction>` was renamed to `<Interaction.OlInteractionDraw>`
- `<Interaction.OlModifyInteraction>` was renamed to `<Interaction.OlInteractionModify>`
- `<Interaction.OlSnapInteraction>` was renamed to `<Interaction.OlInteractionSnap>`
- `<Interaction.OlTransformInteraction>` was renamed to `<Interaction.OlInteractionTransform>`
- `<Layers.OlAnimatedClusterLayer>` was renamed to `<Layers.OlAnimatedClusterlayer>`
- `<Map.OlGeoLocation>` was renamed to `<Map.OlGeolocation>`
- `<MapControls.OlFullScreenControl>` was renamed to `<MapControls.OlFullscreenControl>`
- `<MapControls.OlMousePositionControl>` was renamed to `<MapControls.OlMousepositionControl>`
- `<MapControls.OlOverviewMapControl>` was renamed to `<MapControls.OlOverviewmapControl>`
- `<MapControls.OlScaleLineControl>` was renamed to `<MapControls.OlScalelineControl>`
- `<MapControls.OlZoomSliderControl>` was renamed to `<MapControls.OlZoomsliderControl>`
- `<MapControls.OlZoomToExtentControl>` was renamed to `<MapControls.OlZoomtoextentControl>`
- `<MapControls.OlPrintDialogControl>` was renamed to `<MapControls.OlPrintdialogControl>`
- `<MapControls.OlVideoRecorderControl>` was renamed to `<MapControls.OlVideorecorderControl>`
- `<MapControls.OlLayerSwitcherControl>` was renamed to `<MapControls.OlLayerswitcherControl>`
- `<MapControls.OlLayerSwitcherImageControl>` was renamed to `<MapControls.OlLayerswitcherimageControl>`
- `<Sources.OlSourceBingMaps>` was renamed to `<Sources.OlSourceBingmaps>`
- `<Sources.OlSourceImageWMS>` was renamed to `<Sources.OlSourceImageWms>`
- `<Sources.OlSourceOSM>` was renamed to `<Sources.OlSourceOsm>`
- `<Sources.OlSourceTileArcGISRest>` was renamed to `<Sources.OlSourceTileArcgisRest>`
- `<Sources.OlSourceGeoTIFF>` was renamed to `<Sources.OlSourceGeoTiff>`
- `<Sources.OlSourceTileJSON>` was renamed to `<Sources.OlSourceTileJson>`
- `<Sources.OlSourceTileWMS>` was renamed to `<Sources.OlSourceTileWms>`
- `<Sources.OlSourceXYZ>` was renamed to `<Sources.OlSourceXyz>`
- `<Sources.OlSourceWMTS>` was renamed to `<Sources.OlSourceWmts>`
  • Loading branch information
d-koppenhagen committed Apr 18, 2024
1 parent fcfd461 commit ea85a6e
Show file tree
Hide file tree
Showing 70 changed files with 1,353 additions and 132 deletions.
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/drop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import DropAnimation from "@demos/DropAnimation.vue"

| Plugin Usage | Explicit Import |
|-----------------------|:------------------------------:|
| `<ol-animation-drop>` | `<Animations.OLAnimationDrop>` |
| `<ol-animation-drop>` | `<Animations.OlAnimationDrop>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geolocation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import GeoLocationDemo from "@demos/GeoLocationDemo.vue"

| Plugin Usage | Explicit Import |
|--------------------|:---------------------:|
| `<ol-geolocation>` | `<Map.OlGeoLocation>` |
| `<ol-geolocation>` | `<Map.OlGeolocation>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/clusterselect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import AnimatedClusterDemo from "@demos/AnimatedClusterDemo.vue"

| Plugin Usage | Explicit Import |
|----------------------------------|:-------------------------------------------:|
| `<ol-interaction-clusterselect>` | `<Interactions.OlClusterSelectInteraction>` |
| `<ol-interaction-clusterselect>` | `<Interactions.OlInteractionClusterselect>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/dragbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import VectorSourceDemo1 from "@demos/VectorSourceDemo1.vue"

| Plugin Usage | Explicit Import |
|----------------------------|:-------------------------------------:|
| `<ol-interaction-dragbox>` | `<Interactions.OlDragBoxInteraction>` |
| `<ol-interaction-dragbox>` | `<Interactions.OlInteractionDragbox>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/dragrotate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import DragRotateDemo from "@demos/DragRotateDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------------------|:----------------------------------------:|
| `<ol-interaction-dragrotate>` | `<Interactions.OlDragRotateInteraction>` |
| `<ol-interaction-dragrotate>` | `<Interactions.OlInteractionDragrotate>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/dragrotatezoom/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import DragRotateZoomDemo from "@demos/DragRotateZoomDemo.vue"

| Plugin Usage | Explicit Import |
|-----------------------------------|:--------------------------------------------:|
| `<ol-interaction-dragrotatezoom>` | `<Interactions.OlDragRotateZoomInteraction>` |
| `<ol-interaction-dragrotatezoom>` | `<Interactions.OlInteractionDragrotatezoom>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/draw/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import DrawMeasureDemo from "@demos/DrawMeasureDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------------:|
| `<ol-interaction-draw>` | `<Interactions.OlDrawInteraction>` |
| `<ol-interaction-draw>` | `<Interactions.OlInteractionDraw>` |

### Example 1: Draw Features

Expand Down
6 changes: 3 additions & 3 deletions docs/componentsguide/interactions/link/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import ViewDemo from "@demos/ViewDemo.vue"

## Usage

| Plugin Usage | Explicit Import |
|-------------------------|:-----------------------------------:|
| `<ol-interaction-link>` | `<Interactions.OlLinktInteraction>` |
| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------------:|
| `<ol-interaction-link>` | `<Interactions.OlInteractionLink>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/modify/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import SnapModifyDemo from "@demos/SnapModifyDemo.vue"

| Plugin Usage | Explicit Import |
|---------------------------|:------------------------------------:|
| `<ol-interaction-modify>` | `<Interactions.OlModifyInteraction>` |
| `<ol-interaction-modify>` | `<Interactions.OlInteractionModify>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/select/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import SelectDemo from "@demos/SelectDemo.vue"

| Plugin Usage | Explicit Import |
|---------------------------|:------------------------------------:|
| `<ol-interaction-select>` | `<Interactions.OlSelectInteraction>` |
| `<ol-interaction-select>` | `<Interactions.OlInteractionSelect>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/snap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import SnapModifyDemo from "@demos/SnapModifyDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------------:|
| `<ol-interaction-snap>` | `<Interactions.OlSnapInteraction>` |
| `<ol-interaction-snap>` | `<Interactions.OlInteractionSnap>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/transform/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import TransformDemo from "@demos/TransformDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------------|:---------------------------------------:|
| `<ol-interaction-transform>` | `<Interactions.OlTransformInteraction>` |
| `<ol-interaction-transform>` | `<Interactions.OlInteractionTransform>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/layers/animatedclusterlayer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import AnimatedClusterDemo from "@demos/AnimatedClusterDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------------|:---------------------------------:|
| `<ol-animated-clusterlayer>` | `<Layers.OlAnimatedClusterLayer>` |
| `<ol-animated-clusterlayer>` | `<Layers.OlAnimatedClusterlayer>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/fullscreen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import FullscreenControlDemo from "@demos/FullscreenControlDemo.vue"

| Plugin Usage | Explicit Import |
|---------------------------|:-----------------------------------:|
| `<ol-fullscreen-control>` | `<MapControls.OlFullScreenControl>` |
| `<ol-fullscreen-control>` | `<MapControls.OlFullscreenControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/layerswitcher/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import LayerswitcherControlDemo from "@demos/LayerswitcherControlDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------------|:--------------------------------------:|
| `<ol-layerswitcher-control>` | `<MapControls.OlLayerSwitcherControl>` |
| `<ol-layerswitcher-control>` | `<MapControls.OlLayerswitcherControl>` |

::: code-group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import LayerswitcherimageControlDemo from "@demos/LayerswitcherimageControlDemo.

| Plugin Usage | Explicit Import |
|-----------------------------------|:-------------------------------------------:|
| `<ol-layerswitcherimage-control>` | `<MapControls.OlLayerSwitcherImageControl>` |
| `<ol-layerswitcherimage-control>` | `<MapControls.OlLayerswitcherimageControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/mouseposition/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import MousepositionControlDemo from "@demos/MousepositionControlDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------------|:--------------------------------------:|
| `<ol-mouseposition-control>` | `<MapControls.OlMousePositionControl>` |
| `<ol-mouseposition-control>` | `<MapControls.OlMousepositionControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/overviewmap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import OverviewmapControlDemo from "@demos/OverviewmapControlDemo.vue"

| Plugin Usage | Explicit Import |
|----------------------------|:------------------------------------:|
| `<ol-overviewmap-control>` | `<MapControls.OlOverviewMapControl>` |
| `<ol-overviewmap-control>` | `<MapControls.OlOverviewmapControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/printdialog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import PrintdialogControlDemo from "@demos/PrintdialogControlDemo.vue"

| Plugin Usage | Explicit Import |
|----------------------------|:------------------------------------:|
| `<ol-printdialog-control>` | `<MapControls.OlPrintDialogControl>` |
| `<ol-printdialog-control>` | `<MapControls.OlPrintdialogControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/scaleline/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import ScalelineControlDemo from "@demos/ScalelineControlDemo.vue"

| Plugin Usage | Explicit Import |
|--------------------------|:----------------------------------:|
| `<ol-scaleline-control>` | `<MapControls.OlScaleLineControl>` |
| `<ol-scaleline-control>` | `<MapControls.OlScalelineControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/videorecorder/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import VideorecorderControlDemo from "@demos/VideorecorderControlDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------------|:--------------------------------------:|
| `<ol-videorecorder-control>` | `<MapControls.OlVideoRecorderControl>` |
| `<ol-videorecorder-control>` | `<MapControls.OlVideorecorderControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/zoomslider/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import ZoomsliderControlDemo from "@demos/ZoomsliderControlDemo.vue"

| Plugin Usage | Explicit Import |
|---------------------------|:-----------------------------------:|
| `<ol-zoomslider-control>` | `<MapControls.OlZoomSliderControl>` |
| `<ol-zoomslider-control>` | `<MapControls.OlZoomsliderControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/mapcontrols/zoomtoextent/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import ZoomtoextentControlDemo from "@demos/ZoomtoextentControlDemo.vue"

| Plugin Usage | Explicit Import |
|-----------------------------|:-------------------------------------:|
| `<ol-zoomtoextent-control>` | `<MapControls.OlZoomToExtentControl>` |
| `<ol-zoomtoextent-control>` | `<MapControls.OlZoomtoextentControl>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/arcgisrest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import TileArcGISRestSourceDemo from "@demos/TileArcGISRestSourceDemo.vue"

| Plugin Usage | Explicit Import |
|--------------------------------|:----------------------------------:|
| `<ol-source-tile-arcgis-rest>` | `<Sources.OlSourceTileArcGISRest>` |
| `<ol-source-tile-arcgis-rest>` | `<Sources.OlSourceTileArcgisRest>` |

Example of `ol-source-tile-arcgis-rest` usage. Information about the arcgis service used, available at https://pkk.rosreestr.ru/arcgis/rest/services/PKK6/CadastreObjects/MapServer.

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/bing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import BingMapsDemo from "@demos/BingMapsDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------|:----------------------------:|
| `<ol-source-bingmaps>` | `<Sources.OlSourceBingMaps>` |
| `<ol-source-bingmaps>` | `<Sources.OlSourceBingmaps>` |

Example of `ol-source-bingmaps` usage

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/geotiff/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import GeoTIFFDemo from "@demos/GeoTIFFDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------|:---------------------------:|
| `<ol-source-geo-tiff>` | `<Sources.OlSourceGeoTIFF>` |
| `<ol-source-geo-tiff>` | `<Sources.OlSourceGeoTiff>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/imagewms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import ImageWMSDemo from "@demos/ImageWMSDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------:|
| `<ol-source-image-wms>` | `<Sources.OlSourceImageWMS>` |
| `<ol-source-image-wms>` | `<Sources.OlSourceImageWms>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/osm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import ViewDemo from "@demos/ViewDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------|:-----------------------:|
| `<ol-source-osm>` | `<Sources.OlSourceOSM>` |
| `<ol-source-osm>` | `<Sources.OlSourceOsm>` |

Loading a simple OSM base layer.

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/tilejson/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import TileJSONDemo from "@demos/TileJSONDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------:|
| `<ol-source-tile-json>` | `<Sources.OlSourceTileJSON>` |
| `<ol-source-tile-json>` | `<Sources.OlSourceTileJson>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/tilewms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import TileWMSDemo from "@demos/TileWMSDemo.vue"

| Plugin Usage | Explicit Import |
|------------------------|:---------------------------:|
| `<ol-source-tile-wms>` | `<Sources.OlSourceTileWMS>` |
| `<ol-source-tile-wms>` | `<Sources.OlSourceTileWms>` |

::: code-group

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/wmts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import TileLayerDemo from "@demos/TileLayerDemo.vue"

| Plugin Usage | Explicit Import |
|--------------------|:------------------------:|
| `<ol-source-wmts>` | `<Sources.OlSourceWMTS>` |
| `<ol-source-wmts>` | `<Sources.OlSourceWmts>` |

Example below shows how to use ol-layer-tile component together with ol-source-wmts and with ol-source-osm.

Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/sources/xyz/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import XYZSourceDemo from "@demos/XYZSourceDemo.vue"

| Plugin Usage | Explicit Import |
|-------------------|:-----------------------:|
| `<ol-source-xyz>` | `<Sources.OlSourceXYZ>` |
| `<ol-source-xyz>` | `<Sources.OlSourceXyz>` |

Example of ol-source-xyz loading OSM tiles (Note that if you need an OSM layer you're better off using ol-source-osm, this is for demonstration purposes only).

Expand Down
4 changes: 2 additions & 2 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ import { Map, Layers, Sources } from 'vue3-openlayers';
<Map.OlMap style="min-width: 400px; min-height: 400px;">
<Map.OlView :center="[40, 40]" :zoom="5" projection="EPSG:4326" />
<Layers.OlTileLayer>
<Sources.OlSourceOSM />
<Sources.OlSourceOsm />
</Layers.OlTileLayer>
</Map.OlMap>
</template>
Expand Down Expand Up @@ -194,7 +194,7 @@ provide("ol-options", options);
<Map.OlMap style="min-width: 400px; min-height: 400px">
<Map.OlView :center="[40, 40]" :zoom="5" projection="EPSG:4326" />
<Layers.OlTileLayer>
<Sources.OlSourceOSM />
<Sources.OlSourceOsm />
</Layers.OlTileLayer>
</Map.OlMap>
</template>
Expand Down
6 changes: 3 additions & 3 deletions src/components/animations/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { App } from "vue";
import OLAnimationDrop from "./OlAnimationDrop.vue";
import OlAnimationDrop from "./OlAnimationDrop.vue";
import OlAnimationFade from "./OlAnimationFade.vue";
import OlAnimationPath from "./OlAnimationPath.vue";
import OlAnimationShake from "./OlAnimationShake.vue";
Expand All @@ -9,7 +9,7 @@ import OlAnimationZoom from "./OlAnimationZoom.vue";
import type { Vue3OpenlayersGlobalOptions } from "@/types";

function install(app: App, options?: Vue3OpenlayersGlobalOptions) {
app.component("OlAnimationDrop", OLAnimationDrop);
app.component("OlAnimationDrop", OlAnimationDrop);
app.component("OlAnimationFade", OlAnimationFade);
app.component("OlAnimationPath", OlAnimationPath);
app.component("OlAnimationShake", OlAnimationShake);
Expand All @@ -28,7 +28,7 @@ export default install;

export {
install,
OLAnimationDrop,
OlAnimationDrop,
OlAnimationFade,
OlAnimationPath,
OlAnimationShake,
Expand Down
Loading

0 comments on commit ea85a6e

Please sign in to comment.