UXP v6.4 API reference docs (#91)

* new doc fixes * updating versions md * New API: window.Path * Fixing product name * Bumping package version number * removing TODO * removing extra uxp * Manually fixing issue #86 * Typos * Reverting changes * Addressing issue #86 and adding Object details * Add more description to Path.md * review comment - fixing space * Addressing review comments Co-authored-by: Padma Krishnamoorthy <[email protected]> Co-authored-by: Padma Krishnamoorthy <[email protected]>
AdobeDocs · Dec 20, 2022 · 670777d · 670777d
1 parent 9be617f
commit 670777d
Show file tree

Hide file tree

Showing 48 changed files with 679 additions and 278 deletions.
diff --git a/README.md b/README.md
@@ -38,44  38,3 @@ UXP_REPO_SOURCE_DOCS="<path-to-torq-native>/docs/dist"
 
 The side navigation panel in the devsite is generated from the `reference-*.js` files.
 
-### Work in progress or TODO
-
-1. For Persistent file storage APIs, `storage.md` is not utilized yet. Some fixes to the old files were manually added. Refer to https://github.com/AdobeDocs/uxp/commit/b3c0c783bf3195704abfe18e1190ca7b5c0d534d. Make sure you dont update `Persistent file storage/index.md` until you want to use storage.md. 
-    * FileSystem.md was manually created by copying content from Storage.md
-2. In the future, `_transclusions` should be generated from `torq-native`. For now, any new files should be manually added to `_transclusions` and `reference-*.js` files. Otherwise, it will not appear in the devsite.
-3.  Few files were manually changed in this repo. Be careful while merging their content. The incomming changes might be missing some information or change formatting. In the future, move these changes to the UXP source files.
-    * `reference-js/index.md`
-    * `LocalStorage.md`
-    * `SessionStorage.md`
-    * `Versions.md`
-    * `version3P.md`
-    * `known-issues.md`
-    * `changelog3P.md`
-    * `src/pages/uxp/index.md`
-    * `reference-spectrum/index.md`
-    * `reference-js/index.md`
-    * `HTMLWebViewElement.md`
-4. Maintain a consistent order for the API information. 
-    * Since
-    * Description
-    * See <link>
-    * Params
-    * Returns
-    * Throws
-    * Examples
-5. Inconsistency in types
-    * *String, string
-    * *Boolean, bool, boolean
-    * *Array array
-    * *Promise Promise<void>
-    * *\* any
-    * *Object object
-    * int number Number
-6. Other fixes done manually in this repo which should be fixed in sourve files:
-    * Backticks in H1 titles in source files.
-    * Extra dots. Example `Promise.<void>` in SecureStorage.md
-    * `<br>` tags without a closing `</br>`
-7. Index pages (coming from index.md) show links ordered alphabetically. For example: https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Global Members/HTML DOM/. But the left side panel (coming from reference-*.js) is not necessarily alphabetical. Make them consistent.
-
-
-
diff --git a/_transclusions/photoshop/uxp/reference-js/Global Members/Path.md b/_transclusions/photoshop/uxp/reference-js/Global Members/Path.md
@@ -0,0  1,4 @@
 
 import Content from "uxp-documentation/src/pages/uxp/reference-js/Global Members/Path/Path.md";
 
 <Content query="product=photoshop"/>
diff --git a/_transclusions/xd/uxp/reference-js/Global Members/Crypto.md b/_transclusions/xd/uxp/reference-js/Global Members/Crypto.md
@@ -1,4  1,4 @@
 
 import Content from "uxp-documentation/src/pages/uxp/reference-js/Global Members/Crypto/Crypto.md";
 
-<Content query="product=photoshop"/>
 <Content query="product=xd"/>
diff --git a/_transclusions/xd/uxp/reference-js/Global Members/Path.md b/_transclusions/xd/uxp/reference-js/Global Members/Path.md
@@ -0,0  1,4 @@
 
 import Content from "uxp-documentation/src/pages/uxp/reference-js/Global Members/Path/Path.md";
 
 <Content query="product=xd"/>
diff --git a/package.json b/package.json
@@ -1,7  1,7 @@
 {
   "private": true,
   "name": "uxp-documentation",
-  "version": "0.0.17",
   "version": "6.4",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

diff --git a/reference-js.js b/reference-js.js
@@ -245,6  245,10 @@ module.exports=[
           }
         ],
         "path": "/uxp/reference-js/Global Members/HTML Elements/"
       },
       {
         "title": "Path",
         "path": "/uxp/reference-js/Global Members/Path/"
       }
     ],
     "path": "/uxp/reference-js/Global Members/"

