2
0
mirror of https://github.com/frappe/books.git synced 2024-09-21 03:39:02 +00:00
books/docs/client/controls.md

74 lines
1.1 KiB
Markdown
Raw Normal View History

2018-01-10 12:49:52 +00:00
# Controls
Frappe.js comes in with built-in controls for various types of inputs
## Creating
A new control can be created with `control.make_control` method.
```js
const controls = require('./controls');
let control = controls.make_control({
fieldname: 'test',
fieldtype: 'Data',
label: 'Test Control'
}, body);
```
## Structure
The control has the following structure of HTML Elements
- `form_group`
- `label`
- `input`
- `description`
## Types
Type of control is defined by the `fieldtype` property.
### Data
Short text input (`<input>`)
## Text
Long text input (`<textarea>`)
## Select
2018-01-31 12:56:21 +00:00
Select a single value from a list of options (`<select>`)
Options can be set in the `options` property as a list
Example:
```js
let control = controls.make_control({
fieldname: 'test',
fieldtype: 'Select',
label: 'Test Select',
options: [
"Option 1",
"Option 2"
]
}, body);
```
## Link
You can select a value from another DocType with a Link type field. The value of the target table should be in "target"
Example:
```js
let control = controls.make_control({
fieldname: 'user',
fieldtype: 'Link',
label: 'User',
target: 'User'
}, body);
```