piral-core/lib/components/PiralRoutes.d.ts

The core library for creating a Piral instance.

import * as React from 'react';
import { RouteComponentProps, SwitchProps } from 'react-router';
import { RouteSwitchProps } from '../types';
/**
 * The props used by the PiralRoutes component.
 */
export interface RoutesProps extends SwitchProps {
    /**
     * Sets the component for showing the not found page.
     */
    NotFound: React.ComponentType<RouteComponentProps>;
    /**
     * Sets the component for actually switching the routes.
     */
    RouteSwitch: React.ComponentType<RouteSwitchProps>;
}
/**
 * The component for defining the exclusive routes to be used.
 */
export declare const PiralRoutes: React.FC<RoutesProps>;