@sjcrh/proteinpaint-types 2.88.0 → 2.89.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjcrh/proteinpaint-types",
-  "version": "2.88.0",
+  "version": "2.89.0",
   "type": "module",
   "description": "Shared type definitions between ProteinPaint server and client code",
   "main": "src/index.ts",

package/src/dataset.ts

@@ -1214,26 +1214,41 @@ type MassNav = {
 	title?: Title
 	/** Customization for the tabs*/
 	tabs?: {
-		/** about, charts, groups, and fitler */
+		/** supported keys: about, charts, groups, filter
+		invalid key is ignored
+		when dslabel is too long to show in about tab middl row or to define alternative label, do .tabs:{about:{mid:'alt label'}}
+		*/
 		[index: string]: {
 			/** show in a specific order of tabs */
 			order?: number
 			/** label appearing in the top row in upper case */
 			top?: string
-			/** biggest label appearing in the middle row in upper case */
+			/** biggest label appearing in the middle row */
 			mid?: string
 			/** label appearing in the bottom row*/
 			btm?: string
 			/** if true, does not show the tab */
 			hide?: boolean
-			/** html code, specifically for the about tab
+			/** static html contents to show specifically in "about" tab subheader
 			 * maybe used for other tabs as well.
 			 */
 			html?: string
+			/** "active" items, shown as clickable buttons in about tab. click an item to launch a plot */
+			activeItems?: {
+				items: ActiveItem[]
+				// can add holderStyle to customize
+			}
 		}
 	}
 }
 
+type ActiveItem = {
+	/** string or html to show inside the button for the item, potentially allow to include <image> as logo */
+	title: string
+	/** plot object describing the plot to be launched */
+	plot: object
+}
+
 type Title = {
 	text: string
 	link?: string