diff --git a/src/pages/uxp/changelog3P.md b/src/pages/uxp/changelog3P.md
@@ -4,6  4,28 @@ index_desc: Change Log in UXP version
 
 # UXP Changelog
 
 ## UXP v6.4
 
 ### New
 - [UXP-20237]: Webviews for Panels
 - [UXP-20191]: Support Path Module APIs
 - [UXP-20247]: Script can run fsapi with full access in localFileSystem
 
 ### Bugs Fixes
 - [UXP-19364]: PluginManifest parsing / Load Plugin errors not logged in UDT
 - [UXP-19978]: Error shown in UDT APP logs on Plugin UnLoad
 - [UXP-20059]: UXP script : file session tokens are not getting created
 - [UXP-20199]: Error message and stack are empty in case of reject("error string") executed in script
 - [UXP-20121]: [Win only]-Volume is being muted automatically for 3rd video in the tutorial while opening the video in Theatre mode
 - [UXP-20039]: After closing the theatre mode, video's are Overlapping while scrolling up and down in DP
 - [UXP-19995]: Provide an API to programmatically close dialog in pop-out/theatre mode.
 - [UXP-20095]: Plugin Data folder shouldn't be created for scripts
 - [UXP-20168]: Crash on exit
 - [UXP-20215]: script.setResult("kSuccess") not working
 - [UXP-19851]: Resource Leaks in Window Dialog on UWP
 - [UXP-19920]: Privilege plugin fail to add in XD in certain cases
 - Fixed mouse/keyboard events within Webview in XD v55 and Win 10.
 
 ## UXP v6.3
 
 ### New

diff --git a/src/pages/uxp/known-issues.md b/src/pages/uxp/known-issues.md
@@ -40,9  40,6 @@ The following issues are known. Please check this page with future updates, as k
 * The `location` attribute for `sp-tooltip` seems like it would control the position of the tooltip relative to its attachment. This is not how the attribute actually works -- it instead controls the tooltip's "tip" direction. If `location` is set to `bottom`, the tip will be pointed upwards under the assumption that your code has already placed the tooltip below the control. (PS-56708) _Better tooltip handling is coming in a future release_.
 * The numeric `sp-textfield` can trigger numeric validation errors, even when the entered value would seem to be correct. This will be addressed in a future release. The limitation on valid ranges is an issue with numeric fields in Photoshop in general and is a separate issue. (PS-57698)
 
-## WebView
-* Mouse/Keyboard events within Webview doesn't work in XD v55 and Win 10 due to a [Microsoft issue](https://github.com/microsoft/microsoft-ui-xaml/issues/6427). Fix for this is in progress.
-
 ## Events
 
 * `uxpshowpanel` and the corresponding `show` callback occurs only once, when the panel is initially made visible. It will not recur. This will be fixed in the future. (PS-57284)
@@ -65,8  62,8 @@ The following issues are known. Please check this page with future updates, as k
 * `<label for="id"/>` is not supported. Wrap `<label>` around the control instead.
 * `<input type="file" />` is not supported.
 * `<input type="color" />` is not supported.
-* Using unitless values in `width` and `height` attributes are not supported in UXP 3.1. Use `px`, or CSS styles.
-* `<label>` uses `inline-flex` layout semantics in UXP 3.1 mode, with `flex-wrap: wrap` enabled. If you need to prevent wrapping, use `flex-wrap: nowrap` on these elements. Note that the default layout behavior is now _horizontal_ not _vertical_.
 * Using unitless values in `width` and `height` attributes are not supported in UXP v3.1. Use `px`, or CSS styles.
 * `<label>` uses `inline-flex` layout semantics in UXP v3.1 mode, with `flex-wrap: wrap` enabled. If you need to prevent wrapping, use `flex-wrap: nowrap` on these elements. Note that the default layout behavior is now _horizontal_ not _vertical_.
 * `<progress>` is not theme aware.
 * Password field values cannot be read on macOS. A workaround for this is to set the `type` to `text` on `focus` and switch it back to `password` on `blur`.
 

