Migration guide #173
Closed
Migration guide #173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
increase memory for deployment
increase memory for deployment
undavide
approved these changes
Oct 7, 2024
Comment on lines
77
to
81
| ### Workflow API example | ||
|
|
||
| **V3**: `Editor create API: ccEverywhere.createDesign(inputParams);` | ||
|
|
||
| **V4**: `Editor create API: ccEverywhere.editor.create(docConfig, appConfig, exportConfig, containerConfig);` |
There was a problem hiding this comment.
To avoid repetition of "Editor create API" and move it out of the monospace, an alternative could be:
Editor Workflow API example
V3: ccEverywhere.createDesign(inputParams);
V4: ccEverywhere.editor.create(docConfig, appConfig, exportConfig, containerConfig);
Comment on lines
92
to
94
| * Desired asset data type for images. | ||
| * For image output types, host can set this property to either base64 or url. The default type for images is base64. | ||
| * For videos, we will always send the output as a URL irrespective of this property. |
There was a problem hiding this comment.
I know it's a small thing, but I was once asked to carriage return the comments so the resulting code block doesn't have a horizontal scroll-bar and everything's visible, so:
* Desired asset data type for images.
* For image output types, host can set this property to either base64
* or url. The default type for images is base64.
* For videos, we will always send the output as a URL irrespective
* of this property.
You can copy and paste the above for convenience
Comment on lines
102
to
124
| ``` ts | ||
| { | ||
| /** Id of element to which iframe must be appended. By default, it is appended to the body.*/ | ||
| parentElementId?: string; | ||
| /** Maximum size boundary of the iframe.*/ | ||
| size?: PixelSize; | ||
| /** Minimum size boundary of the iframe.*/ | ||
| minSize?: PixelSize; | ||
| /** Padding applied to the iframe in pixels.*/ | ||
| padding?: number; | ||
| /** Border Radius applied to the iframe in pixels. */ | ||
| borderRadius?: number; | ||
| /** Override the background color of the iframe. By default this is as per theme. */ | ||
| backgroundColor?: string; | ||
| /** Show spinner while loading target app. Default is true. */ | ||
| showLoader?: boolean; | ||
| /** | ||
| * If target app doesn't open within this time (in ms, same as of setTimeout), | ||
| * the error callback is invoked with error code TARGET_LOAD_TIMED_OUT. | ||
| */ | ||
| loadTimeout?: number; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
{
/** Id of element to which iframe must be appended.
* By default, it is appended to the body. */
parentElementId?: string;
/** Maximum size boundary of the iframe.*/
size?: PixelSize;
/** Minimum size boundary of the iframe.*/
minSize?: PixelSize;
/** Padding applied to the iframe in pixels.*/
padding?: number;
/** Border Radius applied to the iframe in pixels. */
borderRadius?: number;
/** Override the background color of the iframe.
* By default this is as per theme. */
backgroundColor?: string;
/** Show spinner while loading target app. Default is true. */
showLoader?: boolean;
/**
* If the target app doesn't open within this time (in ms, same as
* setTimeout), the error callback is invoked with the error code
* TARGET_LOAD_TIMED_OUT.
*/
loadTimeout?: number;
}
Comment on lines
149
to
171
| ```ts | ||
| { | ||
| exportOptions?: ExportOptionsEditor[]; | ||
| /** | ||
| * Decides whether the multiple pages can be exported | ||
| * @default true | ||
| */ | ||
| multiPage?: boolean; | ||
| /** | ||
| * Specify the list of file types that the user can download. | ||
| * This can be used to limit the download options as per file types for end users. | ||
| * This limitation is applied to both native download and custom download scenarios. | ||
| */ | ||
| allowedFileTypes?: FileType[]; | ||
| /** | ||
| * Value between 0 and 1 to control the quality of the image. | ||
| * Currently, only supported for ImageFileType.JPEG when exporting. | ||
| * @minimum 0 | ||
| * @maximum 1 | ||
| */ | ||
| imageQuality?: number; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
{
exportOptions?: ExportOptionsEditor[];
/**
* Decides whether the multiple pages can be exported
* @default true
*/
multiPage?: boolean;
/**
* Specify the list of file types that the user can download.
* This can be used to limit the download options for end users
* based on file types. This limitation is applied to both native
* download and custom download scenarios.
*/
allowedFileTypes?: FileType[];
/**
* Value between 0 and 1 to control the quality of the image.
* Currently, only supported for ImageFileType.JPEG when exporting.
* @minimum 0
* @maximum 1
*/
imageQuality?: number;
}
Comment on lines
231
to
242
| ```ts | ||
| { | ||
| /** Export options to be displayed in Image Module. */ | ||
| exportOptions?: ExportOptionsEditor[]; | ||
| /** | ||
| * Specify the list of file types that the user can download. | ||
| * This can be used to limit the download options as per file types for end users. | ||
| * This limitation is applied to both native download and custom download scenarios. | ||
| */ | ||
| allowedFileTypes?: FileType[]; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
{
/** Export options to be displayed in Image Module. */
exportOptions?: ExportOptionsEditor[];
/**
* Specify the list of file types that the user can download.
* This can be used to limit the download options for end users
* based on file types. This limitation is applied to both native
* download and custom download scenarios.
*/
allowedFileTypes?: FileType[];
}
Comment on lines
273
to
275
| - `QuickActionDocParams`: This contains the common inputs for all QA. | ||
| - `<Image / Video>QuickActionDocParams extends QuickActionDocParams`: This contains the inputs relevant for a particular QA type (Image/Video/PDF). | ||
| - `<API-Specific>QuickActionParams extends Image/VideQuickActionParams`: inputs specific for a particular API. |
There was a problem hiding this comment.
The rendition is weird, but I suggest not losing any sleep over this, it's just Gatsby being Gatsby and AIO-Theme being AIO-Theme
Comment on lines
280
to
289
| ```ts | ||
| { | ||
| /** Theming options for the Quick Action Editor */ | ||
| colorTheme?: ColorTheme; | ||
| spectrumTheme?: SpectrumTheme; | ||
| scale?: Scale; | ||
| /** Boolean that tells whether to receive target application errors or not to client. */ | ||
| receiveTargetErrors?: boolean; | ||
| } | ||
| ``` |
There was a problem hiding this comment.
{
/** Theming options for the Quick Action Editor */
colorTheme?: ColorTheme;
spectrumTheme?: SpectrumTheme;
scale?: Scale;
/** Boolean that tells whether to receive target application
* errors or not to client. */
receiveTargetErrors?: boolean;
}|
|
||
| ### 1. Update SDK Version | ||
|
|
||
| Use this link to get the latest version -- [https://cc-embed.adobe.com/docs/v4/release/3p/modules.html](https://cc-embed.adobe.com/docs/v4/release/3p/modules.html) |
There was a problem hiding this comment.
We'll hot-fix this if/when it changes after the new SDK generation
gatsby-config.js
Outdated
| path: "/guides/concepts/migration.md", | ||
| pages: [ | ||
| { | ||
| title: "Migration Guide: Adobe Express Embed SDK V3 to V4", |
There was a problem hiding this comment.
I was wondering whether to use a shorter title (just in the navbar) that fits a single row, like "Migration Guide: V3 to V4," leaving the full title on the page.
|
@nimithajalal I see that GitHub is complaining: |
|
I am closing this PR, as this already went live. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: