Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to URL paths and folders required as a result of name changes #29

Merged
merged 2 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -102,188 +102,188 @@ module.exports = {
},
{
title: "Document Sandbox",
path: "references/authoring/",
path: "references/document-sandbox/",
pages: [
{
title: "Communication APIs",
path: "references/authoring/communication/",
path: "references/document-sandbox/communication/",
},
{
title: "Web APIs",
path: "references/authoring/web/",
path: "references/document-sandbox/web/",
},
{
title: "Document APIs",
path: "references/authoring/editor/",
path: "references/document-sandbox/document-apis/",
pages: [
{
title: "Classes",
path: "references/authoring/editor/classes/Editor.md",
path: "references/document-sandbox/document-apis/classes/Editor.md",
pages: [
{
title: "ArtboardList",
path: "references/authoring/editor/classes/ArtboardList.md",
path: "references/document-sandbox/document-apis/classes/ArtboardList.md",
},
{
title: "ArtboardNode",
path: "references/authoring/editor/classes/ArtboardNode.md",
path: "references/document-sandbox/document-apis/classes/ArtboardNode.md",
},
{
title: "Color",
path: "references/authoring/editor/classes/Color.md",
path: "references/document-sandbox/document-apis/classes/Color.md",
},
{
title: "ContainerNode",
path: "references/authoring/editor/classes/ContainerNode.md",
path: "references/document-sandbox/document-apis/classes/ContainerNode.md",
},
{
title: "Context",
path: "references/authoring/editor/classes/Context.md",
path: "references/document-sandbox/document-apis/classes/Context.md",
},
{
title: "EllipseNode",
path: "references/authoring/editor/classes/EllipseNode.md",
path: "references/document-sandbox/document-apis/classes/EllipseNode.md",
},
{
title: "Editor",
path: "references/authoring/editor/classes/Editor.md",
path: "references/document-sandbox/document-apis/classes/Editor.md",
},
{
title: "ExpressRootNode",
path: "references/authoring/editor/classes/ExpressRootNode.md",
path: "references/document-sandbox/document-apis/classes/ExpressRootNode.md",
},
{
title: "FillableNode",
path: "references/authoring/editor/classes/FillableNode.md",
path: "references/document-sandbox/document-apis/classes/FillableNode.md",
},
{
title: "GroupNode",
path: "references/authoring/editor/classes/GroupNode.md",
path: "references/document-sandbox/document-apis/classes/GroupNode.md",
},
{
title: "ImageRectangleNode",
path: "references/authoring/editor/classes/ImageRectangleNode.md",
path: "references/document-sandbox/document-apis/classes/ImageRectangleNode.md",
},
{
title: "ItemList",
path: "references/authoring/editor/classes/ItemList.md",
path: "references/document-sandbox/document-apis/classes/ItemList.md",
},
{
title: "LineNode",
path: "references/authoring/editor/classes/LineNode.md",
path: "references/document-sandbox/document-apis/classes/LineNode.md",
},
{
title: "MediaContainerNode",
path: "references/authoring/editor/classes/MediaContainerNode.md",
path: "references/document-sandbox/document-apis/classes/MediaContainerNode.md",
},
{
title: "Node",
path: "references/authoring/editor/classes/Node.md",
path: "references/document-sandbox/document-apis/classes/Node.md",
},
{
title: "PageList",
path: "references/authoring/editor/classes/PageList.md",
path: "references/document-sandbox/document-apis/classes/PageList.md",
},
{
title: "PageNode",
path: "references/authoring/editor/classes/PageNode.md",
path: "references/document-sandbox/document-apis/classes/PageNode.md",
},
{
title: "ReadOnlyItemList",
path: "references/authoring/editor/classes/ReadOnlyItemList.md",
path: "references/document-sandbox/document-apis/classes/ReadOnlyItemList.md",
},
{
title: "RectangleNode",
path: "references/authoring/editor/classes/RectangleNode.md",
path: "references/document-sandbox/document-apis/classes/RectangleNode.md",
},
{
title: "StrokableNode",
path: "references/authoring/editor/classes/StrokableNode.md",
path: "references/document-sandbox/document-apis/classes/StrokableNode.md",
},
{
title: "TextNode",
path: "references/authoring/editor/classes/TextNode.md",
path: "references/document-sandbox/document-apis/classes/TextNode.md",
},
],
},
{
title: "Interfaces",
path: "references/authoring/editor/interfaces/BitmapImage.md",
path: "references/document-sandbox/document-apis/interfaces/BitmapImage.md",
pages: [
{
title: "BitmapImage",
path: "references/authoring/editor/interfaces/BitmapImage.md",
path: "references/document-sandbox/document-apis/interfaces/BitmapImage.md",
},
{
title: "ColorFill",
path: "references/authoring/editor/interfaces/ColorFill.md",
path: "references/document-sandbox/document-apis/interfaces/ColorFill.md",
},
{
title: "Fill",
path: "references/authoring/editor/interfaces/Fill.md",
path: "references/document-sandbox/document-apis/interfaces/Fill.md",
},
// {
// "title": "FillTypeValueExtensibleEnum",
// "path": "references/authoring/editor/interfaces/FillTypeValueExtensibleEnum.md",
// "path": "references/document-sandbox/document-apis/interfaces/FillTypeValueExtensibleEnum.md",
// },
{
title: "IFillableNode",
path: "references/authoring/editor/interfaces/IFillableNode.md",
path: "references/document-sandbox/document-apis/interfaces/IFillableNode.md",
},
{
title: "IRectangularNode",
path: "references/authoring/editor/interfaces/IRectangularNode.md",
path: "references/document-sandbox/document-apis/interfaces/IRectangularNode.md",
},
{
title: "ListItem",
path: "references/authoring/editor/interfaces/ListItem.md",
path: "references/document-sandbox/document-apis/interfaces/ListItem.md",
},
{
title: "RectangleGeometry",
path: "references/authoring/editor/interfaces/RectangleGeometry.md",
path: "references/document-sandbox/document-apis/interfaces/RectangleGeometry.md",
},

{
title: "Stroke",
path: "references/authoring/editor/interfaces/Stroke.md",
path: "references/document-sandbox/document-apis/interfaces/Stroke.md",
},
{
title: "StrokeOptions",
path: "references/authoring/editor/interfaces/StrokeOptions.md",
path: "references/document-sandbox/document-apis/interfaces/StrokeOptions.md",
},
{
title: "Utils",
path: "references/authoring/editor/interfaces/Utils.md",
path: "references/document-sandbox/document-apis/interfaces/Utils.md",
},
],
},
{
title: "Constants",
path: "references/authoring/editor/enums/ArrowHeadType.md",
path: "references/document-sandbox/document-apis/enums/ArrowHeadType.md",
pages: [
{
title: "ArrowHeadType",
path: "references/authoring/editor/enums/ArrowHeadType.md",
path: "references/document-sandbox/document-apis/enums/ArrowHeadType.md",
},
{
title: "BlendMode",
path: "references/authoring/editor/enums/BlendMode.md",
path: "references/document-sandbox/document-apis/enums/BlendMode.md",
},
{
title: "FillType",
path: "references/authoring/editor/enums/FillType.md",
path: "references/document-sandbox/document-apis/enums/FillType.md",
},
{
title: "SceneNodeType",
path: "references/authoring/editor/enums/SceneNodeType.md",
path: "references/document-sandbox/document-apis/enums/SceneNodeType.md",
},
{
title: "StrokePosition",
path: "references/authoring/editor/enums/StrokePosition.md",
path: "references/document-sandbox/document-apis/enums/StrokePosition.md",
},
{
title: "TextAlignment",
path: "references/authoring/editor/enums/TextAlignment.md",
path: "references/document-sandbox/document-apis/enums/TextAlignment.md",
},
],
},
Expand Down
6 changes: 3 additions & 3 deletions src/pages/guides/develop/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -616,13 +616,13 @@ validateUser(userId: string) {

## Authoring Content

We provide a set of [Document APIs](../../references/authoring/editor/) that can be used for interacting with the document for common use cases like creating shapes, adding pages, clearing the artboard and more.
We provide a set of [Document APIs](../../references/document-sandbox/document-apis/) that can be used for interacting with the document for common use cases like creating shapes, adding pages, clearing the artboard and more.

<InlineAlert slots="text" variant="warning"/>

The Editor API's are currently **experimental only**. Please do not use them in any add-ons you plan to distribute or submit with updates until they have been deemed stable.

The following code snippet illustrates how to use the [Document APIs](../../references/authoring/editor/) from the script running in your [`code.js`](../../references/authoring/index.md#getting-started-with-the-apis) for instance, to access the current document, create a rectangle, set some properties and a fill for the rectangle, and finally, add it to the document:
The following code snippet illustrates how to use the [Document APIs](../../references/document-sandbox/document-apis/) from the script running in your [`code.js`](../../references/document-sandbox/index.md#getting-started-with-the-apis) for instance, to access the current document, create a rectangle, set some properties and a fill for the rectangle, and finally, add it to the document:

```js
import { editor, utils } from "express";
Expand All @@ -645,4 +645,4 @@ insertionParent.children.append(rectangle);

<InlineAlert slots="text" variant="info"/>

Refer to [getting started with the Document Sandbox](../../references/authoring/index.md#getting-started-with-the-apis) for more details on how to set up your add-on to use the script-based APIs, which include the Document APIs for authoring content.
Refer to [getting started with the Document Sandbox](../../references/document-sandbox/index.md#getting-started-with-the-apis) for more details on how to set up your add-on to use the script-based APIs, which include the Document APIs for authoring content.
6 changes: 3 additions & 3 deletions src/pages/references/addonsdk/instance-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ The [RuntimeType](addonsdk-constants.md) constant representing the entrypoint cr

## Experimental Methods

The following methods allow you to communicate bidirectionally between the add-on running in the iframe and the [document sandbox](../authoring/) environments.
The following methods allow you to communicate bidirectionally between the add-on running in the iframe and the [document sandbox](../document-sandbox/) environments.

**IMPORTANT:** These methods are currently ***experimental only*** and should not be used in any add-ons you will be distributing until they have been deemed stable. To use these methods, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../manifest/index.md#requirements) section of the `manifest.json`.

### exposeApi()

Use this method to expose an API from your UI code running in the iframe to another runtime (ie: the [document sandbox code](../authoring/) defined in your `code.js` for instance).
Use this method to expose an API from your UI code running in the iframe to another runtime (ie: the [document sandbox code](../document-sandbox/) defined in your `code.js` for instance).

#### Signature

Expand All @@ -44,7 +44,7 @@ Requests a promise-based proxy object from another runtime to be used to call th

| Name | Type | Description |
| --------------| ------------| -----------: |
| `runtimeType` | `RuntimeType` | The runtime type to create the proxy object from (ie: "script" for instance, which maps to the code referenced in the [`script` entryPoint](../authoring/index.md#script-entry-point) in your add-on's `manifest.js` file). |
| `runtimeType` | `RuntimeType` | The runtime type to create the proxy object from (ie: "script" for instance, which maps to the code referenced in the [`script` entryPoint](../document-sandbox/index.md#script-entry-point) in your add-on's `manifest.js` file). |

#### Return

Expand Down
Loading
Loading