@chayns-components/maps 5.5.26 → 5.5.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +30 -2
- package/package.json +3 -3
package/AGENTS.md
CHANGED
|
@@ -42,17 +42,45 @@ import { PositionInput } from '@chayns-components/maps';
|
|
|
42
42
|
|
|
43
43
|
### Props
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
| name | type | required | description |
|
|
46
|
+
| --- | --- | --- | --- |
|
|
47
|
+
| `apiToken` | `string` | yes | The api token for google maps. |
|
|
48
|
+
| `initialPosition` | `Position \| undefined` | no | The position of the center of the map on the initial render. |
|
|
49
|
+
| `markers` | `IMarker[] \| undefined` | no | Markers that should be displayed. |
|
|
50
|
+
| `onMarkerAdd` | `((marker: IMarker) => void) \| undefined` | no | Function to be executed when a marker is added. |
|
|
51
|
+
| `onMarkerChange` | `((markers: IMarker[]) => void) \| undefined` | no | Function to be executed when a marker position is changed. |
|
|
52
|
+
| `onMarkerRemove` | `((id: number) => void) \| undefined` | no | Function to be executed when a marker is removed. |
|
|
53
|
+
| `polygonOptions` | `PolygonOptions \| undefined` | no | Options to style the polygon. |
|
|
54
|
+
| `searchPlaceholder` | `string \| undefined` | no | The placeholder of the search input. |
|
|
55
|
+
| `zoom` | `number \| undefined` | no | The zoom of the map. |
|
|
46
56
|
|
|
47
57
|
### Types
|
|
48
58
|
|
|
49
|
-
|
|
59
|
+
- `PolygonOptions` -> `interface PolygonOptions {
|
|
60
|
+
strokeColor: string;
|
|
61
|
+
strokeOpacity: number;
|
|
62
|
+
strokeWeight: number;
|
|
63
|
+
fillColor: string;
|
|
64
|
+
fillOpacity: number;
|
|
65
|
+
clickable: boolean;
|
|
66
|
+
draggable: boolean;
|
|
67
|
+
editable: boolean;
|
|
68
|
+
visible: boolean;
|
|
69
|
+
radius: number;
|
|
70
|
+
zIndex: number;
|
|
71
|
+
}`
|
|
72
|
+
- `Position` -> `interface Position {
|
|
73
|
+
lat: number;
|
|
74
|
+
lng: number;
|
|
75
|
+
}`
|
|
50
76
|
|
|
51
77
|
### Usage Notes
|
|
52
78
|
|
|
53
79
|
- Import `PositionInput` directly from `@chayns-components/maps` instead of internal source paths.
|
|
54
80
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
81
|
+
- Pay special attention to required props: `apiToken`.
|
|
55
82
|
|
|
56
83
|
### Anti Patterns
|
|
57
84
|
|
|
58
85
|
- Avoid imports from internal paths such as `@chayns-components/maps/src/...`; always use the public package export.
|
|
86
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chayns-components/maps",
|
|
3
|
-
"version": "5.5.
|
|
3
|
+
"version": "5.5.28",
|
|
4
4
|
"description": "A set of beautiful React components for developing your own applications with chayns.",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"browserslist": [
|
|
@@ -70,7 +70,7 @@
|
|
|
70
70
|
"typescript": "^5.9.3"
|
|
71
71
|
},
|
|
72
72
|
"dependencies": {
|
|
73
|
-
"@chayns-components/core": "^5.5.
|
|
73
|
+
"@chayns-components/core": "^5.5.28",
|
|
74
74
|
"@googlemaps/react-wrapper": "^1.2.0",
|
|
75
75
|
"@googlemaps/typescript-guards": "^2.0.3",
|
|
76
76
|
"@react-google-maps/api": "^2.20.8",
|
|
@@ -87,5 +87,5 @@
|
|
|
87
87
|
"publishConfig": {
|
|
88
88
|
"access": "public"
|
|
89
89
|
},
|
|
90
|
-
"gitHead": "
|
|
90
|
+
"gitHead": "20b5354c0ee43c56e9919589f6b3bad7cf6b14bb"
|
|
91
91
|
}
|