Skip to content

Commit

Permalink
Remove beta, max updates v1
Browse files Browse the repository at this point in the history
  • Loading branch information
hollyschinsky committed Oct 5, 2023
1 parent 79e34db commit d6dd377
Show file tree
Hide file tree
Showing 54 changed files with 8,261 additions and 64 deletions.
183 changes: 180 additions & 3 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,187 @@ module.exports = {
},
{
"title": "Editor APIs",
"path": "references/scriptruntime/editor/",
}
"path": "references/scriptruntime/editor/",
pages: [
{
"title": "Classes",
"path": "references/scriptruntime/editor/classes/Editor.md",
pages: [
{
"title": "ArtboardList",
"path": "references/scriptruntime/editor/classes/ArtboardList.md",
},
{
"title": "ArtboardNode",
"path": "references/scriptruntime/editor/classes/ArtboardNode.md",
},
{
"title": "Color",
"path": "references/scriptruntime/editor/classes/Color.md"
},
{
"title": "ContainerNode",
"path": "references/scriptruntime/editor/classes/ContainerNode.md"
},
{
"title": "Context",
"path": "references/scriptruntime/editor/classes/Context.md"
},
{
"title": "EllipseNode",
"path": "references/scriptruntime/editor/classes/EllipseNode.md"
},
{
"title": "Editor",
"path": "references/scriptruntime/editor/Editor.md"
},
{
"title": "ExpressGroupNode",
"path": "references/scriptruntime/editor/classes/ExpressGroupNode.md"
},
{
"title": "FillableNode",
"path": "references/scriptruntime/editor/classes/FillableNode.md"
},
{
"title": "GroupNode",
"path": "references/scriptruntime/editor/classes/GroupNode.md"
},
{
"title": "ImageRectangleNode",
"path": "references/scriptruntime/editor/classes/ImageRectangleNode.md"
},
{
"title": "ItemList",
"path": "references/scriptruntime/editor/classes/ItemList.md"
},
{
"title": "LineNode",
"path": "references/scriptruntime/editor/classes/LineNode.md"
},
{
"title": "MediaContainerNode",
"path": "references/scriptruntime/editor/classes/MediaContainerNode.md"
},
{
"title": "Node",
"path": "references/scriptruntime/editor/classes/Node.md"
},
{
"title": "PageList",
"path": "references/scriptruntime/editor/classes/PageList.md"
},
{
"title": "PageNode",
"path": "references/scriptruntime/editor/classes/PageNode.md"
},
{
"title": "ReadOnlyItemList",
"path": "references/scriptruntime/editor/classes/ReadOnlyItemList.md"
},
{
"title": "RectangleNode",
"path": "references/scriptruntime/editor/classes/RectangleNode.md"
},
{
"title": "StrokableNode",
"path": "references/scriptruntime/editor/classes/StrokableNode.md"
},
{
"title": "TextNode",
"path": "references/scriptruntime/editor/classes/TextNode.md"
},
],
},
{
"title": "Interfaces",
"path": "references/scriptruntime/editor/interfaces/BitmapImage.md",
pages: [
{
"title": "BitmapImage",
"path": "references/scriptruntime/editor/interfaces/BitmapImage.md",
},
{
"title": "ColorFill",
"path": "references/scriptruntime/editor/interfaces/ColorFill.md",
},
{
"title": "Fill",
"path": "references/scriptruntime/editor/interfaces/Fill.md",
},
{
"title": "FillTypeValueExtensibleEnum",
"path": "references/scriptruntime/editor/interfaces/FillTypeValueExtensibleEnum.md",
},
{
"title": "IFillableNode",
"path": "references/scriptruntime/editor/interfaces/IFillableNode.md",
},
{
"title": "IRectangularNode",
"path": "references/scriptruntime/editor/interfaces/IRectangularNode.md",
},
{
"title": "ListItem",
"path": "references/scriptruntime/editor/interfaces/ListItem.md",
},
{
"title": "RectangleGeometry",
"path": "references/scriptruntime/editor/interfaces/RectangleGeometry.md",
},

{
"title": "Stroke",
"path": "references/scriptruntime/editor/interfaces/Stroke.md",
},
{
"title": "StrokeOptions",
"path": "references/scriptruntime/editor/interfaces/StrokeOptions.md",
},
{
"title": "Utils",
"path": "references/scriptruntime/editor/interfaces/Utils.md",
},
]

},
{

"title": "Constants",
"path": "references/scriptruntime/editor/enums/BlendModeValue.md",
pages: [
{
"title": "ArrowHeadType",
"path": "references/scriptruntime/editor/enums/ArrowHeadType.md"
},
{
"title": "BlendModeValue",
"path": "references/scriptruntime/editor/enums/BlendModeValue.md"
},
{
"title": "FillTypeValue",
"path": "references/scriptruntime/editor/enums/FillTypeValue.md"
},
{
"title": "SceneNodeTypeValueID",
"path": "references/scriptruntime/editor/enums/SceneNodeTypeValueID.md"
},
{
"title": "StrokePositionValue",
"path": "references/scriptruntime/editor/enums/StrokePositionValue.md"
},
{
"title": "TextAlignmentValue",
"path": "references/scriptruntime/editor/enums/TextAlignmentValue.md"
},
],
},


]
},
]
},
},
{
title: 'Manifest Schema',
description: 'Manifest schema',
Expand Down
44 changes: 34 additions & 10 deletions src/pages/guides/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,11 @@ contributors:
- https://github.com/hollyschinsky
---

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

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

# Implementing Common Use Cases
This guide contains a set of common use cases and accompanying code snippets to explore the capabilities of the Adobe Express add-ons platform.


If you're looking for more extensive examples for any of the use cases described below, you can also check out our [code samples](https://developer.adobe.com/express/add-ons/docs/samples/). The [SDK References](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/) can be used to find all of the objects, methods, properties and events supported for building add-ons. This short video below also provides an introduction to some of the add-on features and APIs available for use in your add-ons.<br/><br/>

<div style="display: flex; justify-content: center;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/HHnX5o8CxHU?si=4w4KvQVdkl8r5BZZ" title="Building Add-on Features" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>

If you're looking for more extensive examples for any of the use cases described below, you can also check out our [code samples](https://developer.adobe.com/express/add-ons/docs/samples/). The [SDK References](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/) can be used to find all of the objects, methods, properties and events supported for building add-ons.

## Importing Content
Importing content into a design is one of the most popular use cases. For instance, to add content retrieved from a third-party service or directly from the local hard drive. The following example use cases for implementing this feature. The first function shows how to implement it by adding an image directly from a `blob` object, and the second shows how to implement it by fetching an image via a URL first. Follow the example below to implement this feature, but also be sure to refer to the [related SDK Reference section](https://developer.adobe.com/express/add-ons/docs/references/addonsdk/app-document/#methods) and [code samples](https://developer.adobe.com/express/add-ons/docs/samples/) for more details.
Expand Down Expand Up @@ -592,3 +583,36 @@ validateUser(userId: string) {
### Output
`Current Userid: 3cda976828a4a90d13b0f38b1f8a59b1d6845cccfc48037fb30bb75d3ef67d36`
## Authoring Content
We provide a set of [Editor APIs](../../references/scriptruntime/editor/) 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 [Editor APIs](../../references/scriptruntime/editor/) from the script running in your [`code.js`](https://developer.adobe.com/express/add-ons/docs/references/scriptruntime/#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:
### Example
```js
import { editor, utils } from "express";

const insertionParent = editor.context.insertionParent; // get node to insert content into

const rectangle = editor.createRectangle();
rectangle.width = 200;
rectangle.height = 150;
rectangle.translateX = 100;
rectangle.translateY = 20;
console.log(rectangle); // for debugging purpose

const [red, green, blue, alpha] = [0.8, 0.6, 0.2, 0.7];
const rectangleFill = editor.createColorFill(utils.createColor(red, green, blue, alpha));
rectangle.fills.append(rectangleFill);

insertionParent.children.append(rectangle);
```
<InlineAlert slots="text" variant="info"/>
Refer to [getting started with Script Runtime](https://developer.adobe.com/express/add-ons/docs/references/scriptruntime/#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 Editor APIs.
3 changes: 0 additions & 3 deletions src/pages/guides/distribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ description: This is the submission and review overview page
contributors:
- https://github.com/hollyschinsky
---
<InlineAlert slots="text" variant="info"/>

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

# Distribution Overview

Expand Down
4 changes: 0 additions & 4 deletions src/pages/guides/distribute/review_guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
<InlineAlert slots="text" variant="info"/>

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

# Review Guidelines
Coming soon!
4 changes: 0 additions & 4 deletions src/pages/guides/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ description: This is the FAQ page
contributors:
- https://github.com/hollyschinsky
---
<InlineAlert slots="text" variant="info"/>

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).


# Frequently Asked Questions

Expand Down
4 changes: 0 additions & 4 deletions src/pages/guides/getting_started/dev_tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@ contributors:
- https://github.com/hollyschinsky
---

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

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

# Development Tools

## Using the CLI
Expand Down
6 changes: 0 additions & 6 deletions src/pages/guides/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,6 @@ contributors:
- https://github.com/hollyschinsky
---

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

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

<br/><br/>

# Getting Started Overview
This section provides everything you need to know to get started building add-ons for Adobe Express.

Expand Down
8 changes: 0 additions & 8 deletions src/pages/guides/getting_started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
<InlineAlert slots="text" variant="info"/>

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

<br/><br/>

# Quickstart

This quickstart guide will help you create and run your first add-on, a simple hello world add-on built with plain JavaScript.
Expand All @@ -25,8 +19,6 @@ Check out this short video below to get a quick visual introduction to the steps
- [NodeJS](https://nodejs.org/en/download/) (major version of 16 or greater) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (major version of 8 or greater) installed
- Familiarity with programming in HTML, CSS and JavaScript
- An Adobe Express account (use an existing Adobe ID or simply create one for free).
- Access to the beta version of Adobe Express ([Join the waitlist](https://adobe.com/go/express-developer))
- Adobe Express add-on [CLI](#cli) ([Join the waitlist](https://adobe.com/go/express-developer))

### Add-on CLI
The **add-on CLI (Command Line Interface) is required for add-on development**, and allows you to create and host Adobe Express add-ons directly from your local machine. Currently, however, the CLI is offered on a wait list only basis. Please fill in and submit [this wait list form](https://adobe.com/go/express-developer) if you're interested in developing add-ons.
Expand Down
3 changes: 1 addition & 2 deletions src/pages/guides/getting_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ This guide will help you set up your development environment so you can get star
- Familiarity with programming in HTML, CSS and JavaScript.
- The add-on CLI installed on your local machine.
- An email address associated with an Adobe ID. If you don't have one yet, you'll be taken through steps to create one in this guide.
- Access to the beta version of Adobe Express. [**Join our wait list**](../)

## Add-on CLI (Command Line Interface)
To facilitate the development of add-ons, we have incorporated a command line interface (CLI). This CLI will enable you to create and run Express add-ons directly in your local machine and load them into Adobe Express Beta in your browser. Before you can use the CLI, you must install it to your local environment.
To facilitate the development of add-ons, we have incorporated a command line interface (CLI). This CLI will enable you to create and run Express add-ons directly in your local machine and load them into Adobe Express in your browser. Before you can use the CLI, you must install it to your local environment.

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

Expand Down
8 changes: 0 additions & 8 deletions src/pages/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,6 @@ contributors:
# Overview
Adobe Express is the AI-first, all-in-one creativity app that makes it fast, easy and fun for any user to design and share standout content.


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

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).

<br/><br/>


## Add-ons
Add-ons extend the functionality of [Adobe Express](https://new.express.adobe.com/), unlocking creative workflows for Adobe Express users. The add-ons marketplace is a dedicated platform for developers to distribute and users to discover new add-ons. Check out this quick introduction to Adobe Express add-ons to learn more, then read on to get started. <br/><br/>

Expand Down
9 changes: 0 additions & 9 deletions src/pages/references/addonsdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,6 @@ description: The Adobe Express add-on SDK Reference.
contributors:
- https://github.com/hollyschinsky
---

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

Preview Adobe Express add-on SDK documentation while you wait to [join our private beta](https://adobe.com/go/express-developer).



<br/> <br/>

# AddOnSdk Reference

## Overview
Expand Down
2 changes: 1 addition & 1 deletion src/pages/references/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ which include:

- All new add-ons created (other than those based on javascript) use `spectrum-web-components` with the Express theme pre-set.
- React-based templates include [`swc-react`](https://opensource.adobe.com/spectrum-web-components/using-swc-react/) setup.
- The `javascript-with-editor-apis` template has been removed in this version but replaced with the option from the CLI to [include the script runtime](https://developer.adobe.com/express/add-ons/docs/references/scriptruntime/#cli-generated-script-runtime-add-on) when creating a new add-on.
- The `javascript-with-editor-apis` template has been removed from the initial template selection in this version but replaced with the option from the CLI to [include the script runtime](https://developer.adobe.com/express/add-ons/docs/references/scriptruntime/#cli-generated-script-runtime-add-on) when creating a new add-on.

* New type support for typescript based add-ons.
* Ability to recreate your SSL certificates.
Expand Down
2 changes: 0 additions & 2 deletions src/pages/references/manifest/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,6 @@ The following platform values are currently supported in the `supportedDeviceCla
| `app` | Native app on mobile and tablet devices. |


**Note:** *The beta version of Adobe Express is currently not yet supported on mobile or tablet devices.*

## entryPoints
| Key | Type | Description |
| -------------| -------------| -----------: |
Expand Down
Loading

0 comments on commit d6dd377

Please sign in to comment.