Skip to content

Commit 534ef83

Browse files
committed
docs: add CustomMarker content
1 parent 5f9a8f9 commit 534ef83

3 files changed

Lines changed: 80 additions & 2 deletions

File tree

docs/astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export default defineConfig({
4444
link: '/docs/api/marker',
4545
},
4646
{
47-
label: 'CustomMarker 🛠',
47+
label: 'CustomMarker',
4848
link: '/docs/api/custom-marker',
4949
},
5050
{
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { CustomMarker, GoogleMap } from "react-google-map-wrapper";
2+
3+
import { Container } from "../../Container";
4+
5+
export function CustomMarkerEx() {
6+
return (
7+
<Container>
8+
<GoogleMap
9+
className='h-[400px]'
10+
containerProps={{
11+
id:'my-map'
12+
}}
13+
zoom={13}
14+
center={{ lat: 37.5111158, lng: 127.098167 }}
15+
mapOptions={{
16+
mapTypeId: 'satellite',
17+
}}
18+
>
19+
<CustomMarker lat={37.5111158} lng={127.098167}>
20+
<div className='px-5 py-3 rounded bg-[#0af] text-lg text-white'>
21+
$ 2.5
22+
</div>
23+
</CustomMarker>
24+
{/* draggable */}
25+
<CustomMarker lat={37.5111158} lng={127.05} draggable>
26+
<div className='px-5 py-3 rounded bg-[#0af] text-lg text-white'>
27+
$ 2.5 (draggable)
28+
</div>
29+
</CustomMarker>
30+
</GoogleMap>
31+
</Container>
32+
)
33+
}

docs/src/content/docs/docs/api/custom-marker.mdx

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,49 @@ title: CustomMarker
33
description: description
44
---
55

6-
🛠🛠🛠 This documentation is currently in progress. 🛠🛠🛠
6+
import { CustomMarkerEx } from '../../../../components/api/CustomMarker';
7+
8+
`<CustomMarker />` component is used for display Maker with Custom React Element.
9+
10+
### Basic Example
11+
12+
```tsx
13+
function MyMap() {
14+
return (
15+
<GoogleMap
16+
center={{ lat: 37.5111158, lng: 127.098167 }}
17+
{...}
18+
>
19+
<CustomMarker lat={37.5111158} lng={127.098167}>
20+
<div className='px-5 py-3 rounded bg-white text-lg text-black'>
21+
$ 2.5
22+
</div>
23+
</CustomMarker>
24+
{/* draggable */}
25+
<CustomMarker lat={37.5111158} lng={127.05} draggable>
26+
<div className='px-5 py-3 rounded bg-[#0af] text-lg text-white'>
27+
$ 2.5 (draggable)
28+
</div>
29+
</CustomMarker>
30+
</GoogleMap>
31+
);
32+
}
33+
```
34+
35+
<CustomMarkerEx client:only='react' />
36+
37+
### Props
38+
39+
| Props | Type | Description |
40+
| ----------- | ----------- | ----------- |
41+
| lat | `number` | latitude |
42+
| lng | `number` | longitude |
43+
| draggable | `boolean` | flag for draggable feature |
44+
| preventDragOnClickable | `boolean` | prevent drag event on clickable element. (e.g. a tag, button tag) |
45+
| onDragStart | `(position: google.maps.LatLngLiteral) => void` | callback for `dragstart` event. |
46+
| onDrag | `(position: google.maps.LatLngLiteral) => void` | callback for `drag` event. |
47+
| onDragEnd | `(position: google.maps.LatLngLiteral) => void` | callback for `dragend` event. |
48+
49+
### Alternative
50+
51+
You can also display custom element with [AdvancedMarker](/react-google-map-wrapper/docs/api/advanced-marker).

0 commit comments

Comments
 (0)