Skip to content

product-icon

product-icon

Type Aliases

ProductIcon

type ProductIcon = ReturnType<typeof ProductIcon>;

Defined in: packages/ui/build/product-icon/product-icon.svelte.d.ts:6


ProductIconName

type ProductIconName = typeof PRODUCT_ICON_NAMES[number];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:4


ProductIconPrimitive

type ProductIconPrimitive = 
  | {
  accent?: true;
  d: string;
  kind: "path";
}
  | {
  accent?: true;
  cx: number;
  cy: number;
  kind: "ellipse";
  rx: number;
  ry: number;
}
  | {
  accent?: true;
  cx: number;
  cy: number;
  kind: "circle";
  r: number;
}
  | {
  accent?: true;
  height: number;
  kind: "rect";
  rx: number;
  width: number;
  x: number;
  y: number;
};

Defined in: packages/ui/build/product-icon/product-icons.d.ts:8


ProductIconReference

type ProductIconReference = `product:${ProductIconName}`;

Defined in: packages/ui/build/product-icon/product-icons.d.ts:7


ProductLayerIconName

type ProductLayerIconName = typeof PRODUCT_LAYER_ICON_NAMES[number];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:5


ProductSubmoduleIconName

type ProductSubmoduleIconName = typeof PRODUCT_SUBMODULE_ICON_NAMES[number];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:6

Variables

PRODUCT_ICON_NAMES

const PRODUCT_ICON_NAMES: readonly ["core", "pod", "model", "security", "logic", "interface", "models", "relations", "policies", "approvals", "audit", "hooks", "pipelines", "integrations", "automations", "remotes", "apps", "agent", "collections", "studio", "checkpoints", "environment", "organization", "documentation", "quick-start", "concepts", "api", "deployment", "examples"];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:3


PRODUCT_LAYER_ICON_GEOMETRY

const PRODUCT_LAYER_ICON_GEOMETRY: object;

Defined in: packages/ui/build/product-icon/product-icons.d.ts:35

Canonical layer geometry shared by SVG icons and procedural product illustrations.

Type Declaration

interface
readonly interface: readonly [{
  height: 14;
  kind: "rect";
  rx: 2;
  width: 10;
  x: 2;
  y: 5;
}, {
  cx: 18;
  cy: 12;
  kind: "circle";
  r: 3;
}, {
  accent: true;
  d: "M12 12h3";
  kind: "path";
}];

logic
readonly logic: readonly [{
  d: "M16 3h5v5M4 20l6-6M14 10l7-7M4 4l5 5M15 15l6 6M21 16v5h-5";
  kind: "path";
}, {
  accent: true;
  d: "m10 14 4-4";
  kind: "path";
}];

model
readonly model: readonly [{
  cx: 12;
  cy: 5;
  kind: "ellipse";
  rx: 9;
  ry: 3;
}, {
  d: "M3 5v14c0 1.7 4 3 9 3s9-1.3 9-3V5";
  kind: "path";
}, {
  d: "M3 12c0 1.7 4 3 9 3s9-1.3 9-3";
  kind: "path";
}, {
  accent: true;
  d: "M3 5v4";
  kind: "path";
}];

security
readonly security: readonly [{
  d: "M12 3 19 6v5c0 4.5-2.7 7.6-7 10-4.3-2.4-7-5.5-7-10V6l7-3Z";
  kind: "path";
}, {
  accent: true;
  d: "m9.5 12 1.7 1.7 3.5-3.7";
  kind: "path";
}];

PRODUCT_LAYER_ICON_NAMES

const PRODUCT_LAYER_ICON_NAMES: readonly ["model", "security", "logic", "interface"];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:1


PRODUCT_SUBMODULE_ICON_NAMES

const PRODUCT_SUBMODULE_ICON_NAMES: readonly ["models", "relations", "policies", "approvals", "audit", "hooks", "pipelines", "integrations", "automations", "remotes", "apps", "agent"];

