darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-07-16 03:10:16 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
4d0da6594de60fcf37dc7796279462e32072d7a1
notifications-admin/app/main/views/styleguide.py

41 lines
1.1 KiB
Python
Raw Normal View History

Enforce order and style of imports Done using isort[1], with the following command: ``` isort -rc ./app ./tests ``` Adds linting to the `run_tests.sh` script to stop badly-sorted imports getting re-introduced. Chosen style is ‘Vertical Hanging Indent’ with trailing commas, because I think it gives the cleanest diffs, eg: ``` from third_party import ( lib1, lib2, lib3, lib4, ) ``` 1. https://pypi.python.org/pypi/isort
2018-02-20 11:22:17 +00:00
from flask import abort, current_app, render_template
Address deprecation warning around wtf Form It’s been renamed to avoid a conflict. Not a conflict we have to worry about. So we can just change our import and get rid of the deprecation warning.
2017-07-26 10:59:10 +01:00
from flask_wtf import FlaskForm as Form
Bump utils to bring in recent changes to Template classes The main things we have to account for are: - `WithSubjectTemplate` has gone - every template dictionary must have `template_type` set
2020-04-15 17:58:57 +01:00
from notifications_utils.template import SMSPreviewTemplate
Enforce order and style of imports Done using isort[1], with the following command: ``` isort -rc ./app ./tests ``` Adds linting to the `run_tests.sh` script to stop badly-sorted imports getting re-introduced. Chosen style is ‘Vertical Hanging Indent’ with trailing commas, because I think it gives the cleanest diffs, eg: ``` from third_party import ( lib1, lib2, lib3, lib4, ) ``` 1. https://pypi.python.org/pypi/isort
2018-02-20 11:22:17 +00:00
from wtforms import (
FileField,
PasswordField,
StringField,
TextAreaField,
validators,
)
Add a styleguide page There are now quite a few frontend components in the app. It’s good to have a reference for them to: - document for developers what patterns are available and how they are used - check for regressions - when working on one variation of a pattern you can check that your changes don’t break other variations of it - when changing the arguments to a pattern you can check that this doesn’t change the expected arguments already in use This commit adds a single page (`/_styleguide`) which has examples of all the patterns.
2016-01-11 11:13:06 +00:00
from app.main import main
@main.route('/_styleguide')
def styleguide():
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
Don’t show styleguide on live environment Its audience is people working on the product, not the end users.
2016-02-15 11:47:54 +00:00
if not current_app.config['SHOW_STYLEGUIDE']:
abort(404)
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
class FormExamples(Form):
username = StringField(u'Username')
password = PasswordField(u'Password', [validators.required()])
General updates to styleguide More complete examples of: - tables - SMS messages
2016-02-15 11:32:27 +00:00
code = StringField('Enter code')
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
message = TextAreaField(u'Message')
Add custom file upload component The default browser file upload control is difficult to style, but looks totally out of place. This commit replaces it with one that has a GOV.UK style button, as a first step. Based heavily on this example: http://tympanus.net/codrops/2015/09/15/styling-customizing-file-inputs-smart-way/
2016-02-02 17:28:30 +00:00
file_upload = FileField('Upload a CSV file to add your recipients’ details')
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
Updates to styleguide Brings in changes to the email message and table patterns.
2016-02-21 11:15:15 +00:00
sms = "Your vehicle tax for ((registration number)) is due on ((date)). Renew online at www.gov.uk/vehicle-tax"
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
Updates to styleguide Brings in changes to the email message and table patterns.
2016-02-21 11:15:15 +00:00
form = FormExamples()
form.message.data = sms
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
form.validate()
Bump utils to bring in recent changes to Template classes The main things we have to account for are: - `WithSubjectTemplate` has gone - every template dictionary must have `template_type` set
2020-04-15 17:58:57 +01:00
template = SMSPreviewTemplate({'content': sms, 'template_type': 'sms'})
Updates to styleguide Brings in changes to the email message and table patterns.
2016-02-21 11:15:15 +00:00
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
return render_template(
'views/styleguide.html',
Updates to styleguide Brings in changes to the email message and table patterns.
2016-02-21 11:15:15 +00:00
form=form,
template=template
Add a WTForms-compatible textbox macro This macro: - accepts a WTForm form field as a parameter - renders a form field which follows the GOV.UK Elements patterns, both visually and in markup terms It then changes any page which uses either: - the old, non-WTForms macro or - the old, WTFforms `render_field` macro …to use this new macro and removes both of the old ones. It also adds the option to display hint text above the textbox.
2016-01-11 13:15:10 +00:00
)
Reference in New Issue Copy Permalink