Add focus and blur events + viewer event documentation #841
Conversation
|
|
||
| Both events receive `{ data, errors }` as a payload. | ||
| ### `submit :: { data, errors }` |
There was a problem hiding this comment.
Interesting, short format to visualize this! Do we have any other place where we use this syntax or how did you come up with it?
There was a problem hiding this comment.
To be fair there isn't a standard in place yet. Although, I didn't want to fill the documentation with a lot of events and descriptions, especially if we do the right thing and do more event driven stuff in the future. That's also why I only add descriptions when the event name doesn't make it entirely obvious.
We can always ask for GPT's opinion on this, while keeping the constraints of the compact format.
There was a problem hiding this comment.
GPT didn't seem to mind :D
packages/form-js-viewer/test/spec/render/components/FormField.spec.js
Outdated
Show resolved
Hide resolved
Related to #839
Skaiir
force-pushed
the
60-field-focus-blur-events
branch
from
0dbdf39 to
a09e9f6
Compare
| - `formField.add` | ||
| - `formField.remove` |
There was a problem hiding this comment.
These are editor events, correct? Maybe we can add the full event documentation to the general form-js README?
There was a problem hiding this comment.
Actually no these events are bound to the form field registry. So they technically are viewer events, they would fire during import.
There was a problem hiding this comment.
I think it's still good to separate them, as you access them differently: form.on() and formEditor.on(). We separate the API too so, IMO makes sense.
There was a problem hiding this comment.
You can programmatically add fields to the viewer in theory, there may be other use cases we haven't thought of that do this. For example, a streamed version of the form generator using only a viewer.
Closes #60
Related to #839