{"id":341051,"date":"2022-06-26T07:55:15","date_gmt":"2022-06-26T07:55:15","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=341051"},"modified":"2024-06-18T12:13:23","modified_gmt":"2024-06-18T12:13:23","slug":"add-custom-validation-rule-in-ui-component-form-field","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/","title":{"rendered":"Add custom validation rule in UI component form field"},"content":{"rendered":"\n

Hello Dear Friends!!!

In this article, we are going to learn how we can add custom validation in a field in UI component form.
<\/p>\n\n\n\n

First of all, we will create our custom validation js file. Here, I have created wk-storeurl-validation.js<\/em> file inside the <magento-root-dir>\/app\/code\/Vendor\/Module\/view\/adminhtml\/web\/js\/<\/em> directory.<\/p>\n\n\n\n

require(\n    [\n        'Magento_Ui\/js\/lib\/validation\/validator',\n        'jquery',\n        'mage\/translate'\n], function(validator, $){\n        validator.addRule(\n            'wk-storeurl-validation',\n            function (value) {\n                return !(\/[^a-z^A-Z^0-9\\.\\-]\/g.test(value));\n            },\n            $.mage.__('Store Url can contain dash (-) and alphanumric values only.')\n        );\n});<\/pre>\n\n\n\n
Now, we will add this file to the head section of the layout file. Here, I have added my js file in routename_customform_edit.xml <\/em>file inside the <magento-root-dir>\/app\/code\/Vendor\/Module\/view\/adminhtml\/layout\/ <\/em>directory.<\/p>\n\n\n\n
<?xml version="1.0"?>\n\n<page xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" layout="admin-2columns-left"  xsi:noNamespaceSchemaLocation="urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd">\n    <update handle="styles"\/>\n    <head>\n        <link src="Vendor_Module::js\/wk-storeurl-validation.js"\/>\n    <\/head>\n    <body>\n        <referenceContainer name="content">\n            <uiComponent name="tenants_form"\/>\n        <\/referenceContainer>\n    <\/body>\n<\/page><\/pre>\n\n\n\n
Now, we will add our custom validation rule in the form field in the UI component form. Here, I have added my custom validation rule named “wk-storeurl-validation<\/strong>” in the store_url<\/em> field in the tenants_form.xml <\/em>file as follows:<\/p>\n\n\n\n
<field name="store_url">\n            <argument name="data" xsi:type="array">\n                <item name="config" xsi:type="array">\n                    <item name="dataType" xsi:type="string">text<\/item>\n                    <item name="label" xsi:type="string" translate="true">Store URL<\/item>\n                    <item name="formElement" xsi:type="string">input<\/item>\n                    <item name="dataScope" xsi:type="string">store_url<\/item>\n                    <item name="required" xsi:type="boolean">true<\/item>\n                    <item name="notice" xsi:type="string" translate="true">\n                       Enter store URL name. For example: xyzshop\n                    <\/item>\n                    <item name="validation" xsi:type="array">\n                        <item name="required-entry" xsi:type="boolean">true<\/item>\n                        <strong><item name="wk-storeurl-validation" xsi:type="boolean">true<\/item><\/strong>\n                        <item name="validate-no-html-tags" xsi:type="boolean">true<\/item>\n                    <\/item>\n                <\/item>\n            <\/argument>\n        <\/field><\/pre>\n\n\n\n
Now, when we input the wrong value in the form field store_url<\/em> and save the form, then we will get an error as in the following image:<\/p>\n\n\n\n
\"download-5\"<\/figure>\n\n\n\n
Hope this will be helpful.
Thanks \ud83d\ude42
<\/p>\n","protected":false},"excerpt":{"rendered":"
Hello Dear Friends!!! In this article, we are going to learn how we can add custom validation in a field in UI component form. First of all, we will create our custom validation js file. Here, I have created wk-storeurl-validation.js file inside the <magento-root-dir>\/app\/code\/Vendor\/Module\/view\/adminhtml\/web\/js\/ directory. Now, we will add this file to the head section […]<\/a><\/p>\n","protected":false},"author":249,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[9121],"tags":[12861,12863,12862,12864],"class_list":["post-341051","post","type-post","status-publish","format-standard","hentry","category-magento-2","tag-add-custom-validation-in-ui-component-form-field","tag-custom-validation-in-form-field-in-ui-component-form","tag-custom-validation-in-ui-component-form","tag-ui-component-form-validation"],"yoast_head":"\nAdd custom validation rule in UI component form field - Webkul Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Add custom validation rule in UI component form field - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Hello Dear Friends!!! In this article, we are going to learn how we can add custom validation in a field in UI component form. First of all, we will create our custom validation js file. Here, I have created wk-storeurl-validation.js file inside the <magento-root-dir>\/app\/code\/Vendor\/Module\/view\/adminhtml\/web\/js\/ directory. Now, we will add this file to the head section [...]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2022-06-26T07:55:15+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-18T12:13:23+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png\" \/>\n<meta name=\"author\" content=\"Khushboo Sahu\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Khushboo Sahu\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\"},\"author\":{\"name\":\"Khushboo Sahu\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca\"},\"headline\":\"Add custom validation rule in UI component form field\",\"datePublished\":\"2022-06-26T07:55:15+00:00\",\"dateModified\":\"2024-06-18T12:13:23+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\"},\"wordCount\":179,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png\",\"keywords\":[\"add custom validation in ui component form field\",\"custom validation in form field in ui component form\",\"custom validation in ui component form\",\"ui component form validation\"],\"articleSection\":[\"Magento 2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\",\"url\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\",\"name\":\"Add custom validation rule in UI component form field - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png\",\"datePublished\":\"2022-06-26T07:55:15+00:00\",\"dateModified\":\"2024-06-18T12:13:23+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5.png\",\"width\":1203,\"height\":615,\"caption\":\"download-5\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add custom validation rule in UI component form field\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca\",\"name\":\"Khushboo Sahu\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"caption\":\"Khushboo Sahu\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Add custom validation rule in UI component form field - Webkul Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/","og_locale":"en_US","og_type":"article","og_title":"Add custom validation rule in UI component form field - Webkul Blog","og_description":"Hello Dear Friends!!! In this article, we are going to learn how we can add custom validation in a field in UI component form. First of all, we will create our custom validation js file. Here, I have created wk-storeurl-validation.js file inside the <magento-root-dir>\/app\/code\/Vendor\/Module\/view\/adminhtml\/web\/js\/ directory. Now, we will add this file to the head section [...]","og_url":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2022-06-26T07:55:15+00:00","article_modified_time":"2024-06-18T12:13:23+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png","type":"","width":"","height":""}],"author":"Khushboo Sahu","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Khushboo Sahu","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/"},"author":{"name":"Khushboo Sahu","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca"},"headline":"Add custom validation rule in UI component form field","datePublished":"2022-06-26T07:55:15+00:00","dateModified":"2024-06-18T12:13:23+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/"},"wordCount":179,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png","keywords":["add custom validation in ui component form field","custom validation in form field in ui component form","custom validation in ui component form","ui component form validation"],"articleSection":["Magento 2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/","url":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/","name":"Add custom validation rule in UI component form field - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5-1200x613.png","datePublished":"2022-06-26T07:55:15+00:00","dateModified":"2024-06-18T12:13:23+00:00","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2022\/06\/download-5.png","width":1203,"height":615,"caption":"download-5"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/add-custom-validation-rule-in-ui-component-form-field\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Add custom validation rule in UI component form field"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca","name":"Khushboo Sahu","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","caption":"Khushboo Sahu"},"url":"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/341051","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/249"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=341051"}],"version-history":[{"count":2,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/341051\/revisions"}],"predecessor-version":[{"id":448548,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/341051\/revisions\/448548"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=341051"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=341051"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=341051"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}