Merge pull request #120 from AdobeDocs/unzela/rename_enum

Use TextLayout instead of TextType

Author: undavide

gatsby-config.js

@@ -455,8 +455,8 @@ module.exports = {
                     path: "references/document-sandbox/document-apis/enumerations/TextAlignment.md",
                   },
                   {
-                    title: "TextType",
-                    path: "references/document-sandbox/document-apis/enumerations/TextType.md",
+                    title: "TextLayout",
+                    path: "references/document-sandbox/document-apis/enumerations/TextLayout.md",
                   },
                   {
                     title: "VisualEffectType",

src/pages/references/changelog.md

@@ -26,11 +26,11 @@ contributors:
 
 ### Updated
 
-There are a few notable changes regarding the [Color Picker APIs](../references/addonsdk/addonsdk-app.md#showcolorpicker), which have now moved to stable:
-
-- The `initialColor` parameter now accepts a string in `"#RRGGBB[AA]"` format, in addition to the previous HEX number `0xRRGGBB[AA]`—both with optional alpha channel.
-- We fixed the return value of the `ColorPickerEvent.colorChange` event, which now correctly handles the color with or without the alpha channel, depending on the value of the `disableAlphaChannel` parameter.
-- **Breaking change**: the `ColorPickerEvents` enum has been renamed to `ColorPickerEvent` (singular).
+- There are a few notable changes regarding the [Color Picker APIs](../references/addonsdk/addonsdk-app.md#showcolorpicker), which have now moved to stable:
+  - The `initialColor` parameter now accepts a string in `"#RRGGBB[AA]"` format, in addition to the previous HEX number `0xRRGGBB[AA]`—both with optional alpha channel.
+  - We fixed the return value of the `ColorPickerEvent.colorChange` event, which now correctly handles the color with or without the alpha channel, depending on the value of the `disableAlphaChannel` parameter.
+  - **Breaking change**: the `ColorPickerEvents` enum has been renamed to `ColorPickerEvent` (singular).
+- Renamed the TextType enumerable to [`TextLayout`](./document-sandbox/document-apis/enumerations/TextLayout.md) in the Text APIs.
 
 ## 2025-04-22
 
@@ -234,7 +234,7 @@ You must provide trader details by February 16, 2025, to keep your add-on visibl
 - Added many new **Text APIs** for improved text management.
   - [`TextNode.fullContent`](./document-sandbox/document-apis/classes/TextNode.md#fullcontent) accessor: returns the [`TextContentModel`](./document-sandbox/document-apis/classes/TextContentModel.md) containing the complete text string and its styles associated to the Text Flow (Threaded Text or Overflow Text).
   - [`TextNode.nextTextNode`](./document-sandbox/document-apis/classes/TextNode.md#nexttextnode) accessor: gets the next node that overflowing text will spill into.
-  - [`TextNode.layout`](./document-sandbox/document-apis/classes/TextNode.md#layout) accessor: gets and sets the [`TextType`](./document-sandbox/document-apis/enumerations/TextType.md) of the text node frame.
+  - [`TextNode.layout`](./document-sandbox/document-apis/classes/TextNode.md#layout) accessor: gets and sets the [`TextLayout`](./document-sandbox/document-apis/enumerations/TextLayout.md) of the text node frame.
   - [`TextNode.visualEffects`](./document-sandbox/document-apis/classes/TextNode.md#visualeffects) accessor: list of [`VisualEffectType`](./document-sandbox/document-apis/enumerations/VisualEffectType.md) applied to the text node.
   - [`TextContentModel.characterStyleRanges`](./document-sandbox/document-apis/classes/TextContentModel.md#characterstyleranges) accessor: list of [character style](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#color), [`font`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#font), [`fontSize`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#fontsize), [`letterSpacing`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#letterSpacing) and [`underline`](./document-sandbox/document-apis/interfaces/CharacterStyles.md) ranges in the text content, controlling the [`color`](./document-sandbox/document-apis/interfaces/CharacterStyles.md#underline) properties.
   - [AvailableFont](./document-sandbox/document-apis/classes/AvailableFont.md) and [UnavailableFont](./document-sandbox/document-apis/classes/UnavailableFont.md) classes.

src/pages/references/document-sandbox/document-apis/classes/TextNode.md

@@ -164,7 +164,7 @@ layout modes, except for [AreaTextLayout](../interfaces/AreaTextLayout.md), are
 
 #### Throws
 
-if changing text layout to/from [TextType.magicFit](../enumerations/TextType.md#magicfit) or [TextType.circular](../enumerations/TextType.md#circular) layout when the text contains font(s) unavailable to the current user.
+if changing text layout to/from [TextLayout.magicFit](../enumerations/TextLayout.md#magicfit) or [TextLayout.circular](../enumerations/TextLayout.md#circular) layout when the text contains font(s) unavailable to the current user.
 
 #### Throws
 

src/pages/references/document-sandbox/document-apis/enumerations/ArrowHeadType.md

@@ -6,6 +6,11 @@
 
 _Do not depend on the literal numeric values of these constants_, as they may change. Always reference the enum identifiers in your code.
 
+<InlineAlert slots="text" variant="warning"/>
+
+_Additional arrowhead types may be added in the future._ If your code has different branches or cases depending on arrow type,
+always have a default/fallback case to handle any unknown values you may encounter.
+
 ## Enumeration Members
 
 ### circleFilled

src/pages/references/document-sandbox/document-apis/enumerations/TextAlignment.md

@@ -6,6 +6,11 @@
 
 _Do not depend on the literal numeric values of these constants_, as they may change. Always reference the enum identifiers in your code.
 
+<InlineAlert slots="text" variant="warning"/>
+
+_Additional alignment types may be added in the future._ If your code has different branches or cases depending on text alignment,
+always have a default/fallback case to handle any unknown values you may encounter.
+
 ## Enumeration Members
 
 ### center
@@ -14,6 +19,12 @@ _Do not depend on the literal numeric values of these constants_, as they may ch
 
 ---
 
+### justifyLeft
+
+• **justifyLeft**: `4`
+
+---
+
 ### left
 
 • **left**: `1`

src/pages/references/document-sandbox/document-apis/enumerations/TextLayout.md

@@ -0,0 +1,56 @@
+[@express-document-sdk](../overview.md) / TextLayout
+
+# Enumeration: TextLayout
+
+<InlineAlert slots="text" variant="warning"/>
+
+_Do not depend on the literal numeric values of these constants_, as they may change. Always reference the enum identifiers in your code.
+
+<InlineAlert slots="text" variant="warning"/>
+
+_Additional text layout types may be added in the future._ If your code has different branches or cases depending on layout type,
+always have a default/fallback case to handle any unknown values you may encounter.
+
+## Enumeration Members
+
+### area
+
+• **area**: `1`
+
+Area text: both width and height are explicitly set. If text content is too long to fit, the end of the text will be
+clipped. If text content is short, the frame's bounds will occupy extra height that is just blank space.
+
+---
+
+### autoHeight
+
+• **autoHeight**: `2`
+
+Auto-height text: Width is explicitly set, and text wraps to use as much vertical space as necessary to display the
+full content.
+
+---
+
+### autoWidth
+
+• **autoWidth**: `3`
+
+Auto-width, aka point text: both width and height are automatically determined based on the content. There is no
+automatic line wrapping, so the text will all be on one line unless the text contains explicit newlines.
+
+---
+
+### circular
+
+• **circular**: `4`
+
+Text is arranged in a circle or arc. The API does not yet support setting or reading the details of this layout style.
+
+---
+
+### magicFit
+
+• **magicFit**: `5`
+
+Aka "Dynamic" layout in the UI: text size and styles are automatically varied to create an attractive multi-line layout.
+The API does not yet support setting or reading the details of this layout style.

src/pages/references/document-sandbox/document-apis/enumerations/TextType.md

@@ -18,7 +18,7 @@ The height of the text node in pixels.
 
 ### type
 
-• **type**: [`area`](../enumerations/TextType.md#area)
+• **type**: [`area`](../enumerations/TextLayout.md#area)
 
 ---
 

src/pages/references/document-sandbox/document-apis/interfaces/AreaTextLayout.md

@@ -10,7 +10,7 @@
 
 ### type
 
-• **type**: [`autoHeight`](../enumerations/TextType.md#autoheight)
+• **type**: [`autoHeight`](../enumerations/TextLayout.md#autoheight)
 
 ---
 

src/pages/references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md

@@ -10,4 +10,4 @@
 
 ### type
 
-• **type**: [`autoWidth`](../enumerations/TextType.md#autowidth)
+• **type**: [`autoWidth`](../enumerations/TextLayout.md#autowidth)

src/pages/references/document-sandbox/document-apis/interfaces/PointTextLayout.md

@@ -10,4 +10,4 @@
 
 ### type
 
-• **type**: [`magicFit`](../enumerations/TextType.md#magicfit) \| [`circular`](../enumerations/TextType.md#circular)
+• **type**: [`circular`](../enumerations/TextLayout.md#circular) \| [`magicFit`](../enumerations/TextLayout.md#magicfit)

src/pages/references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md

@@ -69,9 +69,9 @@ Re-exports [TextAlignment](../../enumerations/TextAlignment.md)
 
 ---
 
-### TextType
+### TextLayout
 
-Re-exports [TextType](../../enumerations/TextType.md)
+Re-exports [TextLayout](../../enumerations/TextLayout.md)
 
 ---
 

src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md

@@ -19,7 +19,7 @@
 -   [StrokePosition](enumerations/StrokePosition.md)
 -   [StrokeType](enumerations/StrokeType.md)
 -   [TextAlignment](enumerations/TextAlignment.md)
--   [TextType](enumerations/TextType.md)
+-   [TextLayout](enumerations/TextLayout.md)
 -   [VisualEffectType](enumerations/VisualEffectType.md)
 
 ## Classes