leptos-leaflet 0.10.2

Leaflet components to use in Leptos.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use leaflet::{CanvasOptions, SvgOptions};
use leptos::context::Provider;
use leptos::prelude::*;
use web_sys::HtmlElement;

use super::use_leaflet_context;
use crate::core::JsStoredValue;
use tracing::debug;

/// Strategy for determining which pane to use for popup and tooltip rendering.
///
/// This enum allows users to explicitly choose how popups and tooltips determine their pane:
/// - Use a custom pane name
/// - Use the pane context from parent components
/// - Use Leaflet's default behavior
#[derive(Debug, Clone, PartialEq)]
pub enum PaneStrategy {
    /// Use a custom pane name (can be reactive)
    Custom(Signal<String>),
    /// Use the pane context from parent Pane components
    Context,
    /// Use Leaflet's default pane behavior
    Default,
}

impl Default for PaneStrategy {
    fn default() -> Self {
        Self::Context
    }
}

/// Specifies the rendering scope for vector layers within a pane
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PaneRendererScope {
    /// Use the map's global renderer (no pane-specific renderer created)
    Global,
    /// Create a pane-specific SVG renderer for all child vector layers
    PaneSpecificSvg,
    /// Create a pane-specific Canvas renderer for all child vector layers
    PaneSpecificCanvas,
}

impl Default for PaneRendererScope {
    fn default() -> Self {
        Self::Global
    }
}

/// Context for pane information that child components can use
#[derive(Debug, Clone)]
pub struct PaneContext {
    name: String,
    renderer_scope: PaneRendererScope,
    svg_renderer: JsStoredValue<Option<leaflet::Svg>>,
    canvas_renderer: JsStoredValue<Option<leaflet::Canvas>>,
}

impl PaneContext {
    pub fn new(name: String) -> Self {
        Self {
            name,
            renderer_scope: PaneRendererScope::Global,
            svg_renderer: JsStoredValue::new_local(None),
            canvas_renderer: JsStoredValue::new_local(None),
        }
    }

