Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add form-js extensions blogpost #171

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Conversation

pinussilvestrus
Copy link
Contributor

@pinussilvestrus pinussilvestrus commented Oct 27, 2023

Closes #170

This adds a dedicated blog post about form-js custom components.

Depends on https://github.com/camunda/team-hto/issues/372
Depends on bpmn-io/form-js-examples#7

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Oct 27, 2023
@pinussilvestrus pinussilvestrus requested review from vsgoulart, christian-konrad, a team, smbea and barmac and removed request for a team November 2, 2023 10:09
@pinussilvestrus
Copy link
Contributor Author

The example is still pending to be merged, but feel free to already review this post 👍

@pinussilvestrus pinussilvestrus marked this pull request as ready for review November 2, 2023 10:10
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed in progress Currently worked on labels Nov 2, 2023
@barmac
Copy link
Member

barmac commented Nov 2, 2023

Wow, this is so cool! I think this blog post could be published as is.


## Plugging everything together

You can plug your custom modules into the different form-js components as `viewerAdditionalModules` and `editorAdditionalModules`. With the latest release, we also added the `additionalModules` option that allows you to provide extensions to both simultaneously, for example, the renderer.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we give an example of viewerAdditionalModules too?

Copy link
Contributor Author

@pinussilvestrus pinussilvestrus Nov 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have to think of a proper use case. In which case you'd like to have an extension for the viewer only, but not for the editor? In terms of a custom renderer you have to add to both anyways.

One example that comes into my mind is if you want to have a different rendering in both components. We do that for the text component, where it looks different in viewer and editor (placeholder only). Maybe that could be something to showcase.

Copy link
Contributor

@christian-konrad christian-konrad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so good!

@nikku
Copy link
Member

nikku commented Nov 6, 2023

Really nice one! 👏

@fake-join fake-join bot merged commit 06b373d into main Nov 6, 2023
3 checks passed
@fake-join fake-join bot deleted the 170-form-extensions branch November 6, 2023 14:06
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Blog about form-js extensions
5 participants