more api docs

andrewgryan · Jul 19, 2024 · 534eb96 · 534eb96
1 parent fd23e3a
commit 534eb96
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 19 deletions.
diff --git a/docs/content/api/l-icon.md b/docs/content/api/l-icon.md
@@ -5,6 +5,8 @@ title = "Icon"
 HTML equivalent to `L.icon` function.
 Can be a child of `l-map` or `l-layer-group` elements.
 
+See [Leaflet docs](https://leafletjs.com/reference.html#icon).
+
 ## Example
 
 A standard way to initialise.
@@ -25,26 +27,39 @@ A standard way to initialise.
   ></l-icon>
 ```
 
+## Related elements
+
+- [l-marker](@/api/l-marker.md)
+
 ## Parameters
 
 Mandatory HTML properties to successfully instantiate.
 
-| Attribute | Example | Description |
-| -- | -- | -- |
-| icon-url | image.png | URL to define icon image |
+| Attribute         | Example   | Description              |
+| --                | --        | --                       |
 
 ## Properties
 
-| Attribute | Type    | Description |
-| --        | --      | --          |
-| opacity   | number  | 1.0         |
-| icon      | string | JSON options to `setIcon` method |
+| Attribute         | Type      | Description              |
+| --                | --        | --                       |
+| class-name        | string    | Custom class name        |
+| cross-origin      | bool      |                          |
+| icon-anchor       | Point     | Coordinates of the "tip" of the icon |
+| icon-retina-url   | string    |                          |
+| icon-size         | Point     | Size of the icon in pixels |
+| icon-url          | string    | URL to define icon image |
+| popup-anchor      | Point     |                          |
+| shadow-anchor     | Point     |                          |
+| shadow-retina-url | string    | Coordinates of the "tip" of the shadow |
+| shadow-size       | Point     | Size in pixels           |
+| shadow-url        | string    | Url for shadow, no shadow if not specified |
+| tooltip-anchor    | Point     | Coordinates relative to anchor |
 
 ## Events
 
 | Event key | Detail | Description |
 | -- | -- | -- |
-| l:layer:connected | | Triggered when connected to the document |
+| l:icon:connected | | Triggered when connected to the document |
 
 
 
diff --git a/docs/content/api/l-map.md b/docs/content/api/l-map.md
@@ -20,6 +20,10 @@ To detect mobile device location, zoom to it and enable location event handlers.
 </l-map>
 ```
 
+## Related elements
+
+- [l-pane](@/api/l-pane.md)
+
 ## Parameters
 
 Mandatory HTML properties to successfully instantiate a map.

diff --git a/docs/content/api/l-marker.md b/docs/content/api/l-marker.md
@@ -13,6 +13,13 @@ A standard way to initialise.
 <l-marker lat-lng="[0,0]"></l-marker>
 ```
 
+## Related elements
+
+- [l-div-icon](@/api/l-div-icon.md)
+- [l-icon](@/api/l-icon.md)
+- [l-popup](@/api/l-popup.md)
+- [l-tooltip](@/api/l-tooltip.md)
+
 ## Parameters
 
 Mandatory HTML properties to successfully instantiate.

diff --git a/docs/content/api/l-pane.md b/docs/content/api/l-pane.md
@@ -1,23 +1,32 @@
 +++
-title = "DivIcon"
+title = "Pane"
 +++
 
-HTML equivalent to `L.` function.
+HTML equivalent to `map.createPane(name)` function.
 
 ## Example
 
-A standard way to initialise.
+A standard way to initialise is inside a `<l-map>`.
 
 ```html
+<l-map ...>
+  <l-pane name="countries">
+    ...
+  </l-pane>
+</l-map>
 ```
 
+## Related elements
+
+- [l-map](@/api/l-map.md)
+
 ## Parameters
 
 Mandatory HTML properties to successfully instantiate.
 
-| Attribute | Example | Description |
-| --        | --      | --          |
-|           |         |             |
+| Attribute | Example   | Description              |
+| --        | --        | --                       |
+| name      | countries | Name to give custom pane |
 
 ## Properties
 
@@ -27,9 +36,9 @@ Mandatory HTML properties to successfully instantiate.
 
 ## Events
 
-| Event key | Detail  | Description |
-| --        | --      | --          |
-|           |         |             |
+| Event key        | Detail  | Description                          |
+| --               | --      | --                                   |
+| l:pane:connected |         | Triggered when connected to document |
 
 
 
diff --git a/docs/content/api/l-popup.md b/docs/content/api/l-popup.md
@@ -1,5 +1,5 @@
 +++
-title = "DivIcon"
+title = "Popup"
 +++
 
 HTML equivalent to `L.` function.

diff --git a/docs/content/api/l-tile-layer.md b/docs/content/api/l-tile-layer.md
@@ -1,5 +1,5 @@
 +++
-title = "DivIcon"
+title = "TileLayer"
 +++
 
 HTML equivalent to `L.` function.

diff --git a/docs/static/style.css b/docs/static/style.css
@@ -130,3 +130,8 @@ td, th {
   padding: var(--size-2);
   text-align: left;
 }
+
+:where(a):where(:not(:hover)) {
+  text-decoration: inherit;
+}
+