@perses-dev/components 0.31.0 → 0.32.0

package/dist/cjs/TimeSeriesTooltip/TooltipHeader.js

@@ -0,0 +1,174 @@
+// Copyright 2023 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "TooltipHeader", {
+    enumerable: true,
+    get: ()=>TooltipHeader
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _material = require("@mui/material");
+const _pin = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/Pin"));
+const _pinOutline = /*#__PURE__*/ _interopRequireDefault(require("mdi-material-ui/PinOutline"));
+const _react = require("react");
+const _timeZoneProvider = require("../context/TimeZoneProvider");
+const _tooltipModel = require("./tooltip-model");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const TooltipHeader = /*#__PURE__*/ (0, _react.memo)(function TooltipHeader({ nearbySeries , totalSeries , isTooltipPinned , showAllSeries , onShowAllClick , onUnpinClick  }) {
+    var ref;
+    const { formatWithUserTimeZone  } = (0, _timeZoneProvider.useTimeZone)();
+    var ref1;
+    const seriesTimeMs = (ref1 = (ref = nearbySeries[0]) === null || ref === void 0 ? void 0 : ref.date) !== null && ref1 !== void 0 ? ref1 : null;
+    if (seriesTimeMs === null) {
+        return null;
+    }
+    const formatTimeSeriesHeader = (timeMs)=>{
+        const date = new Date(timeMs);
+        const formattedDate = formatWithUserTimeZone(date, 'MMM dd, yyyy - ');
+        const formattedTime = formatWithUserTimeZone(date, 'HH:mm:ss');
+        return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+            children: [
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                    variant: "caption",
+                    sx: (theme)=>({
+                            color: theme.palette.common.white
+                        }),
+                    children: formattedDate
+                }),
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                    variant: "caption",
+                    children: /*#__PURE__*/ (0, _jsxRuntime.jsx)("strong", {
+                        children: formattedTime
+                    })
+                })
+            ]
+        });
+    };
+    // TODO: accurately calc whether more series are outside scrollable region using yBuffer, avg series name length, TOOLTIP_MAX_HEIGHT
+    const showAllSeriesToggle = totalSeries > 5;
+    var ref2;
+    return /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+        sx: (theme)=>{
+            var ref;
+            return {
+                width: '100%',
+                maxWidth: _tooltipModel.TOOLTIP_MAX_WIDTH,
+                padding: theme.spacing(1.5, 2, 0.5, 2),
+                backgroundColor: (ref2 = (ref = theme.palette.designSystem) === null || ref === void 0 ? void 0 : ref.grey[800]) !== null && ref2 !== void 0 ? ref2 : _tooltipModel.TOOLTIP_BG_COLOR_FALLBACK,
+                position: 'sticky',
+                top: 0,
+                left: 0
+            };
+        },
+        children: [
+            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Box, {
+                sx: {
+                    width: '100%',
+                    display: 'flex',
+                    justifyContent: 'start',
+                    alignItems: 'center',
+                    paddingBottom: 0.5
+                },
+                children: [
+                    formatTimeSeriesHeader(seriesTimeMs),
+                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                        direction: "row",
+                        gap: 1,
+                        sx: {
+                            marginLeft: 'auto'
+                        },
+                        children: [
+                            showAllSeriesToggle && /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                                direction: "row",
+                                gap: 0.5,
+                                alignItems: "center",
+                                sx: {
+                                    textAlign: 'right'
+                                },
+                                children: [
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Typography, {
+                                        sx: {
+                                            fontSize: 11
+                                        },
+                                        children: "Show All"
+                                    }),
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Switch, {
+                                        checked: showAllSeries,
+                                        size: "small",
+                                        onChange: (_, checked)=>{
+                                            if (onShowAllClick !== undefined) {
+                                                return onShowAllClick(checked);
+                                            }
+                                        },
+                                        sx: (theme)=>({
+                                                '& .MuiSwitch-switchBase': {
+                                                    color: theme.palette.common.white
+                                                },
+                                                '& .MuiSwitch-track': {
+                                                    backgroundColor: theme.palette.common.white
+                                                }
+                                            })
+                                    })
+                                ]
+                            }),
+                            /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Stack, {
+                                direction: "row",
+                                alignItems: "center",
+                                children: [
+                                    /*#__PURE__*/ (0, _jsxRuntime.jsxs)(_material.Typography, {
+                                        sx: {
+                                            marginRight: 0.5,
+                                            fontSize: 11,
+                                            verticalAlign: 'middle'
+                                        },
+                                        children: [
+                                            "Click to ",
+                                            isTooltipPinned ? 'Unpin' : 'Pin'
+                                        ]
+                                    }),
+                                    isTooltipPinned ? /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pin.default, {
+                                        onClick: ()=>{
+                                            if (onUnpinClick !== undefined) {
+                                                onUnpinClick();
+                                            }
+                                        },
+                                        sx: {
+                                            fontSize: 16,
+                                            cursor: 'pointer'
+                                        }
+                                    }) : /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pinOutline.default, {
+                                        sx: {
+                                            fontSize: 16
+                                        }
+                                    })
+                                ]
+                            })
+                        ]
+                    })
+                ]
+            }),
+            /*#__PURE__*/ (0, _jsxRuntime.jsx)(_material.Divider, {
+                sx: (theme)=>({
+                        width: '100%',
+                        borderColor: theme.palette.grey['500']
+                    })
+            })
+        ]
+    });
+});

