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

Merge pull request #1 from kamranahmedse/master

Browse Source 
Fix typo in code sample
This commit is contained in:
Preet
2020-05-27 09:40:54 -07:00
committed by GitHub
parent d7a9a42f75 d9ff39504a
commit a0fbb1bab6
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -2,7 +2,7 @@
# Rough Notation # Rough Notation
A small JavaScript library to create and animate annotations on a web page A small JavaScript library to create and animate annotations on a web page.
Rough Notation uses [RoughJS](https://roughjs.com) to create a hand-drawn look and feel. Elements can be annotated in a number of different styles. Animation duration and delay can be configured, or just turned off. Rough Notation uses [RoughJS](https://roughjs.com) to create a hand-drawn look and feel. Elements can be annotated in a number of different styles. Animation duration and delay can be configured, or just turned off.
@@ -38,7 +38,7 @@ Once you have the annotation object, you can call `show()` or `hide()` on it to
```javascript ```javascript
import { annotate } from 'rough-notation'; import { annotate } from 'rough-notation';
const e = document.quereySelector('#myElement'); const e = document.querySelector('#myElement');
const annotation = annotate(e, { type: 'underline' }); const annotation = annotate(e, { type: 'underline' });
annotation.show(); annotation.show();
``` ```
@@ -50,9 +50,9 @@ rough-notation provides a way to order the animation of annotations by creating
```javascript ```javascript
import { annotate, annotationGroup } from 'rough-notation'; import { annotate, annotationGroup } from 'rough-notation';
const a1 = annotate(document.quereySelector('#e1'), { type: 'underline' }); const a1 = annotate(document.querySelector('#e1'), { type: 'underline' });
const a2 = annotate(document.quereySelector('#e3'), { type: 'box' }); const a2 = annotate(document.querySelector('#e3'), { type: 'box' });
const a3 = annotate(document.quereySelector('#e3'), { type: 'circle' }); const a3 = annotate(document.querySelector('#e3'), { type: 'circle' });
const ag = annotationGroup([a3, a1, a2]); const ag = annotationGroup([a3, a1, a2]);
ag.show(); ag.show();