Component Guides

A component guide is a document that you can put together for your team members to refer to when using a component in your interaction library. You will be able to provide a description and others would be able to see what overridable variables, Send responses, and Receive triggers with their corresponding messages are used.

Editing Component Guides

Click the pencil icon in the property panel of the component to edit the component guide. Simple markdown is supported (except for hyperlinks, images, tables, and grammar).

[object Object]

Description

Write a description about what the component is for and how it should be used.

Variables

When a component has overridable variables, they'd be automatically displayed in the component guide. The variable type and initial value would be included as well.

[object Object]

Message Out

When you use Send responses with the Send to Parent or Send to Current Scene channels, they'd be automatically displayed in the component guide.

[object Object]

Message In

When you use Receive triggers with the Receive from Parent or Receive from Current Scene channels, they'd be automatically displayed in the component guide.

[object Object]

Previewing

When you use the component as an instance, you can see access the component guide by clicking on the component guide icon in the property panel.

[object Object]

Minimizing

When you use the component as an instance, you can see access the component guide by clicking on the component guide icon in the property panel.

[object Object]
Back To Top