-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Recent experience with several issues:
- Editing and saving an existing record will not immediately show the edits #243
- Saving an association class record does not assign it to the originating
InstancesSelectEditor#244 formDatapersists information that is entered but not saved #147
has brought to light that the way in which shacl-vue manages form state, and related to that graph-vs-form-data state, is complex (likely much more than it needs to be) and largely undocumented.
In order to make future contributions/debugging easier, this whole design should be documented. Ideally this process will also lead to some code refactoring to yield less complexity.
Questions that need to be answered by the documentation (that I can think of at the moment):
- what is the purpose of
formData(fromshacl-tulip'sFormBase)? - when is
formDataused, and when is it unnecessary? - what does it mean if
formDatais saved to the graph store? - which components (can/should/might/do) have access to
formData? - what is the purpose of:
lastSavedNodeopenFormsopenForms[i].activatedInstancesSelectEditorsavedNodessubmittedNodesnodesToSubmit
- ...
IdeaS:
- consider moving
openFormsand related functions (addForm,removeForm,formOpen, more?) to theuseFormcomposable - move management of the "all fields" button state to
openForms? - consider adding a general "activatedFrom" or something like that, to replace the more specific
activatedInstancesSelectEditor, because a form could be opened from (also needs to be documented):ShaclVuemain component, create new itemInstancesSelectEditor"Add item"InstancesSelectEditoritem edit buttonNodeShapeVieweredit button
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation