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

Update README.md (#42)

Browse Source
This commit is contained in:
Max Eisen
2020-06-16 00:52:32 -07:00
committed by GitHub
parent 519f66a217
commit 7e034e9aa9
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

@@ -76,12 +76,12 @@ When you create an annotation object, you pass in a config. The config only has
#### type
This is a mandatory field. It sets the annotation style. Following are the list of supported annotation types:
* __underline__: Create a sketchy underline below an element.
* __underline__: This style creates a sketchy underline below an element.
* __box__: This style draws a box around the element.
* __circle__: Draw a circle around the element.
* __highlight__: Creates a highlight effect as if maked by a highlighter.
* __strike-through__: This style draws a box around the element.
* __crossed-off__: This style draws a box around the element.
* __circle__: This style draws a circle around the element.
* __highlight__: This style creates a highlight effect as if masked by a highlighter.
* __strike-through__: This style draws horizontal lines through the element.
* __crossed-off__: This style draws an 'X' across the element.
#### animate
Boolean property to turn on/off animation when annotating. Default value is `true`.