docs(form-core): forceDisplayMessage readme

AxaFrance · Oct 10, 2023 · f7b3ad7 · f7b3ad7
1 parent ac3f4e0
commit f7b3ad7
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/packages/Form/core/README.md b/packages/Form/core/README.md
@@ -26,3 +26,21 @@ const FieldForm = () => (
 );
 export default FieldForm;
 ```
+
+## forceDisplayMessage
+
+The default behavior prevents HelpMessage from displaying until the user interacts (change or focus event) with Field
+
+You can bypass this behavior to display message anyway by setting the property forceDisplayMessage to true (false by default)
+
+```javascript
+<Field id="uniqueId" label="Your Label" forceDisplayMessage />
+```
+
+Or
+
+```javascript
+<Field id="uniqueId" label="Your Label" forceDisplayMessage={true} />
+```
+
+You can add this parameter to **any input from the toolkit** since inputs pass their props to Field