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.

Sign up for GitHub

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

Jump to bottom

Custom form fields support #776

Merged
merged 11 commits into from
Oct 20, 2023
Merged

Custom form fields support #776

merged 11 commits into from
Oct 20, 2023

Conversation

pinussilvestrus
Copy link
Contributor

@pinussilvestrus pinussilvestrus commented Aug 17, 2023 •
edited
Loading

Related to https://github.com/camunda/team-hto/issues/299
Closes #123

This adds more extension capabilities by

Viewer

  • Extending form field config via icon, iconUrl, propertiesPanelEntries
  • Re-export more core components as Label, Description, Errors

Editor

  • Collect palette entries and properties panel header information via form field configs
  • Support custom properties panel extensions
    • Mirror bpmn-js-properties-panel API, example
    • Add default properties panel provider
  • Add isDefaultVisible control to all properties panel entries
  • Re-export hooks
Playground
  • Make it possible to provide extensions to both editor and viewer together via additionalModules

Gather the example extension for more information.

Check out the demo environment to play around with custom components in a Sandbox.

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Aug 17, 2023
@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch from 3a117d8 to b6c4f6a Compare September 11, 2023 10:57
@pinussilvestrus pinussilvestrus mentioned this pull request Sep 11, 2023
Closed
13 tasks
@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch 8 times, most recently from a968eac to b335fd3 Compare September 14, 2023 12:15
@pinussilvestrus pinussilvestrus changed the title Spike: Custom form fields Custom form fields support Sep 14, 2023
@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch 2 times, most recently from 9699f78 to d19cb8d Compare September 14, 2023 12:38
@pinussilvestrus pinussilvestrus requested a review from a team September 18, 2023 07:05
@pinussilvestrus
Copy link
Contributor Author

@bpmn-io/hto-dev feel free to already have a look at this PR. I'd like to gather feedback on the extension points first before making it stable.

@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch from 160e245 to 6aba835 Compare September 19, 2023 08:38
@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch from 6aba835 to 3ba4c6a Compare October 5, 2023 08:24
@pinussilvestrus pinussilvestrus mentioned this pull request Oct 5, 2023
Closed
4 tasks
@pinussilvestrus pinussilvestrus marked this pull request as ready for review October 5, 2023 09:00
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed in progress Currently worked on labels Oct 5, 2023
@pinussilvestrus
Copy link
Contributor Author

@bpmn-io/hto-dev I'm opening this for review 🎉

I also added an issue to provide some examples in our repository: bpmn-io/form-js-examples#6

@pinussilvestrus pinussilvestrus mentioned this pull request Oct 10, 2023
Merged
@pinussilvestrus pinussilvestrus requested review from vsgoulart and Skaiir and removed request for a team October 10, 2023 11:15
vsgoulart
vsgoulart reviewed Oct 11, 2023
View reviewed changes
packages/form-js/CHANGELOG.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Are the changes in this file intentional? I thought we updated the changelog when release 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's in the unreleased section to ensure we have covered it already. In bpmn-io it's a good practice to add these bigger changes already, so whenever someone else handles the releases, they have more context about the changes.

vsgoulart
vsgoulart reviewed Oct 11, 2023
View reviewed changes
Copy link
Contributor

@vsgoulart vsgoulart left a comment

Choose a reason for hiding this comment

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

Just some minors comments
(I only reviewed the code today, I plan testing tomorrow)

packages/form-js-editor/src/features/palette/components/Palette.js Outdated Show resolved Hide resolved
packages/form-js-editor/src/features/palette/components/Palette.js Show resolved Hide resolved
packages/form-js-editor/src/features/properties-panel/PropertiesPanelHeaderProvider.js Outdated Show resolved Hide resolved
@DK-2013
Copy link
Contributor

DK-2013 commented Oct 12, 2023

Is the way obtain tarball package local from any commit to test in application before it (package) published?

@pinussilvestrus
Copy link
Contributor Author

@DK-2013 we have a demo environment prepared to test it out in the Form Playground: #123 (comment)

Optionally, you can simply check out the branch, do npm run build and use the local distros inside packages/form-js/dist. Let me know whether this helps already.

@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch 2 times, most recently from 230437c to f5fed07 Compare October 17, 2023 15:45
@pinussilvestrus
Copy link
Contributor Author

@vsgoulart @Skaiir I rebased the branch, so it should be ready to go again ✅

Let's try to get this merged, it's been open for quite some time now 👍

@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch from f5fed07 to 16c260a Compare October 19, 2023 07:38
Niklas Kiefer added 11 commits October 20, 2023 09:18
chore: re-export all editor and viewer exports
2b656f6
feat(palette): collect entries dynamically from form fields definitions
ef3c0aa
feat(properties-panel): introduce providers concept
e884c65 
Mirror of the providers concept of bpmn-io/bpmn-js-properties-panel
refactor(properties-panel): control entries visibility via `isDefault…
09d2ef6 
…Visible`
feat(properties-panel-header): use form field definition
933d7ab
feat(playground): provide general additionalModules option
109d2dd 
This goes into both editor and viewer
test: provide custom form field tests
a717f4a 
Closes #123
style: align palette icon image
8bf3259
chore(CHANGELOG): add notes for extensions API
41fc36c
chore(palette): use initial palette entries reference
86376df
chore(properties-panel): disable specific eslint rule
ec51371
@pinussilvestrus pinussilvestrus force-pushed the spike-custom-form-elements branch from 16c260a to ec51371 Compare October 20, 2023 07:18
@pinussilvestrus pinussilvestrus merged commit 0f53ae4 into develop Oct 20, 2023
9 of 10 checks passed
@pinussilvestrus pinussilvestrus deleted the spike-custom-form-elements branch October 20, 2023 07:27
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsgoulart vsgoulart vsgoulart approved these changes

@Skaiir Skaiir Awaiting requested review from Skaiir

Assignees

@pinussilvestrus pinussilvestrus

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support for custom elements
3 participants
@pinussilvestrus @DK-2013 @vsgoulart