@popmenu/dashboard 0.31.0

package/README.md

@@ -0,0 +1,9 @@
+# @popmenu/dashboard
+
+Popmenu dashboard components
+
+## Installation
+
+```
+yarn add @popmenu/dashboard
+```

package/build/components/KpiMetric/KpiMetric.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { KpiMetricProps } from './KpiMetricProps';
+declare const defaultProps: {
+    trendStatus: string;
+    trendMessage: string;
+};
+export declare const KpiMetric: {
+    (props: KpiMetricProps & typeof defaultProps): JSX.Element;
+    defaultProps: {
+        trendStatus: string;
+        trendMessage: string;
+    };
+};
+export {};

package/build/components/KpiMetric/KpiMetricProps.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export interface KpiMetricProps {
+    /** The icon from @popmenu/web-icons to be rendered */
+    Icon?: string | React.FC<React.SVGProps<SVGSVGElement>>;
+    /** A KPI metric name */
+    metric: string;
+    /** A KPI metric measurement */
+    value: string | undefined;
+    /** A KPI metric trend direction */
+    trend: 'up' | 'down' | 'level' | undefined;
+    /** A KPI metric trend description */
+    trendMessage: string | undefined;
+    /** Determines if the trend direction is diplayed as success or warning. When "natural", a trend of "up" is successful*/
+    trendStatus: 'natural' | 'inverted' | undefined;
+}

package/build/components/KpiMetric/KpiMetricStyles.d.ts

@@ -0,0 +1,2 @@
+import { KpiMetricProps } from './KpiMetricProps';
+export declare const useKpiMetricStyles: (props: KpiMetricProps) => import("@material-ui/styles").ClassNameMap<string>;

package/build/components/KpiMetric/index.d.ts

@@ -0,0 +1,2 @@
+export { KpiMetric } from './KpiMetric';
+export { KpiMetricProps } from './KpiMetricProps';

package/build/components/KpiMetricTile/KpiMetricTile.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { KpiMetricTileProps } from './KpiMetricTileProps';
+export declare const KpiMetricTile: (props: KpiMetricTileProps) => JSX.Element;

package/build/components/KpiMetricTile/KpiMetricTileProps.d.ts

@@ -0,0 +1,5 @@
+import { TileProps } from '../Tile/TileProps';
+import { KpiMetricProps } from '../KpiMetric/KpiMetricProps';
+export interface KpiMetricTileProps extends KpiMetricProps {
+    TileProps: TileProps;
+}

package/build/components/KpiMetricTile/index.d.ts

@@ -0,0 +1,2 @@
+export { KpiMetricTile } from './KpiMetricTile';
+export { KpiMetricTileProps } from './KpiMetricTileProps';

package/build/components/Tile/Tile.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { TileProps } from './TileProps';
+export declare const Tile: (props: TileProps) => JSX.Element;

package/build/components/Tile/TileProps.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { CardProps, CardContentProps } from '@popmenu/common-ui';
+export interface TileProps extends CardProps {
+    /** Props for the built in Card Content component */
+    CardContentProps?: CardContentProps;
+    children?: React.ReactNode;
+}

package/build/components/Tile/TileStyles.d.ts

@@ -0,0 +1 @@
+export declare const useTileStyles: (props?: any) => import("@material-ui/styles").ClassNameMap<"root" | "content">;

package/build/components/Tile/index.d.ts

@@ -0,0 +1,2 @@
+export { Tile } from './Tile';
+export { TileProps } from './TileProps';

package/build/components/index.d.ts

@@ -0,0 +1,3 @@
+export { KpiMetric, KpiMetricProps } from './KpiMetric';
+export { KpiMetricTile, KpiMetricTileProps } from './KpiMetricTile';
+export { Tile, TileProps } from './Tile';

package/build/index.d.ts

@@ -0,0 +1 @@
+export * from './components';