Implement validation slug

gigitux · gigitux · commit d021369637c7 · 2024-11-01T15:20:07.000+01:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/dataviews/src/normalize-fields.ts b/packages/dataviews/src/normalize-fields.ts
@@ -38,11 +38,8 @@ export function normalizeFields< Item >(
 
 		const isValid =
 			field.isValid ??
-			function isValid( item, context ) {
-				return fieldTypeDefinition.isValid(
-					getValue( { item } ),
-					context
-				);
+			function isValid( value, item, context ) {
+				return fieldTypeDefinition.isValid( value, context );
 			};
 
 		const Edit = getControl( field, fieldTypeDefinition );
diff --git a/packages/dataviews/src/types.ts b/packages/dataviews/src/types.ts
@@ -121,7 +121,11 @@ export type Field< Item > = {
 	/**
 	 * Callback used to validate the field.
 	 */
-	isValid?: ( item: Item, context?: ValidationContext ) => boolean;
+	isValid?: (
+		value: any,
+		item?: Item,
+		context?: ValidationContext
+	) => boolean;
 
 	/**
 	 * Callback used to decide if a field should be displayed.
@@ -167,7 +171,7 @@ export type NormalizedField< Item > = Field< Item > & {
 	render: ComponentType< DataViewRenderFieldProps< Item > >;
 	Edit: ComponentType< DataFormControlProps< Item > >;
 	sort: ( a: Item, b: Item, direction: SortDirection ) => number;
-	isValid: ( item: Item, context?: ValidationContext ) => boolean;
+	isValid: ( value: any, item: Item, context?: ValidationContext ) => boolean;
 	enableHiding: boolean;
 	enableSorting: boolean;
 };
diff --git a/packages/dataviews/src/validation.ts b/packages/dataviews/src/validation.ts
@@ -13,6 +13,7 @@ export function isItemValid< Item >(
 		fields.filter( ( { id } ) => !! form.fields?.includes( id ) )
 	);
 	return _fields.every( ( field ) => {
-		return field.isValid( item, { elements: field.elements } );
+		const value = field.getValue( { item } );
+		return field.isValid( value, item, { elements: field.elements } );
 	} );
 }
diff --git a/packages/fields/package.json b/packages/fields/package.json
@@ -55,6 +55,7 @@
 		"@wordpress/warning": "*",
 		"change-case": "4.1.2",
 		"client-zip": "^2.4.5",
+		"clsx": "^2.1.1",
 		"remove-accents": "^0.5.0"
 	},
 	"peerDependencies": {
diff --git a/packages/fields/src/fields/slug/index.ts b/packages/fields/src/fields/slug/index.ts
@@ -10,12 +10,16 @@ import type { BasePost } from '../../types';
 import { __ } from '@wordpress/i18n';
 import SlugEdit from './slug-edit';
 import SlugView from './slug-view';
+import { getSlug } from './utils';
 
 const slugField: Field< BasePost > = {
 	id: 'slug',
 	type: 'text',
 	label: __( 'Slug' ),
-	getValue: ( { item } ) => item.slug,
+	getValue: ( { item } ) => getSlug( item ),
+	isValid: ( value ) => {
+		return ( value && value.length > 0 ) || false;
+	},
 	Edit: SlugEdit,
 	render: SlugView,
 };
diff --git a/packages/fields/src/fields/slug/slug-edit.tsx b/packages/fields/src/fields/slug/slug-edit.tsx
@@ -11,17 +11,21 @@ import {
 import { copySmall } from '@wordpress/icons';
 import { useCopyToClipboard, useInstanceId } from '@wordpress/compose';
 import { useDispatch } from '@wordpress/data';
-import { useCallback, useEffect, useRef } from '@wordpress/element';
+import { useCallback, useEffect, useRef, useState } from '@wordpress/element';
 import { store as noticesStore } from '@wordpress/notices';
 import { safeDecodeURIComponent } from '@wordpress/url';
 import type { DataFormControlProps } from '@wordpress/dataviews';
 import { __ } from '@wordpress/i18n';
 
+/**
+ * External dependencies
+ */
+import clsx from 'clsx';
+
 /**
  * Internal dependencies
  */
 import type { BasePost } from '../../types';
-import { getSlug } from './utils';
 
 const SlugEdit = ( {
 	field,
@@ -30,7 +34,10 @@ const SlugEdit = ( {
 }: DataFormControlProps< BasePost > ) => {
 	const { id } = field;
 
-	const slug = field.getValue( { item: data } ) || getSlug( data );
+	const slug = field.getValue( { item: data } );
+
+	const [ isValid, setIsValid ] = useState( true );
+
 	const permalinkTemplate = data.permalink_template || '';
 	const PERMALINK_POSTNAME_REGEX = /%(?:postname|pagename)%/;
 	const [ prefix, suffix ] = permalinkTemplate.split(
@@ -40,7 +47,7 @@ const SlugEdit = ( {
 	const permalinkSuffix = suffix;
 	const isEditable = PERMALINK_POSTNAME_REGEX.test( permalinkTemplate );
 	const originalSlugRef = useRef( slug );
-	const slugToDisplay = slug || originalSlugRef.current;
+	const slugToDisplay = slug;
 	const permalink = isEditable
 		? `${ permalinkPrefix }${ slugToDisplay }${ permalinkSuffix }`
 		: safeDecodeURIComponent( data.link || '' );
@@ -52,11 +59,13 @@ const SlugEdit = ( {
 	}, [ slug ] );
 
 	const onChangeControl = useCallback(
-		( newValue?: string ) =>
+		( newValue?: string ) => {
+			setIsValid( field.isValid( newValue ?? '' ) );
 			onChange( {
 				[ id ]: newValue,
-			} ),
-		[ id, onChange ]
+			} );
+		},
+		[ field, id, onChange ]
 	);
 
 	const { createNotice } = useDispatch( noticesStore );
@@ -106,7 +115,9 @@ const SlugEdit = ( {
 						autoComplete="off"
 						spellCheck="false"
 						type="text"
-						className="fields-controls__slug-input"
+						className={ clsx( 'fields-controls__slug-input', {
+							'fields-controls__slug-input--invalid': ! isValid,
+						} ) }
 						onChange={ ( newValue?: string ) => {
 							onChangeControl( newValue );
 						} }
@@ -117,6 +128,11 @@ const SlugEdit = ( {
 						} }
 						aria-describedby={ postUrlSlugDescriptionId }
 					/>
+					{ ! isValid && (
+						<div className="fields-controls__slug-error">
+							<span>{ __( 'The slug is invalid.' ) }</span>
+						</div>
+					) }
 					<div className="fields-controls__slug-help">
 						<span className="fields-controls__slug-help-visual-label">
 							{ __( 'Permalink:' ) }
diff --git a/packages/fields/src/fields/slug/style.scss b/packages/fields/src/fields/slug/style.scss
@@ -7,6 +7,18 @@
 		padding-inline-start: 0 !important;
 	}
 
+	.fields-controls__slug-input--invalid {
+		.components-input-control__backdrop,
+		.components-input-control__backdrop:focus-within {
+			border-color: $alert-red !important;
+			box-shadow: 0 0 0 0.5px $alert-red !important;
+		}
+	}
+
+	.fields-controls__slug-error {
+		color: $alert-red;
+	}
+
 	.fields-controls__slug-help-link {
 		word-break: break-word;
 	}

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ export function isItemValid< Item >(`
`13`	`13`	`fields.filter( ( { id } ) => !! form.fields?.includes( id ) )`
`14`	`14`	`);`
`15`	`15`	`return _fields.every( ( field ) => {`
`16`		`- return field.isValid( item, { elements: field.elements } );`
	`16`	`+ const value = field.getValue( { item } );`
	`17`	`+ return field.isValid( value, item, { elements: field.elements } );`
`17`	`18`	`} );`
`18`	`19`	`}`