Update form widgets docs for additional widgets (#337)

emmett-framework · Jul 23, 2021 · 151f906 · 151f906
1 parent e8a6edc
commit 151f906
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/forms.md b/docs/forms.md
@@ -156,12 +156,30 @@ Also, you understood that `Form` also accepts `Field` objects as arguments.
 
 Customizing forms
 -----------------
+
 Good applications also need good styles. This is why Emmett forms allows you to
 set a specific style with the `formstyle` attribute. But how should you edit the
 style of your form?
 
 Well, in Emmett, the style of a form is decided by the `FormStyle` class.
 
+### Additional widgets
+
+Emmett's default `FormStyle` also provides some additional widgets you can use in place of the default ones.
+
+#### Radio widget
+
+Under default circumstances, Emmett will produce a `select` tag for those fields which should be part of a pre-defined set. In case you prefer to generate inputs of type radio, you can use `FormStyle.widget_radio`:
+
+```python
+form = await Form({
+    'type': Field(
+        validation={'in': ['type1', 'type2']},
+        widget=FormStyle.widget_radio
+    )
+})
+```
+
 ### Creating your style
 *sub-section under development*
 

diff --git a/docs/orm/models.md b/docs/orm/models.md
@@ -317,6 +317,16 @@ And you can also use the `widget` parameter of `Field` class:
 started = Field.datetime(widget=my_custom_widget)
 ```
 
+#### Additional widgets
+
+In case you want to use [additional widgets](../forms#additional-widgets) in `FormStyle` class, simply pass the relevant method in `form_widgets` dictionary:
+
+```python
+form_widgets = {
+    'field': FormStyle.widget_radio
+}
+```
+
 The setup helper
 ----------------
 Sometimes you need to access your model attributes when defining other features, but, until now, we couldn't access the class or the instance itself. To avoid this problem, you can use the `setup` method of the model: