Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docstring

Browse Source
This commit is contained in:
Oliver 2021-07-02 19:27:19 +10:00
parent 2e3bfd18cc
commit 366a2d57c3
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
InvenTree/templates/js/forms.js
View File

@ -223,11 +223,24 @@ function constructDeleteForm(fields, options) {
* Request API OPTIONS data from the server,
* and construct a modal form based on the response.
*
* url: API URL which defines form data
* options:
* - method: The HTTP method e.g. 'PUT', 'POST', 'DELETE',
* - method: The HTTP method e.g. 'PUT', 'POST', 'DELETE' (default='PATCH')
* - title: The form title
* - fields: list of fields to display
* - exclude: List of fields to exclude
* - fields: list of fields to display, with the following options
* - filters: API query filters
* - onEdit: callback when field is edited
* - secondary: Define a secondary modal form for this field
* - label: Specify custom label
* - help_text: Specify custom help_text
* - value: Specify initial value
* - hidden: Set to true to hide the field
* - icon: font-awesome icon to display before the field
* - prefix: Custom HTML prefix to display before the field
* - onSuccess: callback function
* - confirm: Set to true to require a "confirm" button
* - confirmText: Text for confirm button (default = "Confirm")
*
*/
function constructForm(url, options) {