@3dsource/metabox-modular-configurator-api
    Preparing search index...

    Interface ModularConfiguratorComponent

    Represents a configurator component within the modular configurator.

    Defines the type structure of a component. Describes component classification and available variants.

    Core component data model: id (UUID), name (display string), position (sort order), componentType (category), product (3D asset reference with externalId for SKU mapping), and virtualSocketToConnectorsMap (connection points). THE main data structure for building component UIs.

    Access from configurator definition in the envelope. Key fields: id (pass to SetComponent), componentType.id (the typeId param), name (display label), position (sort order). Use product.externalId for ERP/PIM lookups. Check virtualSocketToConnectorsMap for modular assembly validation.

    interface ModularConfiguratorComponent {
        __typename: "ModularConfiguratorComponent";
        componentType: ModularConfiguratorComponentType;
        id: string;
        name: string;
        position: number;
        product: Product;
        virtualSocketToConnectorsMap?: ModularConfiguratorVirtualSocketToConnector[];
    }
    Index

    Properties

    __typename: "ModularConfiguratorComponent"

    Represents object typename for the component.

    The modular configurator component type identifier.

    id: string

    The id unique identifier.

    name: string

    Display the name for the product.

    position: number

    Position index of the product.

    product: Product

    The detailed product information.

    virtualSocketToConnectorsMap?: ModularConfiguratorVirtualSocketToConnector[]

    Connectors between connectors and virtual sockets.