diff --git a/src/pages/uxp/reference-css/Styles/opacity.md b/src/pages/uxp/reference-css/Styles/opacity.md
@@ -3,7  3,7 @@ jsDoc: true
 ---
 # opacity
 
-**Since :** UXP 2
 **Since:** UXP v2.0
 
 Sets the opacity of an element. The value is between 0 (transparent) and 1 (opaque).
 

diff --git a/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md b/src/pages/uxp/reference-js/Global Members/Data Transfers/Clipboard.md
@@ -17,7  17,7 @@ Note: Clipboard access is not supported for 3P plugins with manifest version upt
 <a name="clipboard-setcontent" id="clipboard-setcontent"></a>
 
 ## setContent(data)
-Set data to clipboard. 
 Set data to clipboard.
 Note: This is a non-standard API.
 
 **Returns**: `Promise`  
@@ -35,7  35,7 @@ navigator.clipboard.setContent({"text/plain": "Hello!"});
 <a name="clipboard-getcontent" id="clipboard-getcontent"></a>
 
 ## getContent()
-Get data from clipboard. 
 Get data from clipboard.
 Note: This is a non-standard API.
 
 **Returns**: `Promise`  
@@ -114,7  114,7 @@ navigator.clipboard.readText();
 <a name="clipboard-clearcontent" id="clipboard-clearcontent"></a>
 
 ## clearContent()
-Clear clipboard content. 
 Clear clipboard content.
 Note: Nonstandard: This method is non-standard.
 
 **Returns**: `Promise`  

diff --git a/src/pages/uxp/reference-js/Global Members/HTML DOM/Element.md b/src/pages/uxp/reference-js/Global Members/HTML DOM/Element.md
@@ -173,17  173,23 @@ Indicates if the element will focus automatically when it is loaded
 <a name="element-innerhtml" id="element-innerhtml"></a>
 
 ## innerHTML : `string`
-
 **Read only**
 
 <a name="element-innerhtml" id="element-innerhtml"></a>
 
-## innerHTML
 ## innerHTML(value)
 **See**
 
 - https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML
 - https://w3c.github.io/DOM-Parsing/#the-innerhtml-mixin
 
 
 | Param | Type |
 | --- | --- |
 | value | `string` | 
 
 
 
 <a name="element-outerhtml" id="element-outerhtml"></a>
 
 ## outerHTML : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLAnchorElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLAnchorElement.md
@@ -41,6  41,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLBodyElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLBodyElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLButtonElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLButtonElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLDialogElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLDialogElement.md
@@ -51,6  51,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLHeadElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLHeadElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLHtmlElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLHtmlElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLImageElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLImageElement.md
@@ -25,6  25,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLInputElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLInputElement.md
@@ -127,6  127,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLLabelElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLLabelElement.md
@@ -24,6  24,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLLinkElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLLinkElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLMenuElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLMenuElement.md
@@ -18,6  18,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLMenuItemElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLMenuItemElement.md
@@ -25,6  25,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLOptionElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLOptionElement.md
@@ -23,6  23,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLProgressElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLProgressElement.md
@@ -40,6  40,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLScriptElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLScriptElement.md
@@ -38,6  38,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`

diff --git a/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLSelectElement.md b/src/pages/uxp/reference-js/Global Members/HTML Elements/HTMLSelectElement.md
@@ -53,6  53,11 @@ Access to all the custom data attributes (data-*) set.
 ## innerText : `string`
 
 
 <a name="htmlelement-lang" id="htmlelement-lang"></a>
 
 ## lang : `string`
 
 
 <a name="element-nodename" id="element-nodename"></a>
 
 ## nodeName : `string`
Original file line number	Diff line number	Diff line change
		@@ -0,0 1,4 @@

		import Content from "uxp-documentation/src/pages/uxp/reference-js/Global Members/Path/Path.md";

		<Content query="product=photoshop"/>
Original file line number	Diff line number	Diff line change
		@@ -0,0 1,4 @@

		import Content from "uxp-documentation/src/pages/uxp/reference-js/Global Members/Path/Path.md";

		<Content query="product=xd"/>