File: simput.md

package info (click to toggle)
python-trame 3.12.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 101,620 kB
  • sloc: python: 13,515; sh: 183; javascript: 93; makefile: 7
file content (31 lines) | stat: -rw-r--r-- 1,055 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Simput 
Simput is an easy way to manage data with simple, flexible form generation. See documentation [here](https://github.com/Kitware/py-simput).

```python
from trame.html import simput

# Method 1 - Use simput forms ----------------------------------------
# Must be descendant of simput.Simput component
item = simput.SimputItem(
  itemId=...,    # Simput reference to display form for
)

# Method 2 - Expose columns to other UI componentts ------------------
# Must be descendant of simput.Simput component
item = simput.SimputItem(        
  "{{FirstColumn}}",       # Componenent or Vue content referencing columns
  extract=["FirstColumn"], # Which columns to make available to children
  itemId=...,              # Simput reference. See simput docs 
  no_ui=True,              # Hide simput form, show only children
)

simput.Simput(
  item,
  ui_manager=..., # Get from separate simput library 
  prefix="...",   # Identifier for manager if multiple 
)
```

## Examples

- [API](https://trame.readthedocs.io/en/latest/trame.html.simput.html)