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

[EUI] [Tour] Ability to target beacon location based on ID or other selectors #124052

Closed
Heenawter opened this issue Jan 28, 2022 · 7 comments
Closed
Labels
discuss EUI impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort

Comments

@Heenawter
Copy link
Contributor

Heenawter commented Jan 28, 2022

Describe the feature:

Right now, it is only possible to implement a tour by wrapping EuiTour tags around the desired target elements - this makes it difficult (if not impossible with our current infrastructure) to target certain components due to the modularity of Kibana. Instead, it would be amazing if this could take a more dynamic approach where the tour simply targets elements by their unique ID or other selectors without having to manually wrap each component in EuiTour tags - this is more similar to how other tour libraries function, such as React Joyride

Describe a specific use case for the feature:

As an example, consider adding a tour to Discover.

  • Right now, it is impossible to link beacons to certain Eui components where the HTML is not accessible from within Kibana - for example, the Columns control in the header of an EuiDataGrid is not currently targetable:
    image

  • Right now, it is difficult to have a tour that spans over multiple elements of the plugin - for example, suppose the Discover tour wanted beacons attached to each of the follow locations;

    image

    This currently requires passing a tour object around to multiple files of code and it becomes very clunky and difficult to follow even with minimal EuiTourSteps.

If EuiTourSteps could instead be linked to elements based on querySelectors or something similar, this would allow for a single tour object to be floated over the entire plugin, which would make the code much easier to follow and would expand the use cases of EuiTour to unimaginable levels! 🔥

⭐ Click here for a PR that includes a demo of the possibilities

@elasticmachine
Copy link
Contributor

Pinging @elastic/eui-design (EUI)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-services (Team:AppServicesUx)

@thompsongl
Copy link
Contributor

Makes sense to me! I've created elastic/eui#5576 so we're tracking in EUI

@exalate-issue-sync exalate-issue-sync bot added impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. loe:small Small Level of Effort labels Feb 1, 2022
@shaunmcgough
Copy link

We could really use this feature for the new Document Explorer in Discover. As we are planning on turning this on by default in 8.2, it would be good to build this now to have it ready. The goal for Discover is to introduce users to new features so they don't feel lost or confused. This feature helps with that. We want to highlight new features and offer further info. The product team is all in favor of this feature in EUI if possible.

@exalate-issue-sync exalate-issue-sync bot added loe:medium Medium Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. and removed loe:small Small Level of Effort impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. labels Mar 18, 2022
@banderror
Copy link
Contributor

@Heenawter We were interested in this feature in Security Solution and I just noticed that the linked issue in EUI (elastic/eui#5576) has been addressed in elastic/eui#5696. Still need to try it out though.

@thompsongl
Copy link
Contributor

Just noting that the new features from EUI will be available after #128313 merges.

@Heenawter
Copy link
Contributor Author

This is possible now thanks to the EUI v52.2.0 being merged 🎉 🎉 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss EUI impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort
Projects
None yet
Development

No branches or pull requests

5 participants