Gathering detailed insights and metrics for wc-svg-annotator
Gathering detailed insights and metrics for wc-svg-annotator
Installations
npm install wc-svg-annotatorDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
16.17.0
NPM Version
7.22.0
Score
54.4
Supply Chain
95.9
Quality
74.8
Maintenance
50
Vulnerability
98.9
License
Releases
Unable to fetch releases
Contributors
1
Unable to fetch Contributors
Languages
3
Vue
JavaScript
HTML
Vue (78.51%)
JavaScript (18.57%)
HTML (2.91%)
Developer
graphieros
Download Statistics
Total Downloads
2,263
Last Day
1
Last Week
3
Last Month
10
Last Year
378
GitHub Statistics
14 Commits
2 Watching
1 Branches
1 Contributors
Maintainers
1
Package Meta Information
Latest Version
1.0.1
Package Id
wc-svg-annotator@1.0.1
Unpacked Size
7.41 MB
Size
1.70 MB
File Count
8
NPM Version
7.22.0
Node Version
16.17.0
Publised On
27 Jan 2023
Total Downloads
Cumulative downloads
Total Downloads
2,263
Last day
0%
1
Compared to previous day
Last week
0%
3
Compared to previous week
Last month
11.1%
10
Compared to previous month
Last year
-79.9%
378
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
svg-annotator web component
A web component to select any area on a web page, annotate it and save the result to pdf.
Features:
- adds a button on the page, to enable the selection and annotation of its content
- after selecting by dragging the mouse, a modal will display a canvas copy of the selection area, along with annotation tools
- generate a pdf of the annotated content
Annotation tools:
- create shapes (rectangle, circle, arrow)
- freehand drawing
- add text (includes bullet points mode)
- select, move, resize, copy paste, delete, group & ungroup, redo shapes
- save to pdf (uses html2canvas & jspdf as dependencies)
- choose printing orientation
- choose hd or low def print
Project setup
npm i wc-svg-annotator
Place the web component on the desired page:
<html>
<!-- your content -->
<svg-annotator />
</html>
Props
| Prop | Description | Default | Options |
|---|---|---|---|
| button-position | Placement of the fixed starter button on the page | "mr" (middle right) | "tr", "mr", "br", "tl", "ml", "bl" |
| button-size | Size of the annotation toolbar buttons | 28 | - |
| font-family | Font family of the annotator | "Helvetica" | - |
| icon-color | Color of the icons and borders of the annotator buttons | "#4a4a4a" | - |
| show-print | Enable / Disable pdf functionality | true | true, false |
| show-tooltips | Show / Hide tooltips | true | true, false |
| translation-auto-orientation | Label for the auto print orientation checkbox | "auto print orientation" | - |
| translation-clipboard-failure | Label for the error message if the image copy to clipboard feature is not supported by the client's browser | "This functionality is not supported by your browser. Sorry" | - |
| translation-clipboard-success | Label for the success message after copying to clipboard | "Image successfully copied to your clipboard." | - |
| translation-color | Label for the color picker input | "Color" | - |
| translation-color-alpha | Label for the color alpha slider input | "Color alpha" | - |
| translation-dashed-lines | Label for the dashed lines checkbox | "Dashed lines" | - |
| translation-filled | Label for the filled shape checkbox | "Filled" | - |
| translation-hd-print | Label for the hd print checkbox | "hd print" | - |
| translation-font-size | Label for the font size input | "Font size" | - |
| translation-thickness | Label for the line thickness input | "Thickness" | - |
| translation-title | Title of the annotator summary | "Annotations" | - |
| translation-tooltip-group | Tooltip for the group button | "Select & Group" | - |
| translation-tooltip-delete | Tooltip for the delete button | "Delete" | - |
| translation-tooltip-move | Tooltip for the move button | "Move" | - |
| translation-tooltip-resize | Tooltip for the resize button | "Resize" | - |
| translation-tooltip-bring-to-front | Tooltip for the bring to front button | "Bring to front" | - |
| translation-tooltip-bring-to-back | Tooltip for the bring to back button | "Bring to back" | - |
| translation-tooltip-duplicate | Tooltip for the duplicate button | "Duplicate" | - |
| translation-tooltip-redo | Tooltip for the redo button | "Redo last shape" | - |
| translation-tooltip-undo | Tooltip for the undo button | "Undo last shape" | - |
| translation-tooltip-ungroup | Tooltip for the ungroup button | "Ungroup" | - |
| translation-tooltip-pdf | Tooltip for the save pdf button | "Save pdf" | - |
| translation-tooltip-clipboard | Tooltip for the copy to clipboard button | "Copy to clipboard" | - |
Here is the syntax to use all the props in your HTML. If you don't add props, these will be used by default:
<html>
<svg-annotator
button-position="mr"
button-size="28"
font-family="Helvetica"
icon-color="#4a4a4a"
show-print="true"
show-tooltips="true"
translation-auto-orientation="auto print orientation"
translation-clipboard-failure="This functionality is not supported by your browser. Sorry"
translation-clipboard-success="Image successfully copied to your clipboard."
translation-color="Color"
translation-color-alpha="Color alpha"
translation-dashed-lines="Dashed lines"
translation-filled="Filled"
translation-font-size="Font size"
translation-hd-print="hd print"
translation-thickness="Thickness"
translation-title="Annotations"
translation-tooltip-group="Select & Group"
translation-tooltip-delete="Delete"
translation-tooltip-move="Move"
translation-tooltip-resize="Resize"
translation-tooltip-bring-to-front="Bring to front"
translation-tooltip-bring-to-back="Bring to back"
translation-tooltip-duplicate="Duplicate"
translation-tooltip-redo="Redo last shape"
translation-tooltip-undo="Undo last shape"
translation-tooltip-ungroup="Ungroup"
translation-tooltip-pdf="Save pdf"
translation-tooltip-clipboard="Copy to clipboard"
/>
</html>
Caveats
- The copy to clipboard funtionality only works on chromium-based browsers at this stage. In case the browser does not support this functionality, the copy to clipboard button will simply not show.
No vulnerabilities found.
No security vulnerabilities found.