    pub fn new_with_renderer(
        name: String,
        renderer_scope: PaneRendererScope,
        svg_renderer: JsStoredValue<Option<leaflet::Svg>>,
        canvas_renderer: JsStoredValue<Option<leaflet::Canvas>>,
    ) -> Self {
        Self {
            name,
            renderer_scope,
            svg_renderer,
            canvas_renderer,
        }
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn renderer_scope(&self) -> &PaneRendererScope {
        &self.renderer_scope
    }

    /// Gets the SVG renderer if available
    pub fn svg_renderer(&self) -> Option<leaflet::Svg> {
        self.svg_renderer.get_value()
    }

    /// Gets the Canvas renderer if available
    pub fn canvas_renderer(&self) -> Option<leaflet::Canvas> {
        self.canvas_renderer.get_value()
    }
}

/// Provides pane context for child components
pub fn provide_pane_context(name: String) -> PaneContext {
    let context = PaneContext::new(name);
    provide_context(context.clone());
    context
}

/// Provides pane context with renderer for child components
pub fn provide_pane_context_with_renderer(
    name: String,
    renderer_scope: PaneRendererScope,
    svg_renderer: JsStoredValue<Option<leaflet::Svg>>,
    canvas_renderer: JsStoredValue<Option<leaflet::Canvas>>,
) -> PaneContext {
    let context =
        PaneContext::new_with_renderer(name, renderer_scope, svg_renderer, canvas_renderer);
    provide_context(context.clone());
    context
}

/// Gets the current pane context if available
pub fn use_pane_context() -> Option<PaneContext> {
    use_context::<PaneContext>()
}

/// A Leaflet pane component that creates a custom map pane for organizing layers with custom z-index ordering.
///
/// Panes allow you to control the stacking order of different map layers. Child components of this pane
/// will automatically use this pane unless they specify their own pane name.
///
/// # Examples
///
/// Basic usage with custom z-index:
/// ```rust,no_run
/// use leptos::prelude::*;
/// use leptos_leaflet::prelude::*;
///
/// #[component]
/// fn App() -> impl IntoView {
///     let z_index = Signal::derive(|| 550.0);
///
///     view! {
///         <MapContainer center=Position::new(51.505, -0.09) zoom=13.0>
///             <TileLayer url="https://tile.openstreetmap.org/{z}/{x}/{y}.png" />
///
///             <Pane name="custom-pane" z_index=z_index>
///                 <Circle
///                     center=position!(51.505, -0.09)
///                     radius=300.0
///                     color="red"
///                     fill_color="pink"
///                 />
///                 <Marker position=position!(51.506, -0.088) />
///             </Pane>
///         </MapContainer>
///     }
/// }
/// ```
///
/// Usage with explicit SVG renderer:
/// ```rust,no_run
/// use leptos::prelude::*;
/// use leptos_leaflet::prelude::*;
///
/// #[component]
/// fn SvgRendererExample() -> impl IntoView {
///     view! {
///         <MapContainer center=Position::new(51.505, -0.09) zoom=13.0>
///             <TileLayer url="https://tile.openstreetmap.org/{z}/{x}/{y}.png" />
///
///             <Pane name="svg-pane" z_index=Signal::derive(|| 600.0) renderer=PaneRendererScope::PaneSpecificSvg>
///                 <Circle
///                     center=position!(51.505, -0.09)
///                     radius=200.0
///                     color="blue"
///                     fill_color="lightblue"
///                 />
///                 <Polygon
///                     positions=positions(&[(51.500, -0.086), (51.510, -0.086), (51.510, -0.096)])
///                     color="green"
///                     fill_color="lightgreen"
///                 />
///             </Pane>
///         </MapContainer>
///     }
/// }
/// ```
///
/// Usage with explicit Canvas renderer:
/// ```rust,no_run
/// use leptos::prelude::*;
/// use leptos_leaflet::prelude::*;
///
/// #[component]
/// fn CanvasRendererExample() -> impl IntoView {
///     view! {
///         <MapContainer center=Position::new(51.505, -0.09) zoom=13.0>
///             <TileLayer url="https://tile.openstreetmap.org/{z}/{x}/{y}.png" />
///
///             <Pane name="canvas-pane" z_index=Signal::derive(|| 650.0) renderer=PaneRendererScope::PaneSpecificCanvas>
///                 <Polyline
///                     positions=positions(&[(51.505, -0.09), (51.51, -0.1), (51.51, -0.12)])
///                     color="red"
///                     weight=4.0
///                 />
///                 <Circle
///                     center=position!(51.505, -0.09)
///                     radius=150.0
///                     color="orange"
///                     fill_color="yellow"
///                 />
///             </Pane>
///         </MapContainer>
///     }
/// }
/// ```
///
/// Multiple panes with different z-indices:
/// ```rust,no_run
/// use leptos::prelude::*;
/// use leptos_leaflet::prelude::*;
///
/// #[component]
/// fn MultiPaneExample() -> impl IntoView {
///     view! {
///         <MapContainer center=Position::new(51.505, -0.09) zoom=13.0>
///             <TileLayer url="https://tile.openstreetmap.org/{z}/{x}/{y}.png" />
///
///             // Background pane (lowest z-index)
///             <Pane name="background" z_index=Signal::derive(|| 350.0)>
///                 <Circle
///                     center=position!(51.505, -0.09)
///                     radius=500.0
///                     color="blue"
///                     fill_opacity=0.3
///                 />
///             </Pane>
///
///             // Foreground pane (higher z-index)
///             <Pane name="foreground" z_index=Signal::derive(|| 650.0)>
///                 <Polygon
///                     positions=positions(&[(51.500, -0.086), (51.510, -0.086), (51.510, -0.096)])
///                     color="green"
///                     fill_color="lightgreen"
///                 />
///             </Pane>
///         </MapContainer>
///     }
/// }
/// ```
///
/// # Default Z-Index Values
///
/// Leaflet uses the following default z-index values:
/// - Tile layers: 200
/// - Overlay pane (default for vector layers): 400
/// - Shadow pane: 500
/// - Marker pane: 600
/// - Popup pane: 700
///
/// Choose your custom z-index values relative to these defaults.
#[component(transparent)]
pub fn Pane(
    /// Name of the pane (must be unique)
    #[prop(into)]
    name: String,
    /// Z-index for the pane (optional, controls stacking order)
    #[prop(into, optional)]
    z_index: Option<Signal<f64>>,
    /// Renderer scope for this pane (optional)
    /// - None (default): Uses the map's global renderer (no pane-specific renderer)
    /// - PaneRendererScope::PaneSpecificSvg: Creates a pane-specific SVG renderer for child vector layers
    /// - PaneRendererScope::PaneSpecificCanvas: Creates a pane-specific Canvas renderer for child vector layers
    #[prop(into, optional)]
    renderer: Option<PaneRendererScope>,
    /// Child components that should be rendered in this pane
    #[prop(optional)]
    children: Option<Children>,
) -> impl IntoView {
    let map_context = use_leaflet_context().expect("Pane must be used within a MapContainer");
    let name_clone = name.clone();

    // Store the pane element
    let pane_element = JsStoredValue::new_local(None::<HtmlElement>);

    // Create renderer storage
    let svg_renderer = JsStoredValue::new_local(None::<leaflet::Svg>);
    let canvas_renderer = JsStoredValue::new_local(None::<leaflet::Canvas>);

    let renderer_scope = renderer.unwrap_or(PaneRendererScope::Global);

    // Provide context for children - this is the key fix!
    // Each Pane provides its own context to its children
    debug!(
        "Providing pane context for: {} with renderer scope: {:?}",
        name_clone, renderer_scope
    );
    let _pane_context = provide_pane_context_with_renderer(
        name_clone.clone(),
        renderer_scope,
        svg_renderer.clone(),
        canvas_renderer.clone(),
    );

    Effect::new(move |_| {
        if let Some(map) = map_context.map() {
            debug!(
                "Creating pane: {} with renderer scope: {:?}",
                name, renderer_scope
            );

            // Create the pane
            let pane = map.create_pane_by_name(&name);

            // Set z-index if provided
            if let Some(z_idx) = z_index {
                let z_value = z_idx.get_untracked();
                let _ = pane.style().set_property("z-index", &z_value.to_string());
                debug!("Set z-index {} for pane: {}", z_value, name);
            }

            // Create and add renderer to map based on scope
            match &renderer_scope {
                PaneRendererScope::PaneSpecificSvg => {
                    let options = SvgOptions::default();
                    options.set_pane(name.clone());
                    let renderer = leaflet::Svg::with_options(&options);
                    renderer.add_to(&map);
                    svg_renderer.set_value(Some(renderer));
                    debug!(
                        "Created and stored pane-specific SVG renderer for pane: {}",
                        name
                    );
                }
                PaneRendererScope::PaneSpecificCanvas => {
                    let options = CanvasOptions::default();
                    options.set_pane(name.clone());
                    let renderer = leaflet::Canvas::with_options(&options);
                    renderer.add_to(&map);
                    canvas_renderer.set_value(Some(renderer));
                    debug!(
                        "Created and stored pane-specific Canvas renderer for pane: {}",
                        name
                    );
                }
                PaneRendererScope::Global => {
                    // Use global rendering - no pane-specific renderer needed
                    debug!("Using global renderer for pane: {}", name);
                }
            }

            pane_element.set_value(Some(pane));
            debug!("Finished creating pane: {}", name);
        }
    });

    // Watch for z-index changes
    if let Some(z_idx) = z_index {
        let z_index_effect = Effect::watch(
            move || z_idx.get(),
            move |&z_value, _, _| {
                if let Some(pane) = pane_element.get_value().as_ref() {
                    let _ = pane.style().set_property("z-index", &z_value.to_string());
                }
            },
            false,
        );

        on_cleanup(move || {
            z_index_effect.stop();
        });
    }

    on_cleanup(move || {
        if let Some(map) = map_context.map() {
            // Remove renderers from map
            if let Some(svg) = svg_renderer.get_value() {
                svg.remove_from(&map);
            }
            if let Some(canvas) = canvas_renderer.get_value() {
                canvas.remove_from(&map);
            }
        }

        if let Some(pane) = pane_element.get_value() {
            // Remove the pane from DOM
            if let Some(parent) = pane.parent_element() {
                let _ = parent.remove_child(&pane);
            }
        }
    });

    // Render children within a Provider to ensure proper context scoping
    view! {
        <Provider value=_pane_context>
            {children.map(|child| child())}
        </Provider>
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_pane_context_creation() {
        let context = PaneContext::new("test-pane".to_string());
        assert_eq!(context.name(), "test-pane");
        assert_eq!(*context.renderer_scope(), PaneRendererScope::Global);
    }

    #[test]
    fn test_pane_context_with_svg_renderer() {
        let svg_renderer = JsStoredValue::new_local(None);
        let canvas_renderer = JsStoredValue::new_local(None);
        let context = PaneContext::new_with_renderer(
            "svg-pane".to_string(),
            PaneRendererScope::PaneSpecificSvg,
            svg_renderer,
            canvas_renderer,
        );
        assert_eq!(context.name(), "svg-pane");
        assert_eq!(
            *context.renderer_scope(),
            PaneRendererScope::PaneSpecificSvg
        );
    }

    #[test]
    fn test_pane_context_with_canvas_renderer() {
        let svg_renderer = JsStoredValue::new_local(None);
        let canvas_renderer = JsStoredValue::new_local(None);
        let context = PaneContext::new_with_renderer(
            "canvas-pane".to_string(),
            PaneRendererScope::PaneSpecificCanvas,
            svg_renderer,
            canvas_renderer,
        );
        assert_eq!(context.name(), "canvas-pane");
        assert_eq!(
            *context.renderer_scope(),
            PaneRendererScope::PaneSpecificCanvas
        );
    }

    #[test]
    fn test_renderer_scope_default() {
        assert_eq!(PaneRendererScope::default(), PaneRendererScope::Global);
    }

    #[test]
    fn pane_strategy_default() {
        assert_eq!(PaneStrategy::default(), PaneStrategy::Context);
    }
}