forlogic-core 2.1.4 → 2.2.0

package/dist/components/dashboards/panels/matrix-risk-panel.d.ts

@@ -1,9 +1,19 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, MatrixViewType, type PanelConfig } from '../types';
+/**
+ * Tipo `MatrixParameter` exportado pela lib.
+ * @example
+ * const value: MatrixParameter = {} as MatrixParameter;
+ */
 export interface MatrixParameter {
     name: string;
     position: number;
 }
+/**
+ * Tipo `MatrixRule` exportado pela lib.
+ * @example
+ * const value: MatrixRule = {} as MatrixRule;
+ */
 export interface MatrixRule {
     name_x: string;
     name_y: string;
@@ -15,6 +25,11 @@ export interface MatrixRule {
     /** Matrix of colors indexed [y][x] */
     colorMatrix?: string[][];
 }
+/**
+ * Tipo `MatrixRisk` exportado pela lib.
+ * @example
+ * const value: MatrixRisk = {} as MatrixRisk;
+ */
 export interface MatrixRisk {
     code: string;
     name: string;
@@ -29,6 +44,11 @@ export interface MatrixRisk {
     resultName?: string;
     link?: string;
 }
+/**
+ * Tipo `MatrixRiskPanelProps` exportado pela lib.
+ * @example
+ * const value: MatrixRiskPanelProps = {} as MatrixRiskPanelProps;
+ */
 export interface MatrixRiskPanelProps {
     config: PanelConfig;
     state: PanelState;
@@ -46,4 +66,9 @@ export interface MatrixRiskPanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `MatrixRiskPanel`.
+ * @example
+ * MatrixRiskPanel();
+ */
 export declare function MatrixRiskPanel({ config, state, rule, risks, matrixViewType, viewOnly, onCellClick, onRiskClick, onRefresh, queryUrl, queryUrlBuilder, className, }: MatrixRiskPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/numeric-panel.d.ts

@@ -1,5 +1,10 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, type PanelConfig } from '../types';
+/**
+ * Tipo `NumericPanelProps` exportado pela lib.
+ * @example
+ * const value: NumericPanelProps = {} as NumericPanelProps;
+ */
 export interface NumericPanelProps {
     config: PanelConfig;
     /** Current state of the panel */
@@ -19,4 +24,9 @@ export interface NumericPanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `NumericPanel`.
+ * @example
+ * NumericPanel();
+ */
 export declare function NumericPanel({ config, state, value, label, viewOnly, onClick, onRefresh, queryUrl, queryUrlBuilder, className, }: NumericPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/panel-error.d.ts

@@ -1,8 +1,18 @@
 import type { PanelConfig } from '../types';
+/**
+ * Tipo `PanelErrorProps` exportado pela lib.
+ * @example
+ * const value: PanelErrorProps = {} as PanelErrorProps;
+ */
 export interface PanelErrorProps {
     config: PanelConfig;
     /** URL to the query for troubleshooting */
     queryUrl?: string;
     className?: string;
 }
+/**
+ * Função utilitária `PanelError`.
+ * @example
+ * PanelError();
+ */
 export declare function PanelError({ config, queryUrl, className }: PanelErrorProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/panel-header.d.ts

@@ -1,5 +1,10 @@
 import { type ReactNode } from 'react';
 import { type PanelConfig } from '../types';
+/**
+ * Tipo `PanelHeaderProps` exportado pela lib.
+ * @example
+ * const value: PanelHeaderProps = {} as PanelHeaderProps;
+ */
 export interface PanelHeaderProps {
     config: PanelConfig;
     /** Hide the options menu (e.g. in general-view mode) */
@@ -14,4 +19,9 @@ export interface PanelHeaderProps {
     onToggleOnlyMine?: (value: boolean) => void;
     className?: string;
 }
+/**
+ * Função utilitária `PanelHeader`.
+ * @example
+ * PanelHeader();
+ */
 export declare function PanelHeader({ config, viewOnly, complement, complementPosition, queryUrlBuilder, onRefresh, onExport, onToggleOnlyMine, className, }: PanelHeaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/panel-loader.d.ts

@@ -1,7 +1,17 @@
 import { DashboardPanelType } from '../types';
+/**
+ * Tipo `PanelLoaderProps` exportado pela lib.
+ * @example
+ * const value: PanelLoaderProps = {} as PanelLoaderProps;
+ */
 export interface PanelLoaderProps {
     /** Show extra "please wait" message for long-running panel types */
     panelType?: DashboardPanelType;
     className?: string;
 }
+/**
+ * Função utilitária `PanelLoader`.
+ * @example
+ * PanelLoader();
+ */
 export declare function PanelLoader({ panelType, className }: PanelLoaderProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/panel-no-data.d.ts

@@ -1,6 +1,16 @@
+/**
+ * Tipo `PanelNoDataProps` exportado pela lib.
+ * @example
+ * const value: PanelNoDataProps = {} as PanelNoDataProps;
+ */
 export interface PanelNoDataProps {
     /** Whether the panel has a removed column (shows different message) */
     hasRemovedColumn?: boolean;
     className?: string;
 }
+/**
+ * Função utilitária `PanelNoData`.
+ * @example
+ * PanelNoData();
+ */
 export declare function PanelNoData({ hasRemovedColumn, className }: PanelNoDataProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/panel-unavailable.d.ts

@@ -1,6 +1,16 @@
+/**
+ * Tipo `PanelUnavailableProps` exportado pela lib.
+ * @example
+ * const value: PanelUnavailableProps = {} as PanelUnavailableProps;
+ */
 export interface PanelUnavailableProps {
     /** Callback to remove the panel */
     onRemove?: () => void;
     className?: string;
 }
+/**
+ * Função utilitária `PanelUnavailable`.
+ * @example
+ * PanelUnavailable();
+ */
 export declare function PanelUnavailable({ onRemove, className }: PanelUnavailableProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/pareto-panel.d.ts

@@ -1,5 +1,10 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, type PanelConfig, type PanelResult } from '../types';
+/**
+ * Tipo `ParetoPanelProps` exportado pela lib.
+ * @example
+ * const value: ParetoPanelProps = {} as ParetoPanelProps;
+ */
 export interface ParetoPanelProps {
     config: PanelConfig;
     state: PanelState;
@@ -17,4 +22,9 @@ export interface ParetoPanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `ParetoPanel`.
+ * @example
+ * ParetoPanel();
+ */
 export declare function ParetoPanel({ config, state, data, barColor, lineColor, viewOnly, onPointClick, onRefresh, onExport, queryUrl, queryUrlBuilder, className, }: ParetoPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/performance-panel.d.ts

@@ -1,11 +1,21 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, type PanelConfig } from '../types';
+/**
+ * Tipo `PerformanceDataPoint` exportado pela lib.
+ * @example
+ * const value: PerformanceDataPoint = {} as PerformanceDataPoint;
+ */
 export interface PerformanceDataPoint {
     name: string;
     executedWork: number;
     plannedWork: number;
     [key: string]: unknown;
 }
+/**
+ * Tipo `PerformancePanelProps` exportado pela lib.
+ * @example
+ * const value: PerformancePanelProps = {} as PerformancePanelProps;
+ */
 export interface PerformancePanelProps {
     config: PanelConfig;
     state: PanelState;
@@ -21,4 +31,9 @@ export interface PerformancePanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `PerformancePanel`.
+ * @example
+ * PerformancePanel();
+ */
 export declare function PerformancePanel({ config, state, data, executedLabel, plannedLabel, executedColor, plannedColor, viewOnly, onPointClick, onRefresh, queryUrl, queryUrlBuilder, className, }: PerformancePanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/pie-panel.d.ts

@@ -1,5 +1,10 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, type PanelConfig, type PanelResult } from '../types';
+/**
+ * Tipo `PiePanelProps` exportado pela lib.
+ * @example
+ * const value: PiePanelProps = {} as PiePanelProps;
+ */
 export interface PiePanelProps {
     config: PanelConfig;
     state: PanelState;
@@ -16,4 +21,9 @@ export interface PiePanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `PiePanel`.
+ * @example
+ * PiePanel();
+ */
 export declare function PiePanel({ config, state, data, colors: colorsProp, viewOnly, onSliceClick, onRefresh, onExport, queryUrl, queryUrlBuilder, className, }: PiePanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/dashboards/panels/text-panel.d.ts

@@ -1,5 +1,10 @@
 import { type PanelHeaderProps } from './panel-header';
 import { PanelState, type PanelConfig } from '../types';
+/**
+ * Tipo `TextPanelProps` exportado pela lib.
+ * @example
+ * const value: TextPanelProps = {} as TextPanelProps;
+ */
 export interface TextPanelProps {
     config: PanelConfig;
     /** Current state of the panel */
@@ -15,4 +20,9 @@ export interface TextPanelProps {
     queryUrlBuilder?: PanelHeaderProps['queryUrlBuilder'];
     className?: string;
 }
+/**
+ * Função utilitária `TextPanel`.
+ * @example
+ * TextPanel();
+ */
 export declare function TextPanel({ config, state, htmlContent, viewOnly, onRefresh, queryUrl, queryUrlBuilder, className, }: TextPanelProps): import("react/jsx-runtime").JSX.Element;