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

Support placeholder for properties (String, Text) #92

Closed
johnBgood opened this issue Apr 30, 2024 · 11 comments · Fixed by #103
Closed

Support placeholder for properties (String, Text) #92

johnBgood opened this issue Apr 30, 2024 · 11 comments · Fixed by #103
Assignees
Labels
enhancement New feature or request spring cleaning Could be cleaned up one day

Comments

@johnBgood
Copy link

johnBgood commented Apr 30, 2024

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

@johnBgood johnBgood added the enhancement New feature or request label Apr 30, 2024
@barmac
Copy link
Member

barmac commented Apr 30, 2024

I think it makes sense. Thanks for the suggestion.

@philippfromme philippfromme added the backlog Queued in backlog label Apr 30, 2024
@johnBgood
Copy link
Author

johnBgood commented Apr 30, 2024

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
Copy link

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

@nikku nikku added the spring cleaning Could be cleaned up one day label May 22, 2024
@nikku
Copy link
Member

nikku commented May 22, 2024

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
Copy link

I am adding this doc for context.

@nikku
Copy link
Member

nikku commented May 22, 2024

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

@nikku
Copy link
Member

nikku commented May 22, 2024

@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
Copy link
Author

@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.

Screenshot 2024-05-22 at 13 25 22

@barmac
Copy link
Member

barmac commented May 27, 2024

I am looking into this.

@barmac
Copy link
Member

barmac commented May 27, 2024

So this assumes that the FEEL editor supports a placeholder.

@barmac barmac self-assigned this May 27, 2024
@barmac
Copy link
Member

barmac commented May 27, 2024

Breakdown:

barmac added a commit to camunda/element-templates-json-schema that referenced this issue May 28, 2024
barmac added a commit to camunda/element-templates-json-schema that referenced this issue May 28, 2024
@barmac barmac added in progress Currently worked on and removed backlog Queued in backlog labels May 28, 2024
barmac added a commit to bpmn-io/feel-editor that referenced this issue May 28, 2024
Pass `placeholder` property on editor creation.
Update placeholder via `setPlaceholder` method.

Related to bpmn-io/bpmn-js-element-templates#92
barmac added a commit to bpmn-io/feel-editor that referenced this issue May 28, 2024
Pass `placeholder` property on editor creation.
Update placeholder via `setPlaceholder` method.

Related to bpmn-io/bpmn-js-element-templates#92
barmac added a commit to bpmn-io/properties-panel that referenced this issue May 28, 2024
barmac added a commit to bpmn-io/properties-panel that referenced this issue May 29, 2024
barmac added a commit to camunda/element-templates-json-schema that referenced this issue May 29, 2024
barmac added a commit to camunda/element-templates-json-schema that referenced this issue May 29, 2024
barmac added a commit to camunda/element-templates-json-schema that referenced this issue May 29, 2024
barmac added a commit that referenced this issue May 29, 2024
Closes #92

deps: update to `@bpmn-io/properties-panel@3.19.0`

deps: update to `@bpmn-io/element-templates-validator@2.1.0`
barmac added a commit that referenced this issue May 29, 2024
Closes #92

deps: update to `@bpmn-io/properties-panel@3.19.0`

deps: update to `@bpmn-io/element-templates-validator@2.1.0`
barmac added a commit that referenced this issue Jun 3, 2024
Closes #92

deps: update to `@bpmn-io/properties-panel@3.20.0`

deps: update to `@bpmn-io/element-templates-validator@2.1.0`
barmac added a commit that referenced this issue Jun 3, 2024
Closes #92

deps: update to `@bpmn-io/properties-panel@3.20.0`

deps: update to `@bpmn-io/element-templates-validator@2.1.0`
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed in progress Currently worked on labels Jun 3, 2024
barmac added a commit that referenced this issue Jun 4, 2024
Closes #92

deps: update to `@bpmn-io/properties-panel@3.20.0`

deps: update to `@bpmn-io/element-templates-validator@2.1.0`
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Jun 4, 2024
barmac added a commit to camunda/camunda-docs that referenced this issue Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request spring cleaning Could be cleaned up one day
Development

Successfully merging a pull request may close this issue.

6 participants