Skip to content

Commit d49b3d6

Browse files
committed
Updated description, deprecated previous homeArtboard APIs
1 parent 73e9056 commit d49b3d6

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

reference/interactions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `interactions` module and related APIs provide _read only_ information about
88
or you can access information from specific nodes in the scenegraph via [`SceneNode.triggeredInteractions`](./scenegraph.md#SceneNode-triggeredInteractions)
99
and [`Artboard.incomingInteractions`](./scenegraph.md#Artboard-incomingInteractions).
1010

11-
* Which artboard the prototype experience begins on: [`homeArtboard`](#module_interactions-homeArtboard).
11+
* Designers can author multiple prototype or interaction flows in a single document and publish unique shareable links for each flow. Developers can access all document flows using the [`flows`](#module_interactions-flows) API. With multiple flow support the [`homeArtboard`](#module_interactions-homeArtboard) API is being deprecated as XD no longer has a single home artboard restriction.
1212

1313
* Properties that affect Artboard scrolling behavior: Artboard [`viewportHeight`](./scenegraph.md#Artboard-viewportHeight) and
1414
node [`fixedWhenScrolling`](./scenegraph.md#SceneNode-fixedWhenScrolling).
@@ -189,7 +189,9 @@ NOTE: All `url` returned via [flows](#module_interactions-flows) are related to
189189
<a name="module_interactions-homeArtboard"></a>
190190

191191
### *interactions.homeArtboard : <code>?Artboard</code>*
192-
The starting Artboard seen when the interactive prototype is launched.
192+
The starting Artboard seen when the interactive prototype is launched.
193+
194+
**Deprecated**: XD 33 - Please use [`flows`](#module_interactions-flows) which supports multple flows.
193195

194196
**Since**: XD 32
195197

@@ -206,10 +208,11 @@ In case there are multiple interactive prototype experiences (flows), implying m
206208
<a name="module_interactions-flows"></a>
207209

208210
### *interactions.flows : <code>!Array&lt;\![FlowInfo](#FlowInfo)&gt;</code>*
209-
Returns a collection of information on *all* flows across the entire document.
210211

211212
**Since**: XD 33
212213

214+
Returns a collection of information on *all* flows across the entire document.
215+
213216
A `flow` is a series or set of artboards starting from one artboard (called a home artboard), which are connected to other artboards or screens via wires or interactions. A document can have zero or multiple (one or more than one) flows and can therefore have zero or multiple home artboards. Each entry in the return array represents a `FlowInfo` object.
214217

215218
**Kind**: static property of [<code>interactions</code>](#module_interactions)

reference/scenegraph.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1405,6 +1405,8 @@ Note: currently, this API excludes any applicable keyboard/gamepad interactions.
14051405
<a name="Artboard-isHomeArtboard"></a>
14061406

14071407
### artboard.isHomeArtboard : <code>boolean</code>
1408+
**Deprecated**: XD 33 - Please use [`flows`](./interactions.md#module_interactions-flows) which supports multple flows.
1409+
14081410
**Since**: XD 19
14091411

14101412
True if this is the starting Artboard seen when the interactive prototype is launched.

0 commit comments

Comments
 (0)