Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for markers, icons, and template docs for all supported elements #31

Merged
merged 1 commit into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/content/api/l-base-layers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "Base layers"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



35 changes: 35 additions & 0 deletions docs/content/api/l-control-layers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "Control layers"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



35 changes: 35 additions & 0 deletions docs/content/api/l-div-icon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "DivIcon"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



35 changes: 35 additions & 0 deletions docs/content/api/l-geojson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "GeoJSON"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



50 changes: 50 additions & 0 deletions docs/content/api/l-icon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
+++
title = "Icon"
+++

HTML equivalent to `L.icon` function.
Can be a child of `l-map` or `l-layer-group` elements.

## Example

A standard way to initialise.

```html
<l-icon icon-url="/icon.png"></l-icon>
```

```html
<l-icon
icon-url="/icons/leaf-green.png"
shadow-url="/icons/leaf-shadow.png"
icon-size="[38, 95]"
shadow-size="[50, 64]"
icon-anchor="[22, 94]"
shadow-anchor="[4, 62]"
popup-anchor="[-3, -76]"
></l-icon>
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| icon-url | image.png | URL to define icon image |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| opacity | number | 1.0 |
| icon | string | JSON options to `setIcon` method |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| l:layer:connected | | Triggered when connected to the document |



35 changes: 35 additions & 0 deletions docs/content/api/l-lat-lng-bounds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "LatLngBounds"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



38 changes: 38 additions & 0 deletions docs/content/api/l-marker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
+++
title = "Marker"
+++

HTML equivalent to `L.marker` function.
Can be a child of `l-map` or `l-layer-group` elements.

## Example

A standard way to initialise.

```html
<l-marker lat-lng="[0,0]"></l-marker>
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| lat-lng | [45, 45] | LatLng position to define location |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| opacity | number | 1.0 |
| icon | string | JSON options to `setIcon` method |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| l:layer:connected | | Triggered when connected to the document |



35 changes: 35 additions & 0 deletions docs/content/api/l-overlay-layers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "Overlay layers"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



35 changes: 35 additions & 0 deletions docs/content/api/l-pane.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "DivIcon"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



35 changes: 35 additions & 0 deletions docs/content/api/l-popup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
+++
title = "DivIcon"
+++

HTML equivalent to `L.` function.

## Example

A standard way to initialise.

```html
```

## Parameters

Mandatory HTML properties to successfully instantiate.

| Attribute | Example | Description |
| -- | -- | -- |
| | | |

## Properties

| Attribute | Type | Description |
| -- | -- | -- |
| | | |

## Events

| Event key | Detail | Description |
| -- | -- | -- |
| | | |



Loading