✨ [RUMF-385] implement a declarative API to set the action names #412
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mquentin
approved these changes
Jun 2, 2020
bcaudan
reviewed
Jun 2, 2020
bcaudan
reviewed
Jun 2, 2020
| @@ -1,16 +1,48 @@ | |||
| export function getActionNameFromElement(element: Element): string { | |||
| // Proceed to get the action name in two steps: | |||
| // * first, use strategies that are known to return good results. Those strategies will be used on | |||
| // * first, get the name programmatically, explicitely defined by the user. | |||
| // * then, use strategies that are known to return good results. Those strategies will be used on | |||
There was a problem hiding this comment.
what do you think of renaming "getters" to "strategies" in order to have a more consistent wording between comments and implementation?
There was a problem hiding this comment.
Ok I'll rename this
bcaudan
reviewed
Jun 2, 2020
BenoitZugmeyer
force-pushed
the
benoit/get-action-name-programmatically
branch
from
fbfbc28
to
d08c0a5
Compare
bcaudan
reviewed
Jun 2, 2020
bcaudan
reviewed
Jun 2, 2020
bcaudan
approved these changes
Jun 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We want to allow RUM library users to declare action names directly within the HTML markup (or DOM tree).
Changes
Add a new, top priority strategy to the
getActionNameFromElementfunction that look for adata-dd-action-nameattribute on the element or any of its parent.Testing
Unit tests should be enough
I have gone over the contributing documentation.