@transact-open-ux/react/dist/components/PageController.d.ts

Library to integrate React with Transact Open UX

import React, { FunctionComponent } from "react";
export interface PageControllerProps {
    /**
     * The children should consist of Page components.
     * To enable Transact Application Framework support you must ensure the Pages have `id` props.
     */
    children?: React.ReactNode | React.ReactNodeArray | any;
}
/**
 * Allows multiple pages to be added to an application.
 * <br>
 * This component initializes the pages and loads them into the page context state.
 * <br>
 * If you are not using the Transact Application Framework, ensure end of flow pages i.e. SaveSuccess
 * are at the end of the PageController children.
 *
 * ## Example
 * ```html
 * <PageController>
 *    <Page id="LandingPage" offMenu>
 *      <LandingPage />
 *    </Page>
 *    <Page id="GettingStarted" label="Let's get started">
 *      <GettingStarted />
 *    </Page>
 *    <Page id="AboutYou" label="All about you">
 *      <AboutYou />
 *    </Page>
 *    <Page id="SubmitSuccess" offMenu>
 *      <SubmitSuccess />
 *    </Page>
 *    <Page id="SaveSuccess" offMenu>
 *      <SaveSuccess />
 *    </Page>
 *    <Page id="CancelSuccess" offMenu>
 *      <CancelSuccess />
 *    </Page>
 * </PageController>
 * ```
 */
export declare const PageController: FunctionComponent<PageControllerProps>;