[Upgrade guide entry] Upgrade entry for new Pages editing architecture for field components #1815
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
illiakovalenko
requested changes
Jun 7, 2024
docs/upgrades/unreleased.md
Outdated
| @@ -113,3 +113,5 @@ | |||
| * Introduce a new _lib/graphql-editing-service.ts_ file to initialize a _graphQLEditingService_ to support a new Editing Metadata Mode. Can be done by adding this file from the latest version introduced in _nextjs-xmcloud_ base template. | |||
|
|
|||
| * Update _lib/page-props-factory/plugins/preview-mode_ plugin to support a new Editing Metadata Mode. Can be done by replacing this file with the latest version introduced in _nextjs-xmcloud_ base template. | |||
|
|
|||
| * To support editing for fields in Pages, the new editing metadata architecture relies on the new metadata property 'field.metadata' (instead of on 'field.editable', which won't be used in this scenario). If you are using the new editing arhitecture in Pages (EditMode.Metadata) and have custom field component that manipulates or relies on 'field.editable' in some way, it may need to be reworked. | |||
There was a problem hiding this comment.
Can you provide some code sample, please? Customer will still need to support field.editable since it's required for Experience Editor support
docs/upgrades/unreleased.md
Outdated
| ... | ||
| export const Banner = (props: ImageProps): JSX.Element => { | ||
| ... | ||
| const isMetadataMode = sitecoreContext?.editMode === EditMode.Metadata; |
There was a problem hiding this comment.
let's show how to access sitecoreContext variable, and add required imports for useSitecoreContext and EditMode variables
illiakovalenko
approved these changes
Jun 12, 2024
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.
Description / Motivation
This PR adds upgrade entry for new Pages editing architecture for field components
Testing Details
Types of changes