pennsieve-dashboard 0.3.4 → 0.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -355,6 +355,38 @@ const dashboardOptions = ref({
355
355
  - Dashboard styling can be overridden using **CSS variables**.
356
356
  - Customize colors, spacing, and UI elements to match your application’s theme.
357
357
 
358
+ ### URL Parameters (Multi-Dashboard)
359
+
360
+ When using `DashboardWrap` (the multi-tab dashboard), you can pass URL query parameters to deep-link to a specific tab and pre-select genes. This is useful for sharing direct links to a particular view.
361
+
362
+ | Parameter | Required | Description |
363
+ |-------------|----------|-------------|
364
+ | `dashboard` | No | Name of the dashboard tab to activate (matched case-insensitively, spaces ignored) |
365
+ | `gene` | No | Initial gene for widgets that accept `initialGene` / `initialGene1` |
366
+ | `gene2` | No | Initial second gene for widgets that accept `initialGene2` (e.g. co-expression) |
367
+
368
+ **Examples:**
369
+
370
+ ```
371
+ # Open the "Side By Side" tab (spaces are ignored, so all of these work)
372
+ ?dashboard=SideBySide
373
+ ?dashboard=sidebyside
374
+ ?dashboard=Side%20By%20Side
375
+
376
+ # Pre-select a gene across all widgets
377
+ ?gene=TAC1
378
+
379
+ # Open a specific tab with a pre-selected gene
380
+ ?dashboard=GeneDistribution&gene=SCN10A
381
+
382
+ # Pre-select two genes for co-expression views
383
+ ?gene=SCN10A&gene2=TRPV1
384
+ ```
385
+
386
+ When no URL parameters are present, behavior is unchanged — the dashboard uses its default tab and widget configuration.
387
+
388
+ ---
389
+
358
390
  ## Contributing
359
391
  ## Contributing
360
392