There are variety of fieldtypes available in Frappe Framework. Each one has its own use case and can be used to input and store different types of data in a document. Fieldtypes are used to render components in desk as well as web forms.
The data field will be a simple text field. It allows you to enter a value of up to 140 characters, making this the most generic field type.
You can enable validations for the following types of data:
by setting the options to "Name", "Email", "Phone" or "URL" respectively.
Link field is connected to another master from where it fetches data. For example, in the Quotation master, the Customer is a Link field. To know more, click here.
Dynamic Link field is one which can search and hold value of any document/doctype. Click here to learn how Dynamic Link Field functions.
This will enable you to have a checkbox here. You can set the
Default value to 1 and it will be checked by default.
Select will be a drop-down field. You can add multiple results in the Option field, with each option on a new line.
A table will be a kind of Link field which renders another DocType within the current form. The DocType linked to this type of table field must be of type
Attach field allows you to browse a field from the File Manager and attach the same herein.
Attach Image is a field wherein you will be allowed to attach Images of the format jpeg, png, etc. This becomes the Image representing that particular DocType. For e.g., you would want the image of an Item in its DocType, you can choose your field to be an Attach Image Field.
Text Editor is a text field and renders a WYSIWYG editor for input. It has various text-formatting options.
This field will enable you to enter the Date in this field.
Date and Time
This field will give you a date and time picker. The current date and time (as provided by your computer) are set by default.
In this field, you can specify the field as Barcode which will allow you to enter a Barcode number. Once you do that, the Barcode would automatically get generated against the number.
This field lets you place a button in a document. This can be used to perform specific actions like publishing a blog post, triggering an action etc.
This fieldtype can be used to take
code as input. A code editor is rendered in the document form. Optionally, you can provide a langauge in the fieldtype options to enable syntax highlighting. For example, below is a
Code type field with options set to
You can enable basic syntax validations for following languages by setting "Option".
- Python (for scripts)
- PythonExpression (for simple one-line expressions that must evaluate to a value) E.g. Assignment Rule condition
Example of differences between
variable = 42is a valid
Pythoncode but not a valid
PythonExpressionsince the assignment doesn't evaluate to any value.
variable == 42is both valid
Pythoncode and valid
PythonExpressionas the expresion can evaluate to some value.
This will let the user input a color via a rendered color picker or directly input a hexadecimal color.
This is a
'meta' fieldtype that does not store any input data but can be used to indicate a column break in the document view or form.
will result into:
Currency field holds numeric value, like Item Price, Amount, etc. Currency field can have value up to six decimal places. Also, you can have a currency symbol being shown for the currency field.
Float field carries numeric value, up to nine decimal places.
Use Geolocation field to store GeoJSON feature_collection. Stores polygons, lines, and points. Internally it uses the following custom properties for identifying a circle.
Note: Frappe uses Leaflet library which stores coordinates as [latitude, longitude] which is reverse of what GeoJSON usually does.
This will render the content entered in
Options as HTML in the document form or view page. Here is an example:
will result into:
Image field will render an image file selected in another attach field.
For the Image field, under Option (in Doctype), a field name should be provided where the image file is attached. By referring to the value in that field, the image will be a reference in the Image field.
will result into:
The integer field holds numeric value, without decimal place.
Small Text field carries text content and has more character limit than the Data field.
You can define your field to a Long Text Field when you would want to enter data with an unlimited character limit.
This field type would allow you to add text in the field. The character limit in Small text, Long text and Text fields shall be determined based on the Relational Database Management System.
This field will allow you to add the text in markdown. This fieldtype also provides a
Preview view of rendered HTML:
when preview is clicked:
The password field will have decoded value in it. This type of field can be used to store sensitive data like passwords, pass phrases, secret keys etc.
You can define the field as a Percentage field which in the background will be calculated as a percentage.
This field can be used to display an interactive star rating input. The default star count shown is 5, however, this can easily be changed by entering a number ranging from 3 - 10 in the options field for that particular rating field.
You can also provide half ratings e.g 3.5 out of 5.
Read Only field will carry data fetched from another form which will be non-editable. You should set Read Only as field type if its source for value is predetermined.
Section Break is used to divide the form into multiple sections. Any fields that follow (and before any other
Section Break) a
Section Break field will be part of this new section.
Tab Break is used to divide the form into multiple tabs. Any field that follow till the next
Tab Break will be the part of this new tab.
Note: If the
fields table of a DocType is not started with a Tab Break, a default Tab Break named
Details will be used. This happens only if a DocType has atleast one
Tab Break in the
You can define the field to be a Signature field wherein you can add the Digital Signature in this field. Read documentation for Signature Field to know more.
This is a combination of 'Link' type and 'Table' type fields. Instead of a child table with 'Add Row' button, in one field multiple values can be selected.
This is a Time field where you can define the Time in the field.
You can use the Duration field if you want to define a timespan.
If you don't want to track duration in terms of days or seconds, you can enable "Hide Days" and "Hide Seconds" options respectively in your Form.
This creates a JSON type column in your database. Also adds syntax highlighting for Desk controls.