arthur/rough-notation
1
0
Fork 0
mirror of https://github.com/slidevjs/rough-notation.git synced 2026-01-14 17:44:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Warn of invalid markup generation (#30)

Browse Source 
Fixes https://github.com/pshihn/rough-notation/issues/29
This commit is contained in:
Zoffix Znet
2020-06-03 16:47:37 -04:00
committed by GitHub
parent ea39b80029
commit 96601ce9a0
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -43,6 +43,8 @@ const annotation = annotate(e, { type: 'underline' });
annotation.show(); annotation.show();
``` ```
The annotation element will be created as a sibling to the element passed to the annotate, as such certain elements, like `<td>`, are not suitable for annotation. Create an inner `<span>` or `<div>` and annotate that instead.
## Annotation Group ## Annotation Group
rough-notation provides a way to order the animation of annotations by creating an annotation-group. Pass the list of annotations to create a group. When show is called on the group, the annotations are animated in order. rough-notation provides a way to order the animation of annotations by creating an annotation-group. Pass the list of annotations to create a group. When show is called on the group, the annotations are animated in order.