package/dist/cjs/TimeSeriesTooltip/index.js

@@ -19,6 +19,7 @@ _exportStar(require("./SeriesInfo"), exports);
 _exportStar(require("./SeriesLabelsStack"), exports);
 _exportStar(require("./SeriesMarker"), exports);
 _exportStar(require("./TooltipContent"), exports);
+_exportStar(require("./TooltipHeader"), exports);
 _exportStar(require("./nearby-series"), exports);
 _exportStar(require("./tooltip-model"), exports);
 _exportStar(require("./utils"), exports);

package/dist/cjs/TimeSeriesTooltip/nearby-series.js

@@ -132,7 +132,7 @@ function checkforNearbySeries(data, pointInGrid, yBuffer, chart, unit) {
 }
 function getNearbySeriesData({ mousePos , pinnedPos , chartData , chart , unit , showAllSeries =false  }) {
     if (chart === undefined || mousePos === null) return [];
-    // prevents multiple tooltips showing from adjacent charts
+    // prevents multiple tooltips showing from adjacent charts unless tooltip is pinned
     let cursorTargetMatchesChart = false;
     if (mousePos.target !== null) {
         const currentParent = mousePos.target.parentElement;
@@ -146,7 +146,7 @@ function getNearbySeriesData({ mousePos , pinnedPos , chartData , chart , unit ,
             }
         }
     }
-    // allows moving cursor inside tooltip
+    // allows moving cursor inside tooltip without it fading away
     if (pinnedPos !== null) {
         mousePos = pinnedPos;
         cursorTargetMatchesChart = true;

package/dist/cjs/TimeSeriesTooltip/tooltip-model.js

@@ -29,6 +29,7 @@ _export(exports, {
     FALLBACK_CHART_WIDTH: ()=>FALLBACK_CHART_WIDTH,
     NEARBY_SERIES_DESCRIPTION: ()=>NEARBY_SERIES_DESCRIPTION,
     EMPHASIZED_SERIES_DESCRIPTION: ()=>EMPHASIZED_SERIES_DESCRIPTION,
+    TOOLTIP_BG_COLOR_FALLBACK: ()=>TOOLTIP_BG_COLOR_FALLBACK,
     TOOLTIP_DATE_FORMAT: ()=>TOOLTIP_DATE_FORMAT,
     defaultCursorData: ()=>defaultCursorData,
     emptyTooltipData: ()=>emptyTooltipData,
@@ -37,12 +38,13 @@ _export(exports, {
 const _react = require("react");
 const TOOLTIP_MIN_WIDTH = 375;
 const TOOLTIP_MAX_WIDTH = 650;
-const TOOLTIP_MAX_HEIGHT = 600;
+const TOOLTIP_MAX_HEIGHT = 650;
 const TOOLTIP_LABELS_MAX_WIDTH = TOOLTIP_MAX_WIDTH - 150;
 const TOOLTIP_ADJUST_Y_POS_MULTIPLIER = 0.75;
 const FALLBACK_CHART_WIDTH = 750;
 const NEARBY_SERIES_DESCRIPTION = 'nearby series showing in tooltip';
 const EMPHASIZED_SERIES_DESCRIPTION = 'emphasized series showing as bold in tooltip';
+const TOOLTIP_BG_COLOR_FALLBACK = '#2E313E';
 const TOOLTIP_DATE_FORMAT = new Intl.DateTimeFormat(undefined, {
     year: 'numeric',
     month: 'short',

package/dist/cjs/TimeSeriesTooltip/utils.js

@@ -23,11 +23,11 @@ function assembleTransform(mousePos, chartWidth, pinnedPos, tooltipHeight, toolt
     if (mousePos === null) {
         return 'translate3d(0, 0)';
     }
+    const cursorPaddingX = 32;
+    const cursorPaddingY = 16;
     if (pinnedPos !== null) {
         mousePos = pinnedPos;
     }
-    const cursorPaddingX = 32;
-    const cursorPaddingY = 16;
     // Tooltip is located in a Portal attached to the body.
     // Using page coordinates instead of viewport ensures the tooltip is
     // absolutely positioned correctly as the user scrolls

package/dist/cjs/index.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _exportStar(require("./ColorPicker"), exports);
+_exportStar(require("./ContentWithLegend"), exports);
 _exportStar(require("./DateTimeRangePicker"), exports);
 _exportStar(require("./Dialog"), exports);
 _exportStar(require("./Drawer"), exports);

package/dist/cjs/model/legend.js

@@ -22,10 +22,14 @@ function _export(target, all) {
 }
 _export(exports, {
     legendPositions: ()=>legendPositions,
+    legendModes: ()=>legendModes,
     LEGEND_POSITIONS_CONFIG: ()=>LEGEND_POSITIONS_CONFIG,
+    LEGEND_MODE_CONFIG: ()=>LEGEND_MODE_CONFIG,
     DEFAULT_LEGEND: ()=>DEFAULT_LEGEND,
     getLegendPosition: ()=>getLegendPosition,
     isValidLegendPosition: ()=>isValidLegendPosition,
+    isValidLegendMode: ()=>isValidLegendMode,
+    getLegendMode: ()=>getLegendMode,
     validateLegendSpec: ()=>validateLegendSpec,
     isLegendItemVisuallySelected: ()=>isLegendItemVisuallySelected
 });
@@ -33,6 +37,10 @@ const legendPositions = [
     'Bottom',
     'Right'
 ];
+const legendModes = [
+    'List',
+    'Table'
+];
 const LEGEND_POSITIONS_CONFIG = {
     Bottom: {
         label: 'Bottom'
@@ -41,8 +49,17 @@ const LEGEND_POSITIONS_CONFIG = {
         label: 'Right'
     }
 };
+const LEGEND_MODE_CONFIG = {
+    List: {
+        label: 'List'
+    },
+    Table: {
+        label: 'Table'
+    }
+};
 const DEFAULT_LEGEND = {
-    position: 'Bottom'
+    position: 'Bottom',
+    mode: 'List'
 };
 function getLegendPosition(position) {
     if (position === undefined) {
@@ -56,6 +73,15 @@ function getLegendPosition(position) {
 function isValidLegendPosition(position) {
     return legendPositions.includes(position);
 }
+function isValidLegendMode(mode) {
+    return legendModes.includes(mode);
+}
+function getLegendMode(mode) {
+    if (!mode || !isValidLegendMode(mode)) {
+        return DEFAULT_LEGEND.mode;
+    }
+    return mode;
+}
 function validateLegendSpec(legend) {
     if (legend === undefined) {
         // undefined is valid since this is how legend is hidden by default
@@ -64,6 +90,9 @@ function validateLegendSpec(legend) {
     if (!isValidLegendPosition(legend.position)) {
         return false;
     }
+    if (legend.mode && !isValidLegendMode(legend.mode)) {
+        return false;
+    }
     return true;
 }
 function isLegendItemVisuallySelected(item, selectedItems) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ColorPicker';
+export * from './ContentWithLegend';
 export * from './DateTimeRangePicker';
 export * from './Dialog';
 export * from './Drawer';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 export * from './ColorPicker';
+export * from './ContentWithLegend';
 export * from './DateTimeRangePicker';
 export * from './Dialog';
 export * from './Drawer';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nexport * from './ColorPicker';\nexport * from './DateTimeRangePicker';\nexport * from './Dialog';\nexport * from './Drawer';\nexport * from './EChart';\nexport * from './ErrorAlert';\nexport * from './ErrorBoundary';\nexport * from './GaugeChart';\nexport * from './InfoTooltip';\nexport * from './JSONEditor';\nexport * from './Legend';\nexport * from './LegendOptionsEditor';\nexport * from './LineChart';\nexport * from './OptionsEditorLayout';\nexport * from './StatChart';\nexport * from './Table';\nexport * from './ThresholdsEditor';\nexport * from './TimeSeriesTooltip';\nexport * from './UnitSelector';\nexport * from './YAxisLabel';\nexport * from './context/ChartsThemeProvider';\nexport * from './context/TimeZoneProvider';\nexport * from './context/SnackbarProvider';\nexport * from './utils';\nexport * from './model';\nexport * from './test-utils';\nexport * from './theme';\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nexport * from './ColorPicker';\nexport * from './ContentWithLegend';\nexport * from './DateTimeRangePicker';\nexport * from './Dialog';\nexport * from './Drawer';\nexport * from './EChart';\nexport * from './ErrorAlert';\nexport * from './ErrorBoundary';\nexport * from './GaugeChart';\nexport * from './InfoTooltip';\nexport * from './JSONEditor';\nexport * from './Legend';\nexport * from './LegendOptionsEditor';\nexport * from './LineChart';\nexport * from './OptionsEditorLayout';\nexport * from './StatChart';\nexport * from './Table';\nexport * from './ThresholdsEditor';\nexport * from './TimeSeriesTooltip';\nexport * from './UnitSelector';\nexport * from './YAxisLabel';\nexport * from './context/ChartsThemeProvider';\nexport * from './context/TimeZoneProvider';\nexport * from './context/SnackbarProvider';\nexport * from './utils';\nexport * from './model';\nexport * from './test-utils';\nexport * from './theme';\n"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/model/legend.d.ts

@@ -1,8 +1,11 @@
 import { MouseEventHandler } from 'react';
 export declare const legendPositions: readonly ["Bottom", "Right"];
 export declare type LegendPositions = (typeof legendPositions)[number];
+export declare const legendModes: readonly ["List", "Table"];
+export declare type LegendMode = (typeof legendModes)[number];
 export interface LegendOptions {
     position: LegendPositions;
+    mode?: LegendMode;
 }
 export interface LegendItem {
     id: string;
@@ -10,7 +13,7 @@ export interface LegendItem {
     color: string;
     onClick?: MouseEventHandler<HTMLElement>;
 }
-export declare type LegendPositionConfig = {
+export declare type LegendSingleSelectConfig = {
     label: string;
 };
 /**
@@ -21,10 +24,13 @@ export declare type LegendPositionConfig = {
  *   will be treated as selected and visually highlighted.
  */
 export declare type SelectedLegendItemState = Record<LegendItem['id'], boolean> | 'ALL';
-export declare const LEGEND_POSITIONS_CONFIG: Readonly<Record<LegendPositions, LegendPositionConfig>>;
-export declare const DEFAULT_LEGEND: LegendOptions;
+export declare const LEGEND_POSITIONS_CONFIG: Readonly<Record<LegendPositions, LegendSingleSelectConfig>>;
+export declare const LEGEND_MODE_CONFIG: Readonly<Record<LegendMode, LegendSingleSelectConfig>>;
+export declare const DEFAULT_LEGEND: Required<LegendOptions>;
 export declare function getLegendPosition(position?: LegendPositions): "Bottom" | "Right";
 export declare function isValidLegendPosition(position: LegendPositions): boolean;
+export declare function isValidLegendMode(mode: LegendMode): boolean;
+export declare function getLegendMode(mode?: LegendMode): "List" | "Table";
 export declare function validateLegendSpec(legend?: LegendOptions): boolean;
 export declare function isLegendItemVisuallySelected(item: LegendItem, selectedItems: SelectedLegendItemState): boolean;
 //# sourceMappingURL=legend.d.ts.map

package/dist/model/legend.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"legend.d.ts","sourceRoot":"","sources":["../../src/model/legend.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,eAAO,MAAM,eAAe,8BAA+B,CAAC;AAE5D,oBAAY,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAC1C;AAED,oBAAY,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,uBAAuB,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;AAEhF,eAAO,MAAM,uBAAuB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAG3F,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,aAE5B,CAAC;AAEF,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,sBAQ3D;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,WAE9D;AAED,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,aAAa,WASxD;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,uBAAuB,WAIpG"}
+{"version":3,"file":"legend.d.ts","sourceRoot":"","sources":["../../src/model/legend.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,eAAO,MAAM,eAAe,8BAA+B,CAAC;AAC5D,oBAAY,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,eAAO,MAAM,WAAW,4BAA6B,CAAC;AACtD,oBAAY,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,eAAe,CAAC;IAC1B,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAC1C;AAED,oBAAY,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,uBAAuB,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;AAEhF,eAAO,MAAM,uBAAuB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAG/F,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAGrF,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,aAAa,CAGlD,CAAC;AAEF,wBAAgB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,eAAe,sBAQ3D;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,WAE9D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,WAEjD;AAED,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,oBAM9C;AAED,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,aAAa,WAaxD;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,uBAAuB,WAIpG"}

package/dist/model/legend.js

@@ -14,6 +14,10 @@ export const legendPositions = [
     'Bottom',
     'Right'
 ];
+export const legendModes = [
+    'List',
+    'Table'
+];
 export const LEGEND_POSITIONS_CONFIG = {
     Bottom: {
         label: 'Bottom'
@@ -22,8 +26,17 @@ export const LEGEND_POSITIONS_CONFIG = {
         label: 'Right'
     }
 };
+export const LEGEND_MODE_CONFIG = {
+    List: {
+        label: 'List'
+    },
+    Table: {
+        label: 'Table'
+    }
+};
 export const DEFAULT_LEGEND = {
-    position: 'Bottom'
+    position: 'Bottom',
+    mode: 'List'
 };
 export function getLegendPosition(position) {
     if (position === undefined) {
@@ -37,6 +50,15 @@ export function getLegendPosition(position) {
 export function isValidLegendPosition(position) {
     return legendPositions.includes(position);
 }
+export function isValidLegendMode(mode) {
+    return legendModes.includes(mode);
+}
+export function getLegendMode(mode) {
+    if (!mode || !isValidLegendMode(mode)) {
+        return DEFAULT_LEGEND.mode;
+    }
+    return mode;
+}
 export function validateLegendSpec(legend) {
     if (legend === undefined) {
         // undefined is valid since this is how legend is hidden by default
@@ -45,6 +67,9 @@ export function validateLegendSpec(legend) {
     if (!isValidLegendPosition(legend.position)) {
         return false;
     }
+    if (legend.mode && !isValidLegendMode(legend.mode)) {
+        return false;
+    }
     return true;
 }
 export function isLegendItemVisuallySelected(item, selectedItems) {

package/dist/model/legend.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/model/legend.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { MouseEventHandler } from 'react';\n\nexport const legendPositions = ['Bottom', 'Right'] as const;\n\nexport type LegendPositions = (typeof legendPositions)[number];\n\nexport interface LegendOptions {\n  position: LegendPositions;\n}\n\nexport interface LegendItem {\n  id: string;\n  label: string;\n  color: string;\n  onClick?: MouseEventHandler<HTMLElement>;\n}\n\nexport type LegendPositionConfig = {\n  label: string;\n};\n\n/**\n * State of selected items in the legend.\n * - When \"ALL\", all legend items are selected, but not visually highlighted.\n * - Otherwise, it is a Record that associates legend item ids with a boolean\n *   value. When the associated entry for a legend item is `true`, that item\n *   will be treated as selected and visually highlighted.\n */\nexport type SelectedLegendItemState = Record<LegendItem['id'], boolean> | 'ALL';\n\nexport const LEGEND_POSITIONS_CONFIG: Readonly<Record<LegendPositions, LegendPositionConfig>> = {\n  Bottom: { label: 'Bottom' },\n  Right: { label: 'Right' },\n};\n\nexport const DEFAULT_LEGEND: LegendOptions = {\n  position: 'Bottom',\n};\n\nexport function getLegendPosition(position?: LegendPositions) {\n  if (position === undefined) {\n    return DEFAULT_LEGEND.position;\n  }\n  if (isValidLegendPosition(position)) {\n    return position;\n  }\n  return DEFAULT_LEGEND.position;\n}\n\nexport function isValidLegendPosition(position: LegendPositions) {\n  return (legendPositions as readonly string[]).includes(position);\n}\n\nexport function validateLegendSpec(legend?: LegendOptions) {\n  if (legend === undefined) {\n    // undefined is valid since this is how legend is hidden by default\n    return true;\n  }\n  if (!isValidLegendPosition(legend.position)) {\n    return false;\n  }\n  return true;\n}\n\nexport function isLegendItemVisuallySelected(item: LegendItem, selectedItems: SelectedLegendItemState) {\n  // In the \"ALL\" case, technically all legend items are selected, but we do\n  // not render them differently.\n  return selectedItems !== 'ALL' && !!selectedItems[item.id];\n}\n"],"names":["legendPositions","LEGEND_POSITIONS_CONFIG","Bottom","label","Right","DEFAULT_LEGEND","position","getLegendPosition","undefined","isValidLegendPosition","includes","validateLegendSpec","legend","isLegendItemVisuallySelected","item","selectedItems","id"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAIjC,OAAO,MAAMA,eAAe,GAAG;IAAC,QAAQ;IAAE,OAAO;CAAC,AAAS,CAAC;AA4B5D,OAAO,MAAMC,uBAAuB,GAA4D;IAC9FC,MAAM,EAAE;QAAEC,KAAK,EAAE,QAAQ;KAAE;IAC3BC,KAAK,EAAE;QAAED,KAAK,EAAE,OAAO;KAAE;CAC1B,CAAC;AAEF,OAAO,MAAME,cAAc,GAAkB;IAC3CC,QAAQ,EAAE,QAAQ;CACnB,CAAC;AAEF,OAAO,SAASC,iBAAiB,CAACD,QAA0B,EAAE;IAC5D,IAAIA,QAAQ,KAAKE,SAAS,EAAE;QAC1B,OAAOH,cAAc,CAACC,QAAQ,CAAC;IACjC,CAAC;IACD,IAAIG,qBAAqB,CAACH,QAAQ,CAAC,EAAE;QACnC,OAAOA,QAAQ,CAAC;IAClB,CAAC;IACD,OAAOD,cAAc,CAACC,QAAQ,CAAC;AACjC,CAAC;AAED,OAAO,SAASG,qBAAqB,CAACH,QAAyB,EAAE;IAC/D,OAAO,AAACN,eAAe,CAAuBU,QAAQ,CAACJ,QAAQ,CAAC,CAAC;AACnE,CAAC;AAED,OAAO,SAASK,kBAAkB,CAACC,MAAsB,EAAE;IACzD,IAAIA,MAAM,KAAKJ,SAAS,EAAE;QACxB,mEAAmE;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAACC,qBAAqB,CAACG,MAAM,CAACN,QAAQ,CAAC,EAAE;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,SAASO,4BAA4B,CAACC,IAAgB,EAAEC,aAAsC,EAAE;IACrG,0EAA0E;IAC1E,+BAA+B;IAC/B,OAAOA,aAAa,KAAK,KAAK,IAAI,CAAC,CAACA,aAAa,CAACD,IAAI,CAACE,EAAE,CAAC,CAAC;AAC7D,CAAC"}
+{"version":3,"sources":["../../src/model/legend.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { MouseEventHandler } from 'react';\n\nexport const legendPositions = ['Bottom', 'Right'] as const;\nexport type LegendPositions = (typeof legendPositions)[number];\n\nexport const legendModes = ['List', 'Table'] as const;\nexport type LegendMode = (typeof legendModes)[number];\n\nexport interface LegendOptions {\n  position: LegendPositions;\n  mode?: LegendMode;\n}\n\nexport interface LegendItem {\n  id: string;\n  label: string;\n  color: string;\n  onClick?: MouseEventHandler<HTMLElement>;\n}\n\nexport type LegendSingleSelectConfig = {\n  label: string;\n};\n\n/**\n * State of selected items in the legend.\n * - When \"ALL\", all legend items are selected, but not visually highlighted.\n * - Otherwise, it is a Record that associates legend item ids with a boolean\n *   value. When the associated entry for a legend item is `true`, that item\n *   will be treated as selected and visually highlighted.\n */\nexport type SelectedLegendItemState = Record<LegendItem['id'], boolean> | 'ALL';\n\nexport const LEGEND_POSITIONS_CONFIG: Readonly<Record<LegendPositions, LegendSingleSelectConfig>> = {\n  Bottom: { label: 'Bottom' },\n  Right: { label: 'Right' },\n};\n\nexport const LEGEND_MODE_CONFIG: Readonly<Record<LegendMode, LegendSingleSelectConfig>> = {\n  List: { label: 'List' },\n  Table: { label: 'Table' },\n};\n\nexport const DEFAULT_LEGEND: Required<LegendOptions> = {\n  position: 'Bottom',\n  mode: 'List',\n};\n\nexport function getLegendPosition(position?: LegendPositions) {\n  if (position === undefined) {\n    return DEFAULT_LEGEND.position;\n  }\n  if (isValidLegendPosition(position)) {\n    return position;\n  }\n  return DEFAULT_LEGEND.position;\n}\n\nexport function isValidLegendPosition(position: LegendPositions) {\n  return (legendPositions as readonly string[]).includes(position);\n}\n\nexport function isValidLegendMode(mode: LegendMode) {\n  return (legendModes as readonly string[]).includes(mode);\n}\n\nexport function getLegendMode(mode?: LegendMode) {\n  if (!mode || !isValidLegendMode(mode)) {\n    return DEFAULT_LEGEND.mode;\n  }\n\n  return mode;\n}\n\nexport function validateLegendSpec(legend?: LegendOptions) {\n  if (legend === undefined) {\n    // undefined is valid since this is how legend is hidden by default\n    return true;\n  }\n  if (!isValidLegendPosition(legend.position)) {\n    return false;\n  }\n  if (legend.mode && !isValidLegendMode(legend.mode)) {\n    return false;\n  }\n\n  return true;\n}\n\nexport function isLegendItemVisuallySelected(item: LegendItem, selectedItems: SelectedLegendItemState) {\n  // In the \"ALL\" case, technically all legend items are selected, but we do\n  // not render them differently.\n  return selectedItems !== 'ALL' && !!selectedItems[item.id];\n}\n"],"names":["legendPositions","legendModes","LEGEND_POSITIONS_CONFIG","Bottom","label","Right","LEGEND_MODE_CONFIG","List","Table","DEFAULT_LEGEND","position","mode","getLegendPosition","undefined","isValidLegendPosition","includes","isValidLegendMode","getLegendMode","validateLegendSpec","legend","isLegendItemVisuallySelected","item","selectedItems","id"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAIjC,OAAO,MAAMA,eAAe,GAAG;IAAC,QAAQ;IAAE,OAAO;CAAC,AAAS,CAAC;AAG5D,OAAO,MAAMC,WAAW,GAAG;IAAC,MAAM;IAAE,OAAO;CAAC,AAAS,CAAC;AA4BtD,OAAO,MAAMC,uBAAuB,GAAgE;IAClGC,MAAM,EAAE;QAAEC,KAAK,EAAE,QAAQ;KAAE;IAC3BC,KAAK,EAAE;QAAED,KAAK,EAAE,OAAO;KAAE;CAC1B,CAAC;AAEF,OAAO,MAAME,kBAAkB,GAA2D;IACxFC,IAAI,EAAE;QAAEH,KAAK,EAAE,MAAM;KAAE;IACvBI,KAAK,EAAE;QAAEJ,KAAK,EAAE,OAAO;KAAE;CAC1B,CAAC;AAEF,OAAO,MAAMK,cAAc,GAA4B;IACrDC,QAAQ,EAAE,QAAQ;IAClBC,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,OAAO,SAASC,iBAAiB,CAACF,QAA0B,EAAE;IAC5D,IAAIA,QAAQ,KAAKG,SAAS,EAAE;QAC1B,OAAOJ,cAAc,CAACC,QAAQ,CAAC;IACjC,CAAC;IACD,IAAII,qBAAqB,CAACJ,QAAQ,CAAC,EAAE;QACnC,OAAOA,QAAQ,CAAC;IAClB,CAAC;IACD,OAAOD,cAAc,CAACC,QAAQ,CAAC;AACjC,CAAC;AAED,OAAO,SAASI,qBAAqB,CAACJ,QAAyB,EAAE;IAC/D,OAAO,AAACV,eAAe,CAAuBe,QAAQ,CAACL,QAAQ,CAAC,CAAC;AACnE,CAAC;AAED,OAAO,SAASM,iBAAiB,CAACL,IAAgB,EAAE;IAClD,OAAO,AAACV,WAAW,CAAuBc,QAAQ,CAACJ,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED,OAAO,SAASM,aAAa,CAACN,IAAiB,EAAE;IAC/C,IAAI,CAACA,IAAI,IAAI,CAACK,iBAAiB,CAACL,IAAI,CAAC,EAAE;QACrC,OAAOF,cAAc,CAACE,IAAI,CAAC;IAC7B,CAAC;IAED,OAAOA,IAAI,CAAC;AACd,CAAC;AAED,OAAO,SAASO,kBAAkB,CAACC,MAAsB,EAAE;IACzD,IAAIA,MAAM,KAAKN,SAAS,EAAE;QACxB,mEAAmE;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAACC,qBAAqB,CAACK,MAAM,CAACT,QAAQ,CAAC,EAAE;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAIS,MAAM,CAACR,IAAI,IAAI,CAACK,iBAAiB,CAACG,MAAM,CAACR,IAAI,CAAC,EAAE;QAClD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,SAASS,4BAA4B,CAACC,IAAgB,EAAEC,aAAsC,EAAE;IACrG,0EAA0E;IAC1E,+BAA+B;IAC/B,OAAOA,aAAa,KAAK,KAAK,IAAI,CAAC,CAACA,aAAa,CAACD,IAAI,CAACE,EAAE,CAAC,CAAC;AAC7D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/components",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "Common UI components used across Perses features",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -36,7 +36,7 @@
     "@codemirror/lang-json": "^6.0.1",
     "@fontsource/lato": "^4.5.10",
     "@mui/x-date-pickers": "^5.0.0-beta.1",
-    "@perses-dev/core": "0.31.0",
+    "@perses-dev/core": "0.32.0",
     "@tanstack/react-table": "^8.9.1",
     "@uiw/react-codemirror": "^4.19.1",
     "date-fns": "^2.28.0",
@@ -51,7 +51,7 @@
     "react-virtuoso": "^4.3.6"
   },
   "devDependencies": {
-    "@perses-dev/storybook": "0.31.0"
+    "@perses-dev/storybook": "0.32.0"
   },
   "peerDependencies": {
     "@mui/material": "^5.10.0",