Defined in: packages/ui/build/product-icon/product-icons.d.ts:2


ProductIcon

const ProductIcon: Component;

Defined in: packages/ui/build/product-icon/product-icon.svelte.d.ts:6

Functions

productIconNameFromReference()

function productIconNameFromReference(reference): 
  | "approvals"
  | "automations"
  | "security"
  | "core"
  | "pod"
  | "model"
  | "logic"
  | "interface"
  | "models"
  | "relations"
  | "policies"
  | "audit"
  | "hooks"
  | "pipelines"
  | "integrations"
  | "remotes"
  | "apps"
  | "agent"
  | "collections"
  | "studio"
  | "checkpoints"
  | "environment"
  | "organization"
  | "documentation"
  | "quick-start"
  | "concepts"
  | "api"
  | "deployment"
  | "examples"
  | null;

Defined in: packages/ui/build/product-icon/product-icons.d.ts:88

Parameters

Parameter Type
reference string | null | undefined

Returns

| "approvals" | "automations" | "security" | "core" | "pod" | "model" | "logic" | "interface" | "models" | "relations" | "policies" | "audit" | "hooks" | "pipelines" | "integrations" | "remotes" | "apps" | "agent" | "collections" | "studio" | "checkpoints" | "environment" | "organization" | "documentation" | "quick-start" | "concepts" | "api" | "deployment" | "examples" | null


productIconReference()

function productIconReference(name): 
  | "product:organization"
  | "product:agent"
  | "product:apps"
  | "product:approvals"
  | "product:automations"
  | "product:studio"
  | "product:models"
  | "product:policies"
  | "product:security"
  | "product:core"
  | "product:pod"
  | "product:model"
  | "product:logic"
  | "product:interface"
  | "product:relations"
  | "product:audit"
  | "product:hooks"
  | "product:pipelines"
  | "product:integrations"
  | "product:remotes"
  | "product:collections"
  | "product:checkpoints"
  | "product:environment"
  | "product:documentation"
  | "product:quick-start"
  | "product:concepts"
  | "product:api"
  | "product:deployment"
  | "product:examples";

Defined in: packages/ui/build/product-icon/product-icons.d.ts:89

Parameters

Parameter Type
name | "approvals" | "automations" | "security" | "core" | "pod" | "model" | "logic" | "interface" | "models" | "relations" | "policies" | "audit" | "hooks" | "pipelines" | "integrations" | "remotes" | "apps" | "agent" | "collections" | "studio" | "checkpoints" | "environment" | "organization" | "documentation" | "quick-start" | "concepts" | "api" | "deployment" | "examples"

Returns

| "product:organization" | "product:agent" | "product:apps" | "product:approvals" | "product:automations" | "product:studio" | "product:models" | "product:policies" | "product:security" | "product:core" | "product:pod" | "product:model" | "product:logic" | "product:interface" | "product:relations" | "product:audit" | "product:hooks" | "product:pipelines" | "product:integrations" | "product:remotes" | "product:collections" | "product:checkpoints" | "product:environment" | "product:documentation" | "product:quick-start" | "product:concepts" | "product:api" | "product:deployment" | "product:examples"


productLayerIconGeometry()

function productLayerIconGeometry(name): 
  | readonly ProductIconPrimitive[]
  | null;

Defined in: packages/ui/build/product-icon/product-icons.d.ts:87

Parameters

Parameter Type
name | "approvals" | "automations" | "security" | "core" | "pod" | "model" | "logic" | "interface" | "models" | "relations" | "policies" | "audit" | "hooks" | "pipelines" | "integrations" | "remotes" | "apps" | "agent" | "collections" | "studio" | "checkpoints" | "environment" | "organization" | "documentation" | "quick-start" | "concepts" | "api" | "deployment" | "examples"

Returns

| readonly ProductIconPrimitive[] | null