summaryrefslogtreecommitdiff
path: root/DESIGN.md
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-05-10 11:26:43 -0300
committerSebastian <sebasjm@gmail.com>2021-05-10 11:29:08 -0300
commita28df73419162d8b5af13b789318704f80f10d63 (patch)
tree3901183e2b867c7a2bc8490dd2053b9f117922e5 /DESIGN.md
parentba158c9c1671e07dd521a86abb58195fcb414cc6 (diff)
downloadmerchant-backoffice-a28df73419162d8b5af13b789318704f80f10d63.tar.gz
merchant-backoffice-a28df73419162d8b5af13b789318704f80f10d63.tar.bz2
merchant-backoffice-a28df73419162d8b5af13b789318704f80f10d63.zip
add tooltip to fields
Diffstat (limited to 'DESIGN.md')
-rw-r--r--DESIGN.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/DESIGN.md b/DESIGN.md
index 43596f8..620684b 100644
--- a/DESIGN.md
+++ b/DESIGN.md
@@ -98,6 +98,15 @@ Inputs should handle UI rendering and use `useField(name)` to get:
* value: the current value of the object
* onChange: function to update the current field
+Also, every input must be ready to receive this properties
+
+ * name: property of the form object being manipulated
+ * label: how the name of the property will be shown in the UI
+ * placeholder: optional, inplace text when there is no value yet
+ * readonly: default to false, will prevent change the value
+ * help: optional, example text below the input text to help the user
+ * tooltip: optional, will add a (i) with a popup to describe the field
+
# Custom Hooks