From 1f7c7060c080a820ded1cab7bbe195fa25adbd5a Mon Sep 17 00:00:00 2001 From: andrewgryan Date: Thu, 18 Jul 2024 13:49:31 +0100 Subject: [PATCH] add blank docs for each supported custom element --- docs/content/api/l-base-layers.md | 35 +++++++++++++++++++ docs/content/api/l-control-layers.md | 35 +++++++++++++++++++ docs/content/api/l-div-icon.md | 35 +++++++++++++++++++ docs/content/api/l-geojson.md | 35 +++++++++++++++++++ docs/content/api/l-icon.md | 50 ++++++++++++++++++++++++++++ docs/content/api/l-lat-lng-bounds.md | 35 +++++++++++++++++++ docs/content/api/l-marker.md | 38 +++++++++++++++++++++ docs/content/api/l-overlay-layers.md | 35 +++++++++++++++++++ docs/content/api/l-pane.md | 35 +++++++++++++++++++ docs/content/api/l-popup.md | 35 +++++++++++++++++++ docs/content/api/l-tile-layer.md | 35 +++++++++++++++++++ docs/content/api/l-tooltip.md | 35 +++++++++++++++++++ docs/content/api/l-video-overlay.md | 35 +++++++++++++++++++ 13 files changed, 473 insertions(+) create mode 100644 docs/content/api/l-base-layers.md create mode 100644 docs/content/api/l-control-layers.md create mode 100644 docs/content/api/l-div-icon.md create mode 100644 docs/content/api/l-geojson.md create mode 100644 docs/content/api/l-icon.md create mode 100644 docs/content/api/l-lat-lng-bounds.md create mode 100644 docs/content/api/l-marker.md create mode 100644 docs/content/api/l-overlay-layers.md create mode 100644 docs/content/api/l-pane.md create mode 100644 docs/content/api/l-popup.md create mode 100644 docs/content/api/l-tile-layer.md create mode 100644 docs/content/api/l-tooltip.md create mode 100644 docs/content/api/l-video-overlay.md diff --git a/docs/content/api/l-base-layers.md b/docs/content/api/l-base-layers.md new file mode 100644 index 0000000..5c28ee5 --- /dev/null +++ b/docs/content/api/l-base-layers.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-control-layers.md b/docs/content/api/l-control-layers.md new file mode 100644 index 0000000..f330e9c --- /dev/null +++ b/docs/content/api/l-control-layers.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-div-icon.md b/docs/content/api/l-div-icon.md new file mode 100644 index 0000000..e1a9e05 --- /dev/null +++ b/docs/content/api/l-div-icon.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-geojson.md b/docs/content/api/l-geojson.md new file mode 100644 index 0000000..6f5beda --- /dev/null +++ b/docs/content/api/l-geojson.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-icon.md b/docs/content/api/l-icon.md new file mode 100644 index 0000000..9f20f42 --- /dev/null +++ b/docs/content/api/l-icon.md @@ -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 + +``` + +```html + +``` + +## 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 | + + + diff --git a/docs/content/api/l-lat-lng-bounds.md b/docs/content/api/l-lat-lng-bounds.md new file mode 100644 index 0000000..2f1c294 --- /dev/null +++ b/docs/content/api/l-lat-lng-bounds.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-marker.md b/docs/content/api/l-marker.md new file mode 100644 index 0000000..09c44cf --- /dev/null +++ b/docs/content/api/l-marker.md @@ -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 + +``` + +## 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 | + + + diff --git a/docs/content/api/l-overlay-layers.md b/docs/content/api/l-overlay-layers.md new file mode 100644 index 0000000..522848d --- /dev/null +++ b/docs/content/api/l-overlay-layers.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-pane.md b/docs/content/api/l-pane.md new file mode 100644 index 0000000..e1a9e05 --- /dev/null +++ b/docs/content/api/l-pane.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-popup.md b/docs/content/api/l-popup.md new file mode 100644 index 0000000..e1a9e05 --- /dev/null +++ b/docs/content/api/l-popup.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-tile-layer.md b/docs/content/api/l-tile-layer.md new file mode 100644 index 0000000..e1a9e05 --- /dev/null +++ b/docs/content/api/l-tile-layer.md @@ -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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-tooltip.md b/docs/content/api/l-tooltip.md new file mode 100644 index 0000000..bb3186f --- /dev/null +++ b/docs/content/api/l-tooltip.md @@ -0,0 +1,35 @@ ++++ +title = "Tooltip" ++++ + +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 | +| -- | -- | -- | +| | | | + + + diff --git a/docs/content/api/l-video-overlay.md b/docs/content/api/l-video-overlay.md new file mode 100644 index 0000000..4617bde --- /dev/null +++ b/docs/content/api/l-video-overlay.md @@ -0,0 +1,35 @@ ++++ +title = "Video overlay" ++++ + +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 | +| -- | -- | -- | +| | | | + + +