Merge pull request #74 from andymchugh/sametab

same tab links

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 1.x.0
 
+Link in the Same Tab
+--------------------
+This adds the ability to configure links to open in the same tab rather than a new tab.
+It can be set at the cell, panel or site level. New config terms in siteConfig and panelConfig:
+- siteConfig:linkWindow
+- panelConfig:linkWindow
+- panelConfig:cells.cell-name.link.sameTab
+
 Link Variables
 ---------------
 This adds the ability to define link url substitutions to simplify oft-repeated base urls

provisioning/dashboardData/linksSameTabPanel.yaml

@@ -0,0 +1,12 @@
+---
+
+#------------------------------------------------------------------------------
+# Panel Config
+
+cellIdPreamble: "cell-"
+
+cells: 
+  website:
+    link:
+      url: "https://github.com/andymchugh/andrewbmchugh-flow-panel"
+      params: null

provisioning/dashboardData/linksSameTabPanelCellSet.yaml

@@ -0,0 +1,13 @@
+---
+
+#------------------------------------------------------------------------------
+# Panel Config
+
+cellIdPreamble: "cell-"
+
+cells: 
+  website:
+    link:
+      url: "https://github.com/andymchugh/andrewbmchugh-flow-panel"
+      params: null
+      sameTab: true

provisioning/dashboardData/linksSameTabPanelSet.yaml

@@ -0,0 +1,15 @@
+---
+
+#------------------------------------------------------------------------------
+# Panel Config
+
+cellIdPreamble: "cell-"
+
+linkWindow:
+  sameTab: true
+
+cells: 
+  website:
+    link:
+      url: "https://github.com/andymchugh/andrewbmchugh-flow-panel"
+      params: null

provisioning/dashboardData/linksSameTabSiteSet.yaml

@@ -0,0 +1,7 @@
+---
+
+#------------------------------------------------------------------------------
+# Site Config
+
+linkWindow:
+  sameTab: true

src/components/Config.tsx

@@ -23,6 +23,7 @@ export type Threshold = {
 export type Link = {
   url: string;
   params: LinkUrlParams;
+  sameTab: boolean | undefined;
 };
 
 export type Background = {
@@ -128,9 +129,14 @@ export type ZoomPanPinch = {
   wheelActivationKeys: string[] | undefined;
 };
 
+type LinkWindow = {
+  sameTab: boolean;
+};
+
 export type SiteConfig = {
   zoomPanPinch: ZoomPanPinch;
   variableThresholdScalars: Map<string, VariableThresholdScalars[]>;
+  linkWindow: LinkWindow,
   linkVariables: Map<string, string>;
   links: Map<string, Link>;
   colors: Map<string, string>;
@@ -141,6 +147,7 @@ export type SiteConfig = {
 export type PanelConfig = {
   test: TestConfig;
   zoomPanPinch: ZoomPanPinch;
+  linkWindow: LinkWindow,
   linkVariables: Map<string, string>;
   background: Background;
   animationsPresent: boolean;
@@ -183,6 +190,7 @@ export function panelConfigFactory(config: any) {
   return {
     test: config.test || {},
     zoomPanPinch: config.zoomPanPinch || {},
+    linkWindow: config.linkWindow,
     linkVariables: new Map<string, string>(Object.entries(config.linkVariables || {})),
     background: config.background || {},
     variableThresholdScalars: new Map<string, VariableThresholdScalars[]>(Object.entries(config.variableThresholdScalars || {})),
@@ -200,6 +208,7 @@ export function siteConfigFactory(config: any) {
   config = config || {};
   return {
     zoomPanPinch: config.zoomPanPinch || {},
+    linkWindow: config.linkWindow,
     linkVariables: new Map<string, string>(Object.entries(config.linkVariables || {})),
     links: new Map<string, Link>(Object.entries(config.links || {})),
     colors: new Map<string, string>(Object.entries(config.colors || {})),
@@ -255,9 +264,15 @@ function panelConfigDereference(siteConfig: SiteConfig, panelConfig: PanelConfig
     colorBlend(cell, 'strokeColor', cell.strokeColorCompound);
     colorBlend(cell, 'fillColor', cell.fillColorCompound);
 
+    // Links
     if (!cell.link && cell.linkRef) {
       cell.link = siteConfig.links.get(cell.linkRef);
     }
+    if (cell.link) {
+      cell.link.sameTab = typeof cell.link.sameTab === 'boolean' ? cell.link.sameTab :
+        typeof panelConfig.linkWindow?.sameTab === 'boolean' ? panelConfig.linkWindow.sameTab :
+        typeof siteConfig.linkWindow?.sameTab === 'boolean' ? siteConfig.linkWindow.sameTab : false;
+    }
 
     if (cell.label) {
       if (typeof cell.label.decimalPoints === 'undefined') {

src/components/FlowPanel.tsx

@@ -83,7 +83,8 @@ function clickHandlerFactory(elementAttribs: Map<string, SvgElementAttribs>, lin
       if (link) {
         const url = constructUrl(link, attribs, linkVariables);
         if (url) {
-          window.open(getTemplateSrv().replace(url));
+          const sameTarget = link.sameTab && !event.ctrlKey && !event.shiftKey;
+          window.open(getTemplateSrv().replace(url), (sameTarget ? '_self' : undefined));
         }
       }
     }

yaml_defs/panelConfig.yaml

@@ -42,6 +42,11 @@ zoomPanPinch:
   wheelActivationKeys: ["Alt"]
 
 #------------------------------------------------------------------------------
+# Version 1.14.0 onwards: This section defines panel level defaults for the link window
+linkWindow:
+  # Default for '<cell>.link.sameTab'.
+  sameTab: true
+
 # Version 1.14.0 onwards: Link variables will be substituted in urls prior to passing through
 # grafana variable substitution. Variables should be defined in the same format as grafana variables.
 # i.e. ${urlBasePlugin}. These variables can be defined in siteConfig or panelConfig.
@@ -408,7 +413,12 @@ cells:
       #         aren't available as grafana-variables.
       # 'all': all params will be appended
       params: "time"
-
+
+      # Version 1.14.0 onwards: When set the url will be opened in the same tab unless the
+      # <CTRL> or <SHFT> overrides are depressed. When undefined the setting falls back to
+      # the panel level 'linkWindow.sameTab' and then to the site level 'linkWindow.sameTab'.
+      sameTab: true
+
     # This defines an ID to a link defined in the siteConfig. If you want to share a
     # link just within the panelConfig you should instead use a yaml anchor/alias.
     # The above 'link' field takes precedence. Only if undefined will linkRef be

yaml_defs/siteConfig.yaml

@@ -20,6 +20,11 @@ variableThresholdScalars:
   environment:
     - {variableValuePattern: "dev", thresholdScalar: 0.2, cellIdPatternScope: ["inbox_depth"]}
 
+# Version 1.14.0 onwards: This section defines site level defaults for the link window
+linkWindow:
+  # Default for '<cell>.link.sameTab'.
+  sameTab: true
+
 # Version 1.14.0 onwards: Link variables will be substituted in urls prior to passing through
 # grafana variable substitution. Variables should be defined in the same format as grafana variables.
 # i.e. ${urlBasePlugin}. These variables can be defined in siteConfig or panelConfig.