Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
Added documentation on currency renderer. Added Changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
toirl committed Aug 21, 2017
1 parent 1859d00 commit 3e2267d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Improvements

New feature
- Added datetime picker widget. See https://github.com/Eonasdan/bootstrap-datetimepicker
- Added currency widget.
- Added new "fields" command to generate.py command (in contrib) to export the
entities of a given form as CSV.

Expand Down
11 changes: 10 additions & 1 deletion docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ id Used to refer to this entity in the form. Requiered. Must be uniqu
name Used as name attribute in the rendered field. Defines the name of this attribute in the model. Name of the field must only contain characters which are valid in context of your database. So better stay with [a-zA-Z0-9_]
label The field will be rendered with this label.
number A small number which is rendered in front of the label.
type Defines the python datatype which will be used on deserialisation of the submitted value. Defines the datatype of the model. Possible values are ``string`` (default), ``text``, ``integer``, ``float``, ``date``, ``datetime``, ``email``, ``boolean``, ``time``, ``interval``. css Value will be rendered as class attribute in the rendered field.
type Defines the python datatype which will be used on deserialisation of the submitted value. Defines the datatype of the model. Possible values are ``string`` (default), ``text``, ``integer``, ``float``, ``date``, ``datetime``, ``email``, ``boolean``, ``time``, ``interval``, ``currency``.
css Value will be rendered as class attribute in the rendered field.
expr Expression which is used to calculate the value of the field.
value Default value of the field. Supports expressions. The default value might get overwritten on rendering.
placeholder Custom placeholder that overrides the default of a field. For now only usable for ``interval``.
Expand Down Expand Up @@ -805,6 +806,14 @@ also take care on relations for SQLAlchemy mapped items::

<renderer type="hidden"/>

Currency
--------
The currency renderer renderer is used to render a currency field for
the entity. The icon default to Euro (€), but can be changed by using a
differend icon from the glyphicons icon set.::

<renderer type="currency" icon="glyphicons-euro"/>

Html
----
The html renderer is used to render custom html code. This is usefull if you
Expand Down

0 comments on commit 3e2267d

Please sign in to comment.