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

Render HTML in element template descriptions #626

Open
pinussilvestrus opened this issue Mar 25, 2022 · 4 comments
Open

Render HTML in element template descriptions #626

pinussilvestrus opened this issue Mar 25, 2022 · 4 comments
Labels
backlog Queued in backlog element templates enhancement New feature or request

Comments

@pinussilvestrus
Copy link
Contributor

Is your feature request related to a problem? Please describe

In element templates, it is possible to add HTML to property descriptions.

{
  "label": "Hostname",
  "description": "Specify the email server (SMTP) host name. Find some documentation <a href='https://docs.camunda.io'>here</a>",
  "type": "String",
  "binding": {
    "type": "zeebe:input",
    "name": "HOST_NAME"
  }
}

image

However, this is not possible for the general elementTemplate.description

{
  "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
  "name": "Email Connector",
  "id": "EmailConnector",
  "description": "Find some documentation <a href='https://docs.camunda.io'>here</a>",
  "appliesTo": [
    "bpmn:Task"
  ],
  "properties": []
}

image

Describe the solution you'd like

Make it possible to also provide HTML in element template descriptions.

Describe alternatives you've considered

/

Additional context

This does not solve that documentation URLs should be more visible on the properties panel header (cf. #616).

Cf. #549

@pinussilvestrus
Copy link
Contributor Author

Also to consider: render these descriptions properly in the Catalog Modal

image

@nikku
Copy link
Member

nikku commented Mar 25, 2022

Also consider: If we go that route we need to support it everywhere, i.e. also in element template chooser as well as the connectors extension.

@nikku
Copy link
Member

nikku commented Mar 25, 2022

I'd personally not go down this route, given that it is easy to link documentation via documentationRef (#616). This is not the case for property descriptions.

We could also feature the documentation link in the Template section, to have description + name + link to documentation closer to each other.

@MaxTru
Copy link
Contributor

MaxTru commented Mar 25, 2022

cc @andreasgeier

@pinussilvestrus pinussilvestrus added the backlog Queued in backlog label Mar 31, 2022 — with bpmn-io-tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Queued in backlog element templates enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants