Support placeholder for properties (String, Text)

bpmn-io / bpmn-js-element-templates

The element template extension for bpmn-js

MIT License

5 stars 3 forks source link

Support placeholder for properties (String, Text) #92

Closed johnBgood closed 3 months ago

johnBgood commented 5 months ago

Is your feature request related to a problem? Please describe.

We would like to guide the users, placeholders are a best practice for this use case.

Describe the solution you'd like

We could use a new placeholder property in our JSON templates. This should be available for String, and Text properties. Not sure it makes sense for others.

Describe alternatives you've considered

Currently, we use tooltips but it doesn't have the same purpose imo.

Cf. template generation good practices

barmac commented 5 months ago

I think it makes sense. Thanks for the suggestion.

johnBgood commented 5 months ago

tagging @sbuettner for information tagging @YanaSegal for design information tagging @chillleader for context, as we'll need to update the Element Template Generator to support this as well

crobbins215 commented 4 months ago

@nikku is this something we could add to the spring cleaning list?

nikku commented 4 months ago

Tagged accordingly and added to the list. The value is clear; we just have to ensure this lands consistently across our different editors, including our FEEL editor (cf. CodeMirror#placeholder).

YanaSegal commented 4 months ago

I am adding this doc for context.

nikku commented 4 months ago

@YanaSegal any specific section in the document you want to highlight? Any specific detail you want to share?

nikku commented 4 months ago

@johnBgood Maybe you could share a specific place where you'd see values from placeholder strings (attach a screenshot). This helps us to better understand the user value these bring.

johnBgood commented 4 months ago

@nikku Absolutely, here's an example using the SQL Connector.

Using placeholders we would avoid the user reading the docs as it's super that we want a specific format (JDBC URL), and that the best practice is to set the user/password using variables instead of the URL.

I hope it clarifies the purpose, let me know if you have more questions.

barmac commented 4 months ago

I am looking into this.

barmac commented 4 months ago

So this assumes that the FEEL editor supports a placeholder.

barmac commented 4 months ago

Breakdown:

[x] allow to provide a placeholder in the JSON schema https://github.com/camunda/element-templates-json-schema/pull/144
[x] support placeholder in the FEEL editor https://github.com/bpmn-io/feel-editor/pull/52
[x] support placeholder in the properties panel entries https://github.com/bpmn-io/properties-panel/pull/363
[x] pass placeholder to custom properties from the templates https://github.com/bpmn-io/bpmn-js-element-templates/pull/103