@foxpage/foxpage-types/lib/structure/index.d.ts

foxpage sdk types

import { Directive } from '../directive';
import { ComponentListeners } from '../listener';
export type StructureNodeType = 'react.component' | string;
export type StructureNodeProps<T extends Record<string, any>> = T & {
    __listeners?: ComponentListeners;
};
export type Extension = {
    /**
     * extend node id
     */
    extendId?: string;
    /**
     * parent node id
     */
    parentId?: string;
    /**
     * node sort
     */
    sort?: number;
};
/**
 * structure node
 *
 * @export
 * @interface StructureNode
 */
export interface StructureNode<P = Record<string, any>> {
    /**
     * structure node id
     *
     * @type {string}
     */
    id: string;
    /**
     * structure node type name
     *
     * @type {string}
     */
    name: string;
    /**
     * structure node name
     *
     * @type {string}
     * @memberof StructureNode
     */
    label: string;
    /**
     * structure node props
     *
     * @type {StructureNodeProps}
     */
    props: StructureNodeProps<P>;
    /**
     * structure node type
     *
     * @type {StructureNodeType}
     */
    type: StructureNodeType;
    /**
     * structure node children
     *
     * @type {StructureNode[]}
     */
    children?: StructureNode[];
    /**
     * directive defined
     *
     * @type {Directive}
     */
    directive?: Directive;
    /**
     * structure node version
     *
     * @type {string}
     */
    version?: string;
    /**
     * disable status
     *
     * @type {boolean}
     */
    disable?: boolean;
    /**
     * show status
     *
     * @type {boolean}
     */
    show?: boolean;
    /**
     * extension info
     *
     * @type {Extension}
     */
    extension?: Extension;
}