Skip to content

Components

Definition

A component is a reusable arrangement of products with shared attributes, e.g. a workstation. Like a CAD block, it can be placed multiple times - updating the definition updates all instances.

json
{
    "type": "product:component",
    "name": "my-component",
    "attributes": { ... },
    "products": [
        { "product": "desk-product-id", "position": [0, 0, 0], "rotation": 0 },
        { "product": "chair-product-id", "position": [0, 0, 0.8], "rotation": 180 }
    ]
}

Attributes

The component attributes enable classification of the component by using the component taxonomy.
The boundingBox indicates the dimensions of the placed products.

json
{
  "categories": ["desking"],
  "subCategories": ["workstation"],
  "updatedAt": "",
  "thumbnail": ".../image.png",
  "boundingBox": {
    "min": [-0.8, 0, -0.4],
    "max": [0.8, 1, 1]
  }
}

Taxonomy

The component taxonomy is organized by
category | subCategory

component taxonomy