piral-core/lib/types/instance.d.ts

The core library for creating a Piral instance.

import type { ReactNode } from 'react';
import type { PiletApi, PiletApiCreator, LoadPiletsOptions, EventEmitter } from 'piral-base';
import type { GlobalStateContext } from './state';
import type { LayoutBreakpoints } from './layout';
import type { PiralConfiguration } from './config';
/**
 * The props of the Piral context.
 */
export interface PiralContextProps {
    /**
     * The specific Piral instance to be used.
     */
    instance?: PiralInstance;
    children?: ReactNode;
}
/**
 * The props of the Piral component.
 */
export interface PiralProps extends PiralContextProps {
    /**
     * The custom breakpoints for the different layout modi.
     */
    breakpoints?: LayoutBreakpoints;
}
/**
 * The options for creating a new PiralInstance object.
 */
export interface PiralInstanceOptions extends PiralConfiguration {
    /**
     * Defines the id of this instance. Used in case of multiple instances.
     */
    id?: string;
}
/**
 * The PiralInstance object, which is an event emitter with some other
 * utilities and helper. This object is the source for the React
 * functional component (`Piral`).
 */
export interface PiralInstance extends EventEmitter {
    /**
     * The id of the Piral instance.
     */
    id: string;
    /**
     * The global state context instance.
     */
    context: GlobalStateContext;
    /**
     * The pilet API creator callback.
     */
    createApi: PiletApiCreator;
    /**
     * The used options for loading pilets.
     */
    options: LoadPiletsOptions;
    /**
     * The root pilet for using the pilet API within the Piral instance.
     */
    root: PiletApi;
}