-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Dataform: Add new telephone field type and field control
#71498
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
7 commits
Select commit
Hold shift + click to select a range
427b9ac
Dataform: Add new `telephone` field type and field control
ntsekouras 90d250e
add changelog
ntsekouras c75cb4b
add input wrapper
ntsekouras c42e972
move type definition
ntsekouras e095dea
move in utils
ntsekouras d191987
remove tel regex validation
ntsekouras 9092973
update validation story
ntsekouras 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,18 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { privateApis } from '@wordpress/components'; | ||
| import { useCallback, useState } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { DataFormControlProps } from '../types'; | ||
| import { unlock } from '../lock-unlock'; | ||
|
|
||
| const { ValidatedTextControl } = unlock( privateApis ); | ||
| import ValidatedText from './utils/validated-text'; | ||
|
|
||
| export default function Email< Item >( { | ||
| data, | ||
| field, | ||
| onChange, | ||
| hideLabelFromVision, | ||
| }: DataFormControlProps< Item > ) { | ||
| const { id, label, placeholder, description } = field; | ||
| const value = field.getValue( { item: data } ); | ||
| const [ customValidity, setCustomValidity ] = | ||
| useState< | ||
| React.ComponentProps< | ||
| typeof ValidatedTextControl | ||
| >[ 'customValidity' ] | ||
| >( undefined ); | ||
|
|
||
| const onChangeControl = useCallback( | ||
| ( newValue: string ) => | ||
| onChange( { | ||
| [ id ]: newValue, | ||
| } ), | ||
| [ id, onChange ] | ||
| ); | ||
|
|
||
| return ( | ||
| <ValidatedTextControl | ||
| required={ !! field.isValid?.required } | ||
| onValidate={ ( newValue: any ) => { | ||
| const message = field.isValid?.custom?.( | ||
| { | ||
| ...data, | ||
| [ id ]: newValue, | ||
| }, | ||
| field | ||
| ); | ||
|
|
||
| if ( message ) { | ||
| setCustomValidity( { | ||
| type: 'invalid', | ||
| message, | ||
| } ); | ||
| return; | ||
| } | ||
|
|
||
| setCustomValidity( undefined ); | ||
| } } | ||
| customValidity={ customValidity } | ||
| type="email" | ||
| label={ label } | ||
| placeholder={ placeholder } | ||
| value={ value ?? '' } | ||
| help={ description } | ||
| onChange={ onChangeControl } | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| hideLabelFromVision={ hideLabelFromVision } | ||
| <ValidatedText | ||
| { ...{ data, field, onChange, hideLabelFromVision, type: 'email' } } | ||
| /> | ||
| ); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { DataFormControlProps } from '../types'; | ||
| import ValidatedText from './utils/validated-text'; | ||
|
|
||
| export default function Telephone< Item >( { | ||
| data, | ||
| field, | ||
| onChange, | ||
| hideLabelFromVision, | ||
| }: DataFormControlProps< Item > ) { | ||
| return ( | ||
| <ValidatedText | ||
| { ...{ data, field, onChange, hideLabelFromVision, type: 'tel' } } | ||
| /> | ||
| ); | ||
| } |
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 |
|---|---|---|
| @@ -1,71 +1,16 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { privateApis } from '@wordpress/components'; | ||
| import { useCallback, useState } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { DataFormControlProps } from '../types'; | ||
| import { unlock } from '../lock-unlock'; | ||
|
|
||
| const { ValidatedTextControl } = unlock( privateApis ); | ||
| import ValidatedText from './utils/validated-text'; | ||
|
|
||
| export default function Text< Item >( { | ||
| data, | ||
| field, | ||
| onChange, | ||
| hideLabelFromVision, | ||
| }: DataFormControlProps< Item > ) { | ||
| const { id, label, placeholder, description } = field; | ||
| const value = field.getValue( { item: data } ); | ||
| const [ customValidity, setCustomValidity ] = | ||
| useState< | ||
| React.ComponentProps< | ||
| typeof ValidatedTextControl | ||
| >[ 'customValidity' ] | ||
| >( undefined ); | ||
|
|
||
| const onChangeControl = useCallback( | ||
| ( newValue: string ) => | ||
| onChange( { | ||
| [ id ]: newValue, | ||
| } ), | ||
| [ id, onChange ] | ||
| ); | ||
|
|
||
| return ( | ||
| <ValidatedTextControl | ||
| required={ !! field.isValid?.required } | ||
| onValidate={ ( newValue: any ) => { | ||
| const message = field.isValid?.custom?.( | ||
| { | ||
| ...data, | ||
| [ id ]: newValue, | ||
| }, | ||
| field | ||
| ); | ||
|
|
||
| if ( message ) { | ||
| setCustomValidity( { | ||
| type: 'invalid', | ||
| message, | ||
| } ); | ||
| return; | ||
| } | ||
|
|
||
| setCustomValidity( undefined ); | ||
| } } | ||
| customValidity={ customValidity } | ||
| label={ label } | ||
| placeholder={ placeholder } | ||
| value={ value ?? '' } | ||
| help={ description } | ||
| onChange={ onChangeControl } | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| hideLabelFromVision={ hideLabelFromVision } | ||
| /> | ||
| <ValidatedText { ...{ data, field, onChange, hideLabelFromVision } } /> | ||
| ); | ||
| } | ||
79 changes: 79 additions & 0 deletions
79
packages/dataviews/src/dataform-controls/utils/validated-text.tsx
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,79 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { privateApis } from '@wordpress/components'; | ||
| import { useCallback, useState } from '@wordpress/element'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import type { DataFormControlProps } from '../../types'; | ||
| import { unlock } from '../../lock-unlock'; | ||
|
|
||
| const { ValidatedTextControl } = unlock( privateApis ); | ||
|
|
||
| export type DataFormValidatedTextControlProps< Item > = | ||
| DataFormControlProps< Item > & { | ||
| /** | ||
| * The input type of the control. | ||
| */ | ||
| type?: 'text' | 'email' | 'tel'; | ||
| }; | ||
|
|
||
| export default function ValidatedText< Item >( { | ||
| data, | ||
| field, | ||
| onChange, | ||
| hideLabelFromVision, | ||
| type, | ||
| }: DataFormValidatedTextControlProps< Item > ) { | ||
| const { id, label, placeholder, description } = field; | ||
| const value = field.getValue( { item: data } ); | ||
| const [ customValidity, setCustomValidity ] = | ||
| useState< | ||
| React.ComponentProps< | ||
| typeof ValidatedTextControl | ||
| >[ 'customValidity' ] | ||
| >( undefined ); | ||
|
|
||
| const onChangeControl = useCallback( | ||
| ( newValue: string ) => | ||
| onChange( { | ||
| [ id ]: newValue, | ||
| } ), | ||
| [ id, onChange ] | ||
| ); | ||
|
|
||
| return ( | ||
| <ValidatedTextControl | ||
| required={ !! field.isValid?.required } | ||
| onValidate={ ( newValue: any ) => { | ||
| const message = field.isValid?.custom?.( | ||
| { | ||
| ...data, | ||
| [ id ]: newValue, | ||
| }, | ||
| field | ||
| ); | ||
|
|
||
| if ( message ) { | ||
| setCustomValidity( { | ||
| type: 'invalid', | ||
| message, | ||
| } ); | ||
| return; | ||
| } | ||
|
|
||
| setCustomValidity( undefined ); | ||
| } } | ||
| customValidity={ customValidity } | ||
| label={ label } | ||
| placeholder={ placeholder } | ||
| value={ value ?? '' } | ||
| help={ description } | ||
| onChange={ onChangeControl } | ||
| hideLabelFromVision={ hideLabelFromVision } | ||
| type={ type } | ||
| /> | ||
| ); | ||
| } |
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.
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.
Uh oh!
There was an error while loading. Please reload this page.