@redsift/dashboard 7.1.1 → 7.2.0-alpha.1

package/index.d.ts

@@ -2,8 +2,9 @@ import * as crossfilter2 from 'crossfilter2';
 import { Crossfilter, Group as Group$1, NaturallyOrderedValue, Dimension as Dimension$1, ComparableObject, OrderedValueSelector } from 'crossfilter2';
 import { PieChartLabelVariant, PieChartSize, PieChartTheme, PieChartVariant } from '@redsift/charts';
 export { ColorTheme, PieChartLabelVariant, PieChartSize, PieChartTheme, PieChartVariant } from '@redsift/charts';
-import React, { Ref, ReactElement, ComponentProps, Dispatch } from 'react';
-import { GridFilterItem, DataGridProps as DataGridProps$1 } from '@redsift/table';
+import React, { Ref, ReactElement, ComponentProps, RefObject, MutableRefObject, Dispatch } from 'react';
+import { GridFilterItem, DataGridProps as DataGridProps$1, GridFilterModel } from '@redsift/table';
+import { GridApi } from '@mui/x-data-grid-pro';
 
 type SuccessDangerColorTheme = {
     success: string;
@@ -53,6 +54,105 @@ type Comp<P, T = HTMLElement> = {
 };
 /** Get types of the values of a record. */
 type ValueOf<T extends Record<any, any>> = T[keyof T];
+/**
+ * Color palette.
+ */
+declare const ColorPalette: {
+    readonly default: "default";
+    readonly success: "success";
+    readonly error: "error";
+    readonly warning: "warning";
+    readonly info: "info";
+    readonly question: "question";
+    readonly 'no-data': "no-data";
+};
+type ColorPalette = ValueOf<typeof ColorPalette>;
+declare const ProductColorPalette: {
+    readonly website: "website";
+    readonly ondmarc: "ondmarc";
+    readonly oninbox: "oninbox";
+    readonly ondomain: "ondomain";
+    readonly hardenize: "hardenize";
+    readonly tools: "tools";
+};
+type ProductColorPalette = ValueOf<typeof ProductColorPalette>;
+
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you 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 REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+
+type PointerType = 'mouse' | 'pen' | 'touch' | 'keyboard' | 'virtual';
+
+interface PressEvent {
+  /** The type of press event being fired. */
+  type: 'pressstart' | 'pressend' | 'pressup' | 'press',
+  /** The pointer type that triggered the press event. */
+  pointerType: PointerType,
+  /** The target element of the press event. */
+  target: Element,
+  /** Whether the shift keyboard modifier was held during the press event. */
+  shiftKey: boolean,
+  /** Whether the ctrl keyboard modifier was held during the press event. */
+  ctrlKey: boolean,
+  /** Whether the meta keyboard modifier was held during the press event. */
+  metaKey: boolean,
+  /** Whether the alt keyboard modifier was held during the press event. */
+  altKey: boolean
+}
+
+/**
+ * Component variant.
+ */
+declare const ButtonVariant: {
+    readonly primary: "primary";
+    readonly secondary: "secondary";
+    readonly unstyled: "unstyled";
+};
+type ButtonVariant = ValueOf<typeof ButtonVariant>;
+/**
+ * Component color.
+ */
+type ButtonColor = typeof ColorPalette.default | typeof ColorPalette.error | ProductColorPalette;
+/**
+ * Component props.
+ */
+interface ButtonProps extends ComponentProps<'button'> {
+    /** Color variant. The product colors are available but should only be used to display the Button in the color of another product. To display a Button with a color of the current product, use `default`. */
+    color?: ButtonColor;
+    /** Whether the component take the full width or not. */
+    fullWidth?: boolean;
+    /** Whether the component is active or not. */
+    isActive?: boolean;
+    /** Whether the component is disabled or not. */
+    isDisabled?: boolean;
+    /**
+     * Icon path data (`d` property of the `path` SVG element).<br />
+     * See <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths">https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths</a>.<br />
+     * Recommended path data come from mdi/js.<br />
+     * See <a href="https://www.npmjs.com/package/@mdi/js">https://www.npmjs.com/package/@mdi/js</a>.
+     */
+    leftIcon?: string;
+    /** Preferred method to handle click, press and touch. */
+    onPress?: (e: PressEvent) => void;
+    /**
+     * Icon path data (`d` property of the `path` SVG element).<br />
+     * See <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths">https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths</a>.<br />
+     * Recommended path data come from mdi/js.<br />
+     * See <a href="https://www.npmjs.com/package/@mdi/js">https://www.npmjs.com/package/@mdi/js</a>.
+     */
+    rightIcon?: string;
+    /** Button variant. */
+    variant?: ButtonVariant;
+}
 
 /**
  * Component props.
@@ -74,10 +174,12 @@ declare const ChartEmptyState: Comp<ChartEmptyStateProps, HTMLDivElement>;
  * Context props.
  */
 type DashboardContextProps = {
+    dashboardRef?: RefObject<HTMLDivElement>;
+    data?: JSONArray;
+    dataGridApiRef?: MutableRefObject<GridApi>;
+    dispatch?: Dispatch<DashboardReducerAction>;
     ndx?: TNdx;
     state: DashboardReducerState;
-    dispatch?: Dispatch<DashboardReducerAction>;
-    data?: JSONArray;
 };
 /**
  * Reducer props.
@@ -115,6 +217,7 @@ declare const DashboardReducer: (state: DashboardReducerState, action: Dashboard
  */
 interface DataGridProps extends Omit<DataGridProps$1, 'rows'> {
     rows?: DataGridProps$1['rows'];
+    onFilter?: (filterModel: GridFilterModel) => void;
 }
 
 declare const DataGrid: React.FC<DataGridProps>;
@@ -141,7 +244,7 @@ declare const HorizontalBarChartTheme: {
     readonly monochrome: "monochrome";
 };
 type HorizontalBarChartTheme = ValueOf<typeof HorizontalBarChartTheme>;
-interface LocaleText$2 {
+interface LocaleText$3 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
     emptyChartResetLabel?: string;
@@ -175,7 +278,7 @@ interface HorizontalBarChartProps extends ComponentProps<'div'> {
     /** Whether the reset button is hidden or not. */
     isResetable?: boolean;
     /** Overriden values for internal labels and texts. */
-    localeText?: LocaleText$2;
+    localeText?: LocaleText$3;
     /** Method to call when a filter occured on the chart. */
     onFilter?: (filters?: string[]) => void;
     /** Whether a category should be displayed for categories that has been removed by the caping option. Optionaly, this prop can be used to change the label of this category. */
@@ -193,6 +296,28 @@ type StyledHorizontalBarChartProps = Omit<HorizontalBarChartProps, 'columnToFilt
 
 declare const HorizontalBarChart: Comp<HorizontalBarChartProps, HTMLDivElement>;
 
+interface LocaleText$2 {
+    maxSizeDisclaimer?: string;
+}
+interface PdfExportButtonProps extends ButtonProps {
+    /** Ref to the DOM component to export. By default, will be the ref to the parent Dashboard. */
+    componentRef?: RefObject<HTMLElement>;
+    /** Name of the exported PDF file. */
+    fileName?: string;
+    /** Text to display at the beginning of the PDF. */
+    introduction?: string;
+    /** Labels and texts. */
+    localeText?: LocaleText$2;
+    /** Image to put at the top of the PDF (SVG format not supported). */
+    logo?: string;
+    /** Function to be executed when button is clicked. */
+    onClick?: () => void;
+    /** Color used for the header and footer of the PDF. */
+    primaryColor?: string;
+}
+
+declare const PdfExportButton: Comp<PdfExportButtonProps, HTMLButtonElement>;
+
 interface LocaleText$1 {
     emptyChartTitle?: string;
     emptyChartSubtitle?: string;
@@ -326,4 +451,4 @@ type StyledTimeSeriesBarChartProps = Omit<TimeSeriesBarChartProps, 'dimension' |
 
 declare const TimeSeriesBarChart: Comp<TimeSeriesBarChartProps, HTMLDivElement>;
 
-export { COUNT, ChartDimensions, ChartEmptyState, ChartEmptyStateProps, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONArray, JSONObject, JSONValue, PieChart, PieChartProps, SUM, StyledHorizontalBarChartProps, StyledPieChartProps, StyledTimeSeriesBarChartProps, SuccessDangerColorTheme, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum, groupReduceSum, initialState };
+export { COUNT, ChartDimensions, ChartEmptyState, ChartEmptyStateProps, Dashboard, DashboardContext, DashboardContextProps, DashboardProps, DashboardReducer, DashboardReducerAction, DashboardReducerActionType, DashboardReducerState, DataGrid, DataGridProps, Dimension, DimensionSelector, Group, GroupSelector, HorizontalBarChart, HorizontalBarChartProps, HorizontalBarChartSize, HorizontalBarChartTheme, JSONArray, JSONObject, JSONValue, PdfExportButton, PieChart, PieChartProps, SUM, StyledHorizontalBarChartProps, StyledPieChartProps, StyledTimeSeriesBarChartProps, SuccessDangerColorTheme, TNdx, TimeSeriesBarChart, TimeSeriesBarChartProps, TimeSeriesBarChartSize, TimeSeriesBarChartTheme, datetimeEnum, groupReduceSum, initialState };