-
Notifications
You must be signed in to change notification settings - Fork 3
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
Comments
I think it makes sense. Thanks for the suggestion. |
tagging @sbuettner for information |
@nikku is this something we could add to the spring cleaning list? |
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). |
I am adding this doc for context. |
@YanaSegal any specific section in the document you want to highlight? Any specific detail you want to share? |
@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. |
@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. |
I am looking into this. |
So this assumes that the FEEL editor supports a placeholder. |
Breakdown:
|
Pass `placeholder` property on editor creation. Update placeholder via `setPlaceholder` method. Related to bpmn-io/bpmn-js-element-templates#92
Pass `placeholder` property on editor creation. Update placeholder via `setPlaceholder` method. Related to bpmn-io/bpmn-js-element-templates#92
Closes #92 deps: update to `@bpmn-io/properties-panel@3.19.0` deps: update to `@bpmn-io/element-templates-validator@2.1.0`
Closes #92 deps: update to `@bpmn-io/properties-panel@3.19.0` deps: update to `@bpmn-io/element-templates-validator@2.1.0`
Closes #92 deps: update to `@bpmn-io/properties-panel@3.20.0` deps: update to `@bpmn-io/element-templates-validator@2.1.0`
Closes #92 deps: update to `@bpmn-io/properties-panel@3.20.0` deps: update to `@bpmn-io/element-templates-validator@2.1.0`
Closes #92 deps: update to `@bpmn-io/properties-panel@3.20.0` deps: update to `@bpmn-io/element-templates-validator@2.1.0`
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 forString
, andText
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
The text was updated successfully, but these errors were encountered: