Attribute standardization #1685
Merged
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
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
natelaws
reviewed
Sep 13, 2023
| isAutogenerated?: boolean; | ||
| linkStyle?: "button"; |
There was a problem hiding this comment.
This was a legacy property that was replaced by a button annotation.
| @@ -379,102 +379,4 @@ describe("ReactRenderer", () => { | |||
| ); | |||
| }); | |||
| }); | |||
|
|
|||
| describe("Subdocuments", () => { | |||
There was a problem hiding this comment.
We don't need another test for the caption related changes? Looks like the other tests have caption related things?
There was a problem hiding this comment.
Subdocuments are deprecated in favor of slices and we haven't used them for many months at this point.
muthuprakashvelumani
approved these changes
Sep 19, 2023
bachbui
approved these changes
Sep 26, 2023
tim-evans
added
the
🚨 Breaking Change
|
Please let me merge this, as it will cause cascading changes upstream. |
dkorenblyum
approved these changes
Sep 29, 2023
tim-evans
force-pushed
the
attribute-standardization
branch
2 times, most recently
from
8b01760 to
448caed
Compare
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
tim-evans
force-pushed
the
attribute-standardization
branch
from
bb88415 to
fde3165
Compare
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
tim-evans
force-pushed
the
attribute-standardization
branch
from
fde3165 to
ee65f5d
Compare
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
tim-evans
force-pushed
the
attribute-standardization
branch
from
27790b8 to
8c1f2e4
Compare
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
|
@copilot-robot prerelease |
|
Hi, @tim-evans, a pre-release has been published:
|
tim-evans
force-pushed
the
attribute-standardization
branch
from
c867274 to
be28e1b
Compare
…to the layout attribute alignment was unclear as to what it was referring to and textAlignment works better in different contexts. layout is a new property that is in place of size and inset to be more extensible for designers, and to be more explicit that mixing size with block alignment (the inset property) doesn't actually work. this allows us to create a more consistent property that is available on more blocks without having this limited approach where size is on one thing, inset is on another, and some have both. having a single attribute for describing this will allow downstream consumers to handle this more easily.
this was never implemented
tim-evans
force-pushed
the
attribute-standardization
branch
from
be28e1b to
91fbe8c
Compare
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.
The current attributes for our standard annotations have some messiness about them. This is an effort to clean up attributes and to provide a more standardized API that is consistent across more annotations. These decisions are made in conjunction with thinking about how our content is presented by our designers for sites like vogue.com, where some features that editors and writers use are not representable currently in our annotations.
We would like to provide more support and therefore, I'm introducing two major changes:
sizeandinsetbecomelayout.These fields did not mix and match and allowing both properties made it confusing for developers as to which field took precedence. This also allows designers to add new types of layouts without having to change the data model.
alignmentbecomestextAlignmentThis is pretty self-explanatory, and is about clarity.
Note that
layoutas a property is added to many more blocks thansizeandinsetwere on previously. This is intentional, since there are instances where editorial teams have used these features on these blocks. We may not provide them controls to change these properties, but we would like to fully support these and respect their decisions when it comes time to represent the data for our sites to use for rendering.