Skip to content

Commit 316501d

Browse files
authored
Merge pull request #228 from AdobeXD/xd-33-docs
Xd 33 docs
2 parents e44cd9e + d49b3d6 commit 316501d

File tree

3 files changed

+44
-3
lines changed

3 files changed

+44
-3
lines changed

changes.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Change Log
22

3-
XD Release 32.0.12 (August 2020)
3+
XD Release 33.0.12 (September 2020)
4+
-------------------------------------
5+
6+
### New API features
7+
8+
[Read multiple flows](./reference/interactions.md#module_interactions-flows)
9+
10+
11+
XD Release 32.0.22 (August 2020)
412
-------------------------------------
513

614
### New feature

reference/interactions.md

Lines changed: 33 additions & 2 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).
@@ -39,12 +39,14 @@ See [Interaction documentation](#Interaction) below for an example of what an In
3939

4040
* [interactions](#module_interactions)
4141
* [.homeArtboard](#module_interactions-homeArtboard) : <code>?Artboard</code>
42+
* [.flows](#module_interactions-flows) : <code>!Array&lt;!FlowInfo&gt;</code>
4243
* [.allInteractions](#module_interactions-allInteractions) : <code>!Array&lt;!{triggerNode: !SceneNode, interactions: !Array&lt;!Interaction&gt;}&gt;</code>
4344
* Typedefs:
4445
* [Interaction](#Interaction)
4546
* [Trigger](#Trigger)
4647
* [Action](#Action)
4748
* [Transition](#Transition)
49+
* [FlowInfo](#FlowInfo)
4850

4951

5052
## Typedefs
@@ -169,13 +171,27 @@ Animation style with which `"goToArtboard"` and `"overlay"` actions transition f
169171
| duration | number | Length of animation in seconds. |
170172
| easing | string | One of: `"linear"`, `"ease-in"`, `"ease-out"`, `"ease-in-out"`, `"wind-up"`, `"bounce"`, `"snap"` |
171173

174+
<a name="FlowInfo" id="FlowInfo"></a>
175+
176+
### Typedef FlowInfo
177+
Information related to a particular flow
178+
179+
| Property | Type | Description |
180+
| --- | --- | --- |
181+
| name | string | Auto-generated or user-defined label for a particular flow. |
182+
| homeArtboard | \![Artboard](./scenegraph.md#Artboard) | Artboard from which a particular flow or a prototype experience begins. |
183+
| url | string | URL is the latest published link associated with a particular flow and can be `null` in case no link is published for that flow. |
184+
185+
NOTE: All `url` returned via [flows](#module_interactions-flows) are related to published flows and are usually a subset of the URLs returned via [getSharedArtifacts](./cloud.md#module_cloud-getSharedArtifacts). However, the reverse may or may not always hold true.
172186

173187
* * *
174188

175189
<a name="module_interactions-homeArtboard"></a>
176190

177191
### *interactions.homeArtboard : <code>?Artboard</code>*
178-
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.
179195

180196
**Since**: XD 32
181197

@@ -187,6 +203,21 @@ In case there are multiple interactive prototype experiences (flows), implying m
187203
**See**: [`Artboard.isHomeArtboard`](./scenegraph.md#Artboard-isHomeArtboard)
188204

189205

206+
* * *
207+
208+
<a name="module_interactions-flows"></a>
209+
210+
### *interactions.flows : <code>!Array&lt;\![FlowInfo](#FlowInfo)&gt;</code>*
211+
212+
**Since**: XD 33
213+
214+
Returns a collection of information on *all* flows across the entire document.
215+
216+
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.
217+
218+
**Kind**: static property of [<code>interactions</code>](#module_interactions)
219+
**Read only**: true
220+
190221
* * *
191222

192223
<a name="module_interactions-allInteractions"></a>

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)