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

[Meta] Standalone text embed for dashboards #120420

Closed
6 tasks
Tracked by #106330
poffdeluxe opened this issue Dec 3, 2021 · 4 comments
Closed
6 tasks
Tracked by #106330

[Meta] Standalone text embed for dashboards #120420

poffdeluxe opened this issue Dec 3, 2021 · 4 comments
Assignees
Labels
Feature:Dashboard Dashboard related features impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Meta Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas

Comments

@poffdeluxe
Copy link
Contributor

poffdeluxe commented Dec 3, 2021

Related to #46341

Milestones

This meta issue is to track work around a standalone text embeddable for markdown and rich text for dashboards. Currently, dashboard depends on a markdown visualization for text on dashboards. This means that when adding text to a dashboard, a markdown visualization is added and then you must leave the dashboard and edit the text from the Visualization editor.

Phasing:

  • New, simple text embeddable that renders markdown. This embeddable is only editable via the in-line editor
  • Evaluate and select a simple rich text editor ideally one that outputs markdown behind-the-scenes but allows the user to style text without having to use markdown
  • Add the new rich text editor to the in-line editor the text embed
  • Unify the text embed with the markdown element in Canvas (Future)
  • Add features that exist in the TSVB markdown editor (templating with data like canvas, backgrounds, colors) (Future)

Next Up

  • Text embeddable with markdown support using the in-line editor (replaces existing text embeddable)
  • Deprecate/remove old markdown viz
  • Evaluate and select rich text editor
  • Integrate rich text editor into text embed

Future Work

  • Unify new text embeddable and Canvas markdown element
  • Incorporate features that exist currently in the TSVB markdown editor

Deployment

I recommend that the first version of the new text embeddable should be deployed with the first version of the in-line editor. The reason for this is that the inline editor is a requirement for this project.

@poffdeluxe poffdeluxe added Feature:Dashboard Dashboard related features Meta Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas labels Dec 3, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@poffdeluxe
Copy link
Contributor Author

poffdeluxe commented Dec 3, 2021

EUI provides a simple markdown editor: https://elastic.github.io/eui/#/editors-syntax/markdown-editor

Here are a few interesting external editors to look at as well:

Editors with markdown:

Editors without markdown:

I think there's a conversation to be had around whether we want to have rich text without markdown and potentially allow this embeddable to operate in markdown mode (we give them the simple EUI markdown editor) or a different rich text mode that would not be markdown but might include other features

@ThomThomson ThomThomson added the impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. label Mar 9, 2023
@ThomThomson
Copy link
Contributor

Nothing here that we've had a request for math support in our markdown component, could be a later addition to this project.

@ThomThomson
Copy link
Contributor

Closing this in favour of #46341 because that issue has more design discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Dashboard Dashboard related features impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Meta Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas
Projects
None yet
Development

No branches or pull requests

4 participants