Skip to content

Commit

Permalink
docs(style): format with prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
d-koppenhagen committed Apr 18, 2024
1 parent 12f5541 commit 3410247
Show file tree
Hide file tree
Showing 95 changed files with 155 additions and 144 deletions.
8 changes: 2 additions & 6 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
{
"recommendations": [
"Vue.volar",
"vitest.explorer",
"esbenp.prettier-vscode"
]
}
"recommendations": ["Vue.volar", "vitest.explorer", "esbenp.prettier-vscode"]
}
7 changes: 2 additions & 5 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": [
"source.fixAll.format",
"source.fixAll.eslint"
]
}
"editor.codeActionsOnSave": ["source.fixAll.format", "source.fixAll.eslint"]
}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ docker compose run screenshot-update

Please note, when recording screenshots locally the may differ from the platform (linux) in CI.
This results in:

- a: a different file name
- b: a slightly different screenshot

Expand Down
10 changes: 6 additions & 4 deletions docs/componentsguide/animations.plugin.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@

### Plugin usage

This component is part of the `Animations` plugin.
**If not installed [globally](/get-started#usage-as-plugin)**, you need to import and `use` the plugin in your `main.ts` or use the explicit component import (see section below).

::: details Import and use the `Animations` plugin

```ts {8,13} [main.ts]
import { createApp } from "vue";
import App from "./App.vue";

import { // [!code focus:6]
import {
// [!code focus:6]
Map,
Layers,
Sources,
Animations
} from 'vue3-openlayers';
Animations,
} from "vue3-openlayers";

const app = createApp(App);
// ...
app.use(Animations); // [!code focus]
// ...
```

:::

### Explicit import
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/drop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import DropAnimation from "@demos/DropAnimation.vue"
## Usage

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

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/fade/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import FadeAnimation from "@demos/FadeAnimation.vue"
## Usage

| Plugin Usage | Explicit Import |
|-----------------------|:------------------------------:|
| --------------------- | :----------------------------: |
| `<ol-animation-fade>` | `<Animations.OlAnimationFade>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/path/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import FlowLineDemo from "@demos/FlowLineDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|-----------------------|:------------------------------:|
| --------------------- | :----------------------------: |
| `<ol-animation-path>` | `<Animations.OlAnimationPath>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/shake/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import ShakeAnimation from "@demos/ShakeAnimation.vue"
## Usage

| Plugin Usage | Explicit Import |
|------------------------|:-------------------------------:|
| ---------------------- | :-----------------------------: |
| `<ol-animation-shake>` | `<Animations.OlAnimationShake>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/slide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import SlideAnimation from "@demos/SlideAnimation.vue"
## Usage

| Plugin Usage | Explicit Import |
|------------------------|:-------------------------------:|
| ---------------------- | :-----------------------------: |
| `<ol-animation-slide>` | `<Animations.OlAnimationSlide>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/teleport/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import TeleportAnimation from "@demos/TeleportAnimation.vue"
## Usage

| Plugin Usage | Explicit Import |
|---------------------------|:----------------------------------:|
| ------------------------- | :--------------------------------: |
| `<ol-animation-teleport>` | `<Animations.OlAnimationTeleport>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/animations/zoom/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import ZoomAnimation from "@demos/ZoomAnimation.vue"
## Usage

| Plugin Usage | Explicit Import |
|-----------------------|:------------------------------:|
| --------------------- | :----------------------------: |
| `<ol-animation-zoom>` | `<Animations.OlAnimationZoom>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/feature/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import GeomPoint from "@demos/GeomPoint.vue"
## Usage

| Plugin Usage | Explicit Import |
|----------------|:-----------------:|
| -------------- | :---------------: |
| `<ol-feature>` | `<Map.OlFeature>` |

<ClientOnly>
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 @@ -25,7 +25,7 @@ import GeoLocationDemo from "@demos/GeoLocationDemo.vue"
## Usage

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

::: code-group
Expand Down
10 changes: 6 additions & 4 deletions docs/componentsguide/geometries.plugin.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@

### Plugin usage

This component is part of the `Geometries` plugin.
**If not installed [globally](/get-started#usage-as-plugin)**, you need to import and `use` the plugin in your `main.ts` or use the explicit component import (see section below).

::: details Import and use the `Geometries` plugin

```ts {8,13} [main.ts]
import { createApp } from "vue";
import App from "./App.vue";

import { // [!code focus:6]
import {
// [!code focus:6]
Map,
Layers,
Sources,
Geometries
} from 'vue3-openlayers';
Geometries,
} from "vue3-openlayers";

const app = createApp(App);
// ...
app.use(Geometries); // [!code focus]
// ...
```

:::

### Explicit import
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geomcircle/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import CircleDemo from "@demos/CircleDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|--------------------|:---------------------------:|
| ------------------ | :-------------------------: |
| `<ol-geom-circle>` | `<Geometries.OlGeomCircle>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geomlinestring/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import LineString from "@demos/LineString.vue"
## Usage

| Plugin Usage | Explicit Import |
|-------------------------|:-------------------------------:|
| ----------------------- | :-----------------------------: |
| `<ol-geom-line-string>` | `<Geometries.OlGeomLineString>` |

::: code-group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import MultiLineString from "@demos/MultiLineString.vue"
## Usage

| Plugin Usage | Explicit Import |
|-------------------------------|:------------------------------------:|
| ----------------------------- | :----------------------------------: |
| `<ol-geom-multi-line-string>` | `<Geometries.OlGeomMultiLineString>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geommultipoint/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import MultiPoint from "@demos/MultiPoint.vue"
## Usage

| Plugin Usage | Explicit Import |
|-------------------------|:-------------------------------:|
| ----------------------- | :-----------------------------: |
| `<ol-geom-multi-point>` | `<Geometries.OlGeomMultiPoint>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geommultipolygon/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import MultiPolygon from "@demos/MultiPolygon.vue"
## Usage

| Plugin Usage | Explicit Import |
|---------------------------|:---------------------------------:|
| ------------------------- | :-------------------------------: |
| `<ol-geom-multi-polygon>` | `<Geometries.OlGeomMultiPolygon>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geompoint/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import GeomPoint from "@demos/GeomPoint.vue"
## Usage

| Plugin Usage | Explicit Import |
|-------------------|:--------------------------:|
| ----------------- | :------------------------: |
| `<ol-geom-point>` | `<Geometries.OlGeomPoint>` |

::: code-group
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/geometries/geompolygon/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import PolygonDemo from "@demos/PolygonDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|---------------------|:----------------------------:|
| ------------------- | :--------------------------: |
| `<ol-geom-polygon>` | `<Geometries.OlGeomPolygon>` |

::: code-group
Expand Down
10 changes: 6 additions & 4 deletions docs/componentsguide/interactions.plugin.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@

### Plugin usage

This component is part of the `Interactions` plugin.
**If not installed [globally](/get-started#usage-as-plugin)**, you need to import and `use` the plugin in your `main.ts` or use the explicit component import (see section below).

::: details Import and use the `Interactions` plugin

```ts {8,13} [main.ts]
import { createApp } from "vue";
import App from "./App.vue";

import { // [!code focus:6]
import {
// [!code focus:6]
Map,
Layers,
Sources,
Interactions
} from 'vue3-openlayers';
Interactions,
} from "vue3-openlayers";

const app = createApp(App);
// ...
app.use(Interactions); // [!code focus]
// ...
```

:::

### Explicit import
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 @@ -23,7 +23,7 @@ import AnimatedClusterDemo from "@demos/AnimatedClusterDemo.vue"
## Usage

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

::: code-group
Expand Down
3 changes: 1 addition & 2 deletions docs/componentsguide/interactions/dragbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import VectorSourceDemo1 from "@demos/VectorSourceDemo1.vue"
## Usage

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

::: code-group
Expand Down Expand Up @@ -83,4 +83,3 @@ onMounted(() => {
});
</script>
```

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

| Plugin Usage | Explicit Import |
|-------------------------------|:----------------------------------------:|
| ----------------------------- | :--------------------------------------: |
| `<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 @@ -21,7 +21,7 @@ import DragRotateZoomDemo from "@demos/DragRotateZoomDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|-----------------------------------|:--------------------------------------------:|
| --------------------------------- | :------------------------------------------: |
| `<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 @@ -20,7 +20,7 @@ import DrawMeasureDemo from "@demos/DrawMeasureDemo.vue"
## Usage

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

### Example 1: Draw Features
Expand Down
2 changes: 1 addition & 1 deletion docs/componentsguide/interactions/link/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import ViewDemo from "@demos/ViewDemo.vue"
## Usage

| 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 @@ -21,7 +21,7 @@ import SnapModifyDemo from "@demos/SnapModifyDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|---------------------------|:------------------------------------:|
| ------------------------- | :----------------------------------: |
| `<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 @@ -21,7 +21,7 @@ import SelectDemo from "@demos/SelectDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|---------------------------|:------------------------------------:|
| ------------------------- | :----------------------------------: |
| `<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 @@ -21,7 +21,7 @@ import SnapModifyDemo from "@demos/SnapModifyDemo.vue"
## Usage

| Plugin Usage | Explicit Import |
|-------------------------|:----------------------------------:|
| ----------------------- | :--------------------------------: |
| `<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 @@ -21,7 +21,7 @@ import TransformDemo from "@demos/TransformDemo.vue"
## Usage

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

::: code-group
Expand Down
Loading

0 comments on commit 3410247

Please sign in to comment.