Skip to content

Conversation

@pinussilvestrus
Copy link
Contributor

@pinussilvestrus pinussilvestrus commented Aug 4, 2022

Closes #292


This makes it possible to attach all playground components individually. This enables a mode for the playground to render nothing (by not providing container config) but only orchestrate the different instances. This is a requirement to create a product-specific playground version (cf. https://github.com/bpmn-io/internal-docs/issues/527).

This also makes the "actions" (download, embed) optional.

Overview components

image

Demo

Check out this demo to get a feeling of what you can do with the API changes.

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Aug 4, 2022
@pinussilvestrus pinussilvestrus force-pushed the 286-properties-panel-module branch from 6e66134 to ecbc38c Compare August 5, 2022 11:27
@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch 2 times, most recently from 1f1f7ba to 869956d Compare August 5, 2022 12:38
@pinussilvestrus pinussilvestrus force-pushed the 286-properties-panel-module branch from ecbc38c to a385a1a Compare August 22, 2022 07:14
@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch from 869956d to 84ac01e Compare August 22, 2022 07:14
@pinussilvestrus pinussilvestrus requested review from a team, Skaiir, barmac and philippfromme and removed request for a team August 23, 2022 06:42
@pinussilvestrus

This comment was marked as resolved.

Base automatically changed from 286-properties-panel-module to develop August 23, 2022 14:08
@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch from 84ac01e to 4310736 Compare August 23, 2022 14:22
@pinussilvestrus pinussilvestrus marked this pull request as ready for review August 23, 2022 14:25
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed in progress Currently worked on labels Aug 23, 2022
@pinussilvestrus
Copy link
Contributor Author

Ready for review now.

@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch from 4310736 to 49d6383 Compare August 23, 2022 14:35
@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch from 49d6383 to 5c712c1 Compare August 25, 2022 12:46
@pinussilvestrus
Copy link
Contributor Author

@Skaiir @barmac @philippfromme, maybe any chance to get a review for this? 🙂

@barmac
Copy link
Member

barmac commented Aug 29, 2022

I missed this. Thanks for notice.

Comment on lines +325 to +334
{
name: 'data',
attachFn: 'attachDataContainer',
selector: 'cm-editor'
},
{
name: 'result',
attachFn: 'attachResultContainer',
selector: 'cm-editor'
},
Copy link
Member

Choose a reason for hiding this comment

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

Should these two have the same selector?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought about adding a custom class name to each Code Mirror instance. However, it was not possible (at least not clearly documented). That's why I keep things as they are; you can still handle/style each editor via parent selectors.

Copy link
Member

Choose a reason for hiding this comment

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

I was afraid that having the same selector in the tests can make us think data container is attached while it's the result container. If that's not the case, we can ignore it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As we now remove every container after each test, it shouldn't be the case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we are fine.

Copy link
Member

@barmac barmac left a comment

Choose a reason for hiding this comment

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

Let's make sure the test cases don't cause us pain in the future, and also enable TS users to consume the new API :)

@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Aug 29, 2022
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Aug 29, 2022
@pinussilvestrus pinussilvestrus force-pushed the 292-flexible-playground-components branch from 5c712c1 to 69fba93 Compare August 29, 2022 11:19
@pinussilvestrus pinussilvestrus requested a review from barmac August 29, 2022 11:21
Copy link
Member

@barmac barmac left a comment

Choose a reason for hiding this comment

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

Let's merge it!

@fake-join fake-join bot merged commit 8a99ea3 into develop Aug 29, 2022
@fake-join fake-join bot deleted the 292-flexible-playground-components branch August 29, 2022 12:36
@bpmn-io-tasks bpmn-io-tasks bot removed the in progress Currently worked on label Aug 29, 2022
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.

Playground components are freely attachable and detachable

2 participants