Add form preview documentation and create a generic form preview controller #17589
Conversation
dombesz
force-pushed
the
documentation/add-form-preview-documentation
branch
2 times, most recently
from
26e28db to
66522e6
Compare
| @@ -31,22 +31,13 @@ | |||
| import { Controller } from '@hotwired/stimulus'; | |||
|
|
|||
| export default class ProjectLifeCyclesFormController extends Controller { | |||
There was a problem hiding this comment.
Have you thought about letting ProjectLifeCyclesFormController inherit from FormPreviewController? Thus you would not have register two controllers and handle the dispatched event in the html but can do it directly in the controller.
There was a problem hiding this comment.
My idea was that the FormPreviewController can also be used as a standalone controller and wanted to communicate with it that way.
However, inheritance in this case would definitely make things simpler. The dispatching logic could be spared.
There was a problem hiding this comment.
@HDinger I changed the ProjectLifeCyclesFormController to inherit from the FormPreviewController.
I also cherry picked a bugfix related to this code from the release branch and updated the docs.
dombesz
force-pushed
the
documentation/add-form-preview-documentation
branch
from
0ab9106 to
c7fa8b3
Compare
This way the live example can be accessed from the previews library too, and not just from the form pattern documentation.
…sing. Update docs.
Ticket
https://community.openproject.org/wp/60573
What are you trying to accomplish?
Follow up documentation of the form preview pattern implemented in the Stages and Gates Project Overview page. Additionally a general form preview stimulus controller has been extracted that could be used as plug and play on any form.
Screenshots
What approach did you choose and why?
The documentation includes a live example of how to use the form preview stimulus controller. Additionally it describes how our backend services can handle the previews easily.
Merge checklist