Skip to content

Commit bb1a871

Browse files
committed
Quick fixes to docs
1 parent 321d662 commit bb1a871

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

changes.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
XD 21 adds major updates: the ability to **show panel UI**, and the much-improved **UXP 3 CSS & layout engine**.
66

7-
_The new layout engine likely constitutes a **breaking change** for any plugin with UI_ -- read below for details.
7+
> **Danger**
8+
>
9+
> _The new layout engine likely constitutes a **breaking change** for any plugin with UI_ -- read below for details.
10+
11+
Also note that this release has an issue where transactions being wrapped by `editDocument` is _not_ enforced. This will be fixed in an upcoming patch version, so you will want to continue wrapping scenegraph changes from panels in `editDocument` so that your plugin isn't broken when we release the fix.
812

913
### Plugin Panel UI
1014

@@ -33,6 +37,8 @@ In order to gain access to most of these features, your plugin must _opt-in_ to
3337
* **`overflow` defaults to `visible`** (no longer `hidden`), per the web specification -- _This may break existing plugin UI code._
3438
* `object-fit` -- to control the size of images
3539
* `z-index`
40+
* Improvements to `position`, including correct `absolute` semantics.
41+
* **WARNING**: Technically `position: fixed` is supported. However, _you should not use it_ in your plugin panels because there are some bugs that will be fixed in a future update that will break if your plugin uses `position: fixed`.
3642
* **SVG UI elements**
3743
* **New UI controls**
3844
* Radio buttons -- `<input type="radio" />`

known-issues.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
- `<label for="id"/>` is not supported. Wrap `<label>` around the control instead.
5050
- `<input type="file" />` is not supported.
5151
- `<input type="color" />` is not supported.
52+
- Using unitless values in `width` and `height` attributes are not supported in UXP 3.1. Use `px`, or CSS styles.
53+
- `<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_.
5254

5355
### Layout
5456

@@ -75,6 +77,7 @@
7577
- The bottom border may not always render with the same width as the other borders.
7678
- Underlines may render very thin.
7779
- `calc` only works for length properties. Using `calc` for a color will not work.
80+
- If you need to override an anchor link color, use `a[href]` as the selector to override it.
7881

7982
### DOM
8083

migrations/uxp-2-to-3.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,10 @@ The default stylesheet in UXP 3 is different from that provided by UXP 2 and bac
227227
_Most_ of the differences in the default stylesheet are due to the presence of the panel insertion point for your plugins. Modal dialogs styling is generally the same. However, there are a few differences that might cause changes in your layout:
228228

229229
* `<label>` is now rendered using `display: inline-flex` by default. This means form elements without a `row` or `column` class will render with the label to the left of the element instead of the label above the element.
230+
* `<label>` will also _wrap_ if the width of the parent is too narrow. If you want to restrict this wrapping, you can apply `flex-wrap: nowrap` to the element. In the future, `<label>` will more closely match the web standard.
231+
* `<label>` no longer needs the `row` class to lay out horizontally.
230232
* Styles are applied with _less_ specificity. This means it is easier to override the styling of an `<h2>`, for example.
233+
* One place this may cause issues is that anchor colors are applied to anchors only with `href` attributes. If you need to override this color, use `a[href]` as the selector.
231234

232235
## Quick Feature Summary
233236

0 commit comments

Comments
 (0)