Update_to_0.6.1

leptos-leaflet/Cargo.toml

@@ -1,8 +1,12 @@
 [package]
 name = "leptos-leaflet"
-version = "0.6.1-beta"
+authors = ["Daniel Santana <[email protected]>", "Artur Leao <[email protected]>", "Lewin Probst <[email protected]>"]
+version = "0.6.1"
 edition = "2021"
 license = "MIT"
+repository = "https://github.com/headless-studio/leptos-leaflet"
+description = "Leaflet components to use in Leptos."
+readme = "../README.md"
 
 [dependencies]
 js-sys.workspace = true

leptos-leaflet/src/components/context.rs

@@ -13,24 +13,43 @@ impl LeafletMapContext {
         }
     }
 
+    /// Sets the map for the context.
+    ///
+    /// # Arguments
+    ///
+    /// * `map` - A reference to a `leaflet::Map` object.
     pub fn set_map(&self, map: &leaflet::Map) {
         self.map.set(Some(map.clone()));
     }
 
+    /// Returns an optional `leaflet::Map` instance.
     pub fn map(&self) -> Option<leaflet::Map> {
         self.map.get()
     }
 
+    /// Returns a signal that emits the current map instance.
     pub fn map_signal(&self) -> ReadSignal<Option<leaflet::Map>> {
         self.map.read_only()
     }
 
+    /// Adds a layer to the context.
+    ///
+    /// # Arguments
+    ///
+    /// * `layer` - A reference to the layer to be added.
+    ///
     pub fn add_layer<L: Into<leaflet::Layer> + Clone>(&self, layer: &L) {
         let map = self.map.get_untracked().expect("Map to be available");
         let layer: leaflet::Layer = layer.to_owned().into();
         layer.add_to(&map);
     }
 
+    /// Removes a layer from the context.
+    ///
+    /// # Arguments
+    ///
+    /// * `layer` - A reference to the layer to be removed.
+    ///
     pub fn remove_layer<L: Into<leaflet::Layer> + Clone>(&self, layer: &L) {
         let map = self.map.get_untracked().expect("Map to be available");
         let layer: leaflet::Layer = layer.to_owned().into();
@@ -44,38 +63,49 @@ impl Default for LeafletMapContext {
     }
 }
 
+/// Provides the Leaflet map context.
 pub fn provide_leaflet_context() -> LeafletMapContext {
     let context = LeafletMapContext::new();
     provide_context(context);
     context
 }
 
+/// Returns an optional `LeafletMapContext` object that can be used to access the current state of the Leaflet map.
 pub fn use_leaflet_context() -> Option<LeafletMapContext> {
     use_context::<LeafletMapContext>()
 }
 
+/// Extends the context with an overlay container.
 pub fn extend_context_with_overlay() -> LeafletOverlayContainerContext {
     let overlay_context = LeafletOverlayContainerContext::new();
     provide_context(overlay_context);
     overlay_context
 }
 
+/// Returns an optional `LeafletOverlayContainerContext` for the current overlay.
 pub fn use_overlay_context() -> Option<LeafletOverlayContainerContext> {
     use_context::<LeafletOverlayContainerContext>()
 }
 
+/// Returns an optional `leafet::Layer` for the overlay context layer.
 pub fn use_overlay_context_layer<T>() -> Option<T>
 where
     T: Into<leaflet::Layer> + Clone + JsCast,
 {
     expect_context::<LeafletOverlayContainerContext>().container::<T>()
 }
 
+/// Updates the overlay context with the given layer.
+/// 
+/// # Arguments
+/// 
+/// * `layer` - A cloneable object that can be converted into a `leaflet::Layer`.
 pub fn update_overlay_context<C: Into<leaflet::Layer> + Clone>(layer: &C) {
     let overlay_context = use_context::<LeafletOverlayContainerContext>().expect("overlay context");
     overlay_context.set_container(layer);
 }
 
+/// A context struct for Leaflet overlay container.
 #[derive(Debug, Clone, Copy)]
 pub struct LeafletOverlayContainerContext {
     container: RwSignal<Option<leaflet::Layer>>,
@@ -110,4 +140,4 @@ impl Default for LeafletOverlayContainerContext {
     fn default() -> Self {
         Self::new()
     }
-}
+}