@adaptabletools/adaptable/src/View/Wizard/OnePageAdaptableWizard.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import * as React from 'react';
import { CSSProperties } from 'react';
import { TextProps } from 'rebass';
import { AdaptableApi } from '../../types';
import { ModuleInfo } from '../../Strategy/Interface/IModule';
import { ExpressionEditorNamedQuery } from '../../components/ExpressionEditor/NamedQueryContext';
export type OnePageAdaptableWizardContextType<T> = {
    data: T;
    sections: (OnePageAdaptableWizardSection<T> | '-')[];
    moduleInfo: ModuleInfo;
    api: AdaptableApi;
    namedQuery: ExpressionEditorNamedQuery;
};
export declare const SummaryTag: React.FunctionComponent<React.PropsWithChildren<TextProps>>;
export declare const SummaryText: React.FunctionComponent<React.PropsWithChildren<TextProps>>;
export declare const FormDescriptionText: React.FunctionComponent<React.PropsWithChildren<TextProps>>;
export declare const OnePageAdaptableWizardContext: React.Context<OnePageAdaptableWizardContextType<any>>;
export declare function useOnePageAdaptableWizardContext<ENTITY>(): OnePageAdaptableWizardContextType<ENTITY>;
export interface OnePageAdaptableWizardSection<ENTITY> {
    title: string;
    details?: React.ReactNode;
    isValid?: (data: ENTITY, api: AdaptableApi, context: OnePageAdaptableWizardContextType<ENTITY>) => true | string;
    isVisible?: (data: ENTITY, api: AdaptableApi, context: OnePageAdaptableWizardContextType<ENTITY>) => boolean;
    render: (data: ENTITY, index: number) => React.ReactNode;
    renderSummary?: (data: ENTITY, api: AdaptableApi) => React.ReactNode;
}
export interface OnePageAdaptableWizardProps<ENTITY> {
    moduleInfo: ModuleInfo;
    data: ENTITY;
    sections: (OnePageAdaptableWizardSection<ENTITY> | '-')[];
    currentIndex?: number;
    defaultCurrentIndex?: number;
    defaultCurrentSectionName?: string;
    onSectionChange?: (index: number) => void;
    onHide?: VoidFunction;
    onFinish?: (data: ENTITY) => any;
    children?: React.ReactNode;
    style?: CSSProperties;
    titleContainerStyle?: CSSProperties;
    closeText?: React.ReactNode;
    closeTooltip?: string;
    finishText?: React.ReactNode;
}
export declare const OnePageAdaptableWizard: <ENTITY extends unknown>(props: OnePageAdaptableWizardProps<ENTITY>) => React.JSX.Element;
export declare const OnePageWizardSummary: <ENTITY extends unknown>() => React.JSX.Element;