Skip to content

Commit

Permalink
πŸ“πŸ‘Œ [RUM] documentation adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
BenoitZugmeyer committed Jun 2, 2020
1 parent 4b83b59 commit ede93fa
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions packages/rum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,22 @@ datadogRum.init({

### Click action naming

The RUM library will use various strategies to get a name for click actions, but if you want more
The RUM library is using various strategies to get a name for click actions, but if you want more
control, you can define a `data-dd-action-name` attribute on clickable elements (or any of their
parents) that will be used to name the action. Example:
parents) that will be used to name the action. Examples:

```html
<a class="btn btn-default" href="#" role="button" data-dd-action-name="Login button">Try it out!</a>
```

```html
<div class="alert alert-danger" role="alert" data-dd-action-name="Dismiss alert">
<span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span>
<span class="sr-only">Error:</span>
Enter a valid email address
</div>
```

## TypeScript support

Types are compatible with TypeScript >= 3.0.
Expand Down

0 comments on commit ede93fa

Please sign in to comment.