-
Notifications
You must be signed in to change notification settings - Fork 798
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
Contact Form: add accessible name to form #34667
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b296704
Contact Form: add accessible name to form
monsieur-z 0f0eee7
Update accessible name on content change
monsieur-z e40d1fb
Remove unused code
monsieur-z 5435136
Fix package version
monsieur-z de4424c
Add warning notice
monsieur-z 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
4 changes: 4 additions & 0 deletions
4
projects/packages/forms/changelog/add-contact-form-accessible-name
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Significance: minor | ||
Type: added | ||
|
||
Contact Form: add accessible name to form |
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
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
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
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
53 changes: 53 additions & 0 deletions
53
projects/packages/forms/src/blocks/contact-form/hooks/use-form-accessible-name.js
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import { useSelect } from '@wordpress/data'; | ||
import { useEffect } from '@wordpress/element'; | ||
|
||
const getNameFromBlockHeading = block => { | ||
const innerHeading = block.innerBlocks?.find( b => b.name === 'core/heading' ); | ||
|
||
return innerHeading?.attributes?.content; | ||
}; | ||
|
||
const getNameFromBlockPreviousHeadings = ( block, pageBlocks ) => { | ||
const blockIndex = pageBlocks.findIndex( b => b.clientId === block.clientId ); | ||
const previousBlocks = pageBlocks.slice( 0, blockIndex ); | ||
const closestHeading = previousBlocks.findLast( b => b.name === 'core/heading' ); | ||
|
||
return closestHeading?.attributes?.content; | ||
}; | ||
|
||
/** | ||
* Update the form accessible stored in the `formTitle` attribute as the block or page | ||
* content changes. The heuristic is as follows: | ||
* 1. Look for a heading inside the form | ||
* 2. Look for a heading in the previous siblings | ||
* 3. Use the post title (in Contact_Form::parse, server side) | ||
* | ||
* @param {string} formTitle - The form title | ||
* @param {string} clientId - The block unique identifier | ||
* @param {Function} setAttributes - Function to call to update one or more attributes | ||
*/ | ||
export default function useFormAccessibleName( formTitle, clientId, setAttributes ) { | ||
const { pageBlocks } = useSelect( select => ( { | ||
pageBlocks: select( 'core/block-editor' ).getBlocks(), | ||
} ) ); | ||
|
||
useEffect( () => { | ||
const currentBlock = pageBlocks.find( block => block.clientId === clientId ); | ||
|
||
let name = ''; | ||
|
||
if ( currentBlock ) { | ||
// #1 | ||
name = getNameFromBlockHeading( currentBlock ); | ||
|
||
if ( ! name ) { | ||
// #2 | ||
name = getNameFromBlockPreviousHeadings( currentBlock, pageBlocks ); | ||
} | ||
} | ||
|
||
if ( formTitle !== name ) { | ||
setAttributes( { formTitle: name } ); | ||
} | ||
}, [ clientId, formTitle, setAttributes, pageBlocks ] ); | ||
} |
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
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
5 changes: 5 additions & 0 deletions
5
projects/plugins/jetpack/changelog/add-contact-form-accessible-name
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Significance: patch | ||
Type: other | ||
Comment: Updated composer.lock. | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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.
Remove this altogether. A title should be defined in the markup and be visible to all users.
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.
Yes, we should be good by removing it. Not sure how long ago that temporarily was there :)