generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 29
Use TextLayout instead of TextType #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
56 changes: 56 additions & 0 deletions
56
src/pages/references/document-sandbox/document-apis/enumerations/TextLayout.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
41 changes: 0 additions & 41 deletions
41
src/pages/references/document-sandbox/document-apis/enumerations/TextType.md
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: this particular change seems ok but we should be careful about updating descriptions of older API changes to reflect the latest state of the API. That may be confusing since this description is now mixing old and new and may not accurately describe any state the API has ever existed in.
In some cases it might even be impossible to keep the links in older changelog entries up to date, e.g. if an API has changed a lot or was removed. We should probably decide a policy for how much to update these entries and what to do if it's impossible to keep links working (would we rather leave the older link and let is 404, or strip the link out of the text, or add a new parenthetical note that links to the newer equivalent API, etc.).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You've hit a nerve, @peterflynn! I always struggle with links in the changelog. @nimithajalal suggested archiving the oldest entries, which I'm all in for.
IIRC, the linter is part of the build script, and it'd prevent the merge if it found something wrong there—so we're in this weird situation where we need to fix links even if they've stopped making sense.