@builder.io/mitosis/dist/src/types/mitosis-node.d.ts

Write components once, run everywhere. Compiles to Vue, React, Solid, and Liquid. Import code from Figma and Builder.io

import { JSONObject } from './json';
export type SpreadType = 'normal' | 'event-handlers';
export type BindingType = 'function' | 'expression';
type BindingProperties = {
    type: 'spread';
    spreadType: SpreadType;
    /**
     * TODO: remove these once we've cleaned up the code that uses them.
     * they don't need to be here since they only exist for functions
     */
    async?: boolean;
    arguments?: string[];
} | {
    type: 'single';
    bindingType: Extract<BindingType, 'function'>;
    async?: boolean;
    arguments?: string[];
} | {
    type: 'single';
    bindingType: Extract<BindingType, 'expression'>;
    /**
     * TODO: remove these once we've cleaned up the code that uses them.
     * they don't need to be here since they only exist for functions
     */
    async?: boolean;
    arguments?: string[];
};
export type Binding = {
    code: string;
} & BindingProperties;
export type BuilderLocalizedValue = {
    '@type': '@builder.io/core:LocalizedValue';
    Default: string;
    [index: string]: string;
};
export type BaseNode = {
    '@type': '@builder.io/mitosis/node';
    meta: JSONObject;
    name: string;
    scope: {};
    /**
     * Key-value store of string values for DOM attributes.
     * ```js
     * {
     *   defaultValue: 'initial text',
     *   width: '100px',
     * }
     * ```
     */
    properties: {
        [key: string]: string | undefined;
    };
    /**
     * Key-value store of expression values for DOM attributes. These are always represented as strings.
     *
     * ```js
     * {
     *   disabled: "state.isDisabled",
     *   defaultValue: "`${props.text} + ' initial'`",
     *   width: "props.width * 10",
     *   height: "100",
     * }
     * ```
     */
    bindings: {
        [key: string]: Binding | undefined;
    };
    children: MitosisNode[];
    /**
     * Key-value store of slots. The key is the slot name and the value is an array of nodes.
     * It is used when components have props that are also nodes
     */
    slots?: {
        [key: string]: MitosisNode[];
    };
    /**
     * Key-value store of localized values
     * It is used when a Builder content block has localized values.
     */
    localizedValues?: {
        [index: string]: BuilderLocalizedValue;
    };
    /**
     * Key-value store of serialized elements passed into properties.
     * Disabled by default. Use `enableBlocksSlots` on supported parsers to enable.
     */
    blocksSlots?: BlockSlot;
};
export interface BlockSlot {
    [key: string]: BlockSlot | BlockSlot[] | MitosisNode | MitosisNode[];
}
export declare const ForNodeName = "For";
export declare const FragmentNodeName = "Fragment";
export declare const ShowNodeName = "Show";
export declare const SlotNodeName = "Slot";
export declare const SpecialNodeNameList: string[];
export type SpecialNodesNames = (typeof SpecialNodeNameList)[number];
export type ForNode = BaseNode & {
    name: 'For';
    scope: {
        forName: string | undefined;
        indexName: string | undefined;
        collectionName: string | undefined;
    };
};
export type ShowNode = BaseNode & {
    name: 'Show';
};
export type MitosisNode = BaseNode | ForNode | ShowNode;
export declare const checkIsForNode: (node: MitosisNode) => node is ForNode;
export declare const checkIsShowNode: (node: MitosisNode) => node is ShowNode;
export {};