Improve documentation

[ibot3]

The documentation must be improved.

[peteristhegreat]

This is a well written module! I can put some basic docs here:

Install with

pip install wtforms-widgets

Initialize your form with wtforms_widgets.base_form.BaseForm instead of flask_wtf.FlaskForm or wtforms.Form.

Import the StringField and PasswordField from wtforms_widgets.fields.core.

from wtforms import validators

from wtforms.validators import Email
from wtforms_widgets.base_form import BaseForm
from wtforms_widgets.fields.core import StringField, PasswordField

class RegisterForm(BaseForm):
    email = StringField('Email Address', [Email(), validators.DataRequired(message='Forgot your email address?')])
    password = PasswordField('Password', [validators.DataRequired(message='Must provide a password. ;-)')])

Displaying the form in jinja is much simpler and looks great.

<form method="POST" action="{{ url_for('auth.register') }}" accept-charset="UTF-8" role="form">
    {{ form.csrf_token }}
    {{ form.name }}
     {% for error in form.name.errors %}
      <div class="invalid-feedback">{{ error }}</div>
     {% endfor %}
     {{ form.password }}
     {% for error in form.password.errors %}
      <div class="invalid-feedback">{{ error }}</div>
     {% endfor %}
     {{ form.email }}
     {% for error in form.email.error %}
      <div class="invalid-feedback">{{ error }}</div>
     {% endfor %}
     <input type="submit" value="submit">
</form>

[ibot3]

Thanks for the submission. I updated the readme file with more information. However, your example is more complicated as required, because you are not using the already implemented form rendering. You can find an example in the readme.

[peteristhegreat]

Awesome! Thank you.