@enonic/react-components/dist/types/ComponentData.d.ts

Library of React components for handling Enonic XP data and page components

import type { ComponentDescriptor, LiteralUnion, RequestMode, TextComponent } from '@enonic-types/core';
import { ComponentRegistry } from './ComponentRegistry';
export type XpRunMode = 'development' | 'production';
export interface ContentTypeData {
    contentType: string;
    type: 'contentType';
}
export interface ErrorData {
    html: string;
    path: string;
    type: 'error';
}
export interface RegionData {
    name: string;
    components: ComponentDataAndProps[];
}
export type RegionsData = Record<string, RegionData>;
export interface LayoutData {
    descriptor: ComponentDescriptor;
    path?: string;
    regions: RegionsData;
    type: 'layout';
}
export interface PageData {
    descriptor: ComponentDescriptor;
    path: '/';
    regions: RegionsData;
    type: 'page';
}
export interface PartData {
    descriptor: ComponentDescriptor;
    path?: string;
    type: 'part';
}
export interface FragmentData {
    key?: string;
    path?: string;
    type: 'fragment';
}
export interface MacroComponentData {
    descriptor: string;
    name: string;
    ref?: string;
    type: 'macro';
}
export type TextData = TextComponent;
export type MetaData = {
    type: string;
    id: string;
    path: string;
    mode: LiteralUnion<RequestMode>;
    componentRegistry: ComponentRegistry;
};
export type ComponentDataAndProps<T extends ComponentData = ComponentData> = {
    data?: Record<string, unknown>;
    component: T;
};
export type ComponentData = ContentTypeData | LayoutData | PageData | PartData | TextData | FragmentData | MacroComponentData | ErrorData;