{"id":35800542,"url":"https://github.com/jornetsimon/ng-rough-notation","last_synced_at":"2026-01-07T11:03:04.737Z","repository":{"id":41586905,"uuid":"271512761","full_name":"jornetsimon/ng-rough-notation","owner":"jornetsimon","description":"〽️ A simple and configurable directive to annotate elements","archived":false,"fork":false,"pushed_at":"2023-02-03T14:43:15.000Z","size":2223,"stargazers_count":5,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-03T19:36:40.339Z","etag":null,"topics":["angular","annotate","annotations","drawing","highlight","rough"],"latest_commit_sha":null,"homepage":"https://ng-rough-notation-demo.stackblitz.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jornetsimon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-11T10:03:47.000Z","updated_at":"2024-03-10T04:40:41.000Z","dependencies_parsed_at":"2023-02-06T12:31:52.071Z","dependency_job_id":null,"html_url":"https://github.com/jornetsimon/ng-rough-notation","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/jornetsimon/ng-rough-notation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jornetsimon%2Fng-rough-notation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jornetsimon%2Fng-rough-notation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jornetsimon%2Fng-rough-notation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jornetsimon%2Fng-rough-notation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jornetsimon","download_url":"https://codeload.github.com/jornetsimon/ng-rough-notation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jornetsimon%2Fng-rough-notation/sbom","scorecard":{"id":533041,"data":{"date":"2025-08-11","repo":{"name":"github.com/jornetsimon/ng-rough-notation","commit":"fa69371fe1d4e33760407407e2aba8a532209dbf"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"67 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-273r-mgr4-v34f","Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w","Warn: Project is vulnerable to: GHSA-q9mw-68c2-j6m5","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-36fh-84j7-cv5h","Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5","Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp","Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq","Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr","Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765","Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj","Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq","Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T06:12:33.576Z","repository_id":41586905,"created_at":"2025-08-20T06:12:33.576Z","updated_at":"2025-08-20T06:12:33.576Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28234797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2026-01-07T02:00:05.975Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","annotate","annotations","drawing","highlight","rough"],"created_at":"2026-01-07T11:02:05.485Z","updated_at":"2026-01-07T11:03:04.728Z","avatar_url":"https://github.com/jornetsimon.png","language":"TypeScript","readme":"# ng-rough-notation\n![Licence](https://badgen.net/badge/license/MIT/blue)\n![NPM](https://badgen.net/npm/dw/ng-rough-notation)\n![Tree Shaking](https://badgen.net/bundlephobia/tree-shaking/ng-rough-notation)\n![Last commit](https://badgen.net/github/last-commit/jornetsimon/ng-rough-notation)\n\n〽️ A simple and configurable directive to annotate elements.\n\n![Banner](https://i.imgur.com/IyoECHI.gif)\n\nThis is an Angular 13 wrapper for [rough-notation](https://roughnotation.com).\n\n- 😌 **Easy to use**\n- 🪶 **Lightweight**\n- 🎨 **Customizable** : colors, duration, delay, padding...\n- ⚙️ **Convenient** : local \u0026 global config\n\n## Demo\n\n[Demo page](https://ng-rough-notation-demo.stackblitz.io/)\n\n[StackBlitz sandbox](https://stackblitz.com/edit/ng-rough-notation-demo)\n\n## Installation\n\n```bash\nnpm install ng-rough-notation\n```\n\nAdd `RoughNotationModule` to your module imports :\n``` typescript\nimport { RoughNotationModule } from 'ng-rough-notation';\n\n@NgModule({\n    ...\n    imports: [RoughNotationModule],\n})\nexport class AppModule {}\n\n```\n\n## Usage\n\nUse the `roughNotation` directive on any element :\n\n ``` html\n\u003cspan roughNotation\u003eSome content\u003c/span\u003e\n ```\nBy default, _highlight_ will be used.\n\n#### Config object\n\nYou can provide a configuration object to the directive.\n\n ``` html\n\u003cspan [roughNotation]=\"{ type: 'highlight', color: '#F44336' }\"\u003e\u003c/span\u003e\n ```\n\nThe config object should represent a partial [RoughAnnotationConfigBase](https://github.com/pshihn/rough-notation/blob/979cdd33d8825df4e0124de17e4e2433e1f6e4a6/src/model.ts#L16) interface.\n\n*Every property is optional since a default config is predefined.*\n\n| Property          | Type                                                         | Default value                             |\n| ----------------- | ------------------------------------------------------------ | ----------------------------------------- |\n| type              | `'underline'`, `'box'`, `'circle'`, `'highlight'`, `'strike-through'`, `'crossed-off'`, `'bracket'` | `'highlight'`                             |\n| animate           | `boolean`                                                    | `true`                                    |\n| animationDuration | `number`                                                     | `800`                                     |\n| animationDelay    | `number`                                                     | `0`                                       |\n| color             | `string`                                                     | See [Automatic colors](#automatic-colors) |\n| strokeWidth       | `number`                                                     | `1`                                       |\n| padding           | `number`,  `[number, number]`, `[number, number, number, number]` | `5`                                       |\n| multiline         | `boolean`                                                    | `false`                                   |\n| iterations        | `number`                                                     | `2`                                       |\n| brackets          | `'left'`, `'right'`, `'top'`, `'bottom'`,  [...`'left'`, `'right'`, `'top'`, `'bottom'`] | `'right'`                                 |\n\nPlease refer to the official doc for [property descriptions](https://github.com/pshihn/rough-notation#configuring-the-annotation).\n\n#### Inputs\n\n| Name                   | Type      | Default value | Description                                                  |\n| ---------------------- | --------- | ------------- | ------------------------------------------------------------ |\n| **show**               | `boolean` | `true`        | Sets the visibility of the annotation.                       |\n| **annotatedTextColor** | `boolean` | `true`        | Specify the CSS `color` value the element should have \u003cu\u003eonly when it is annotated\u003c/u\u003e. \u003cbr /\u003eReturns to its original color when the annotation is hidden. |\n\n#### Outputs\n\n| Name                | Type                    | Description                                          |\n| ------------------- | ----------------------- | ---------------------------------------------------- |\n| **isShowingChange** | `EventEmitter\u003cboolean\u003e` | Triggers each time the annotation visibility changes |\n\n#### Instance\n\nYou can get a reference to the `RoughNotationDirective` instance.\n\n```html\n\u003cspan roughNotation #instance=\"roughNotation\"\u003e\u003c/span\u003e\n```\n\nThis is useful if you want to toggle programmatically the annotation.\n\n| Method       | Description                                                 |\n| ------------ | ----------------------------------------------------------- |\n| **toggle()** | Shows or hide the annotation according to its current state |\n\n## Automatic colors\n\nA set of default colors is defined for each annotation *type*. It follows the scheme on the [original website](https://roughnotation.com) so you can omit the *color* property if you're happy with the defaults. \n\n| Type           | Default color                                |\n| :------------- | -------------------------------------------- |\n| highlight      | \u003cspan style=\"color:#FFF176\"\u003e`#FFF176`\u003c/span\u003e |\n| circle         | \u003cspan style=\"color:#0D47A1\"\u003e`#0D47A1`\u003c/span\u003e |\n| box            | \u003cspan style=\"color:#4A148C\"\u003e`#4A148C`\u003c/span\u003e |\n| strike-through | \u003cspan style=\"color:#1B5E1F\"\u003e`#1B5E1F`\u003c/span\u003e |\n| underline      | \u003cspan style=\"color:#B71C1B\"\u003e`#B71C1B`\u003c/span\u003e |\n| crossed-off    | \u003cspan style=\"color:#F57F17\"\u003e`#F57F17`\u003c/span\u003e |\n| bracket        | \u003cspan style=\"color:#FF0000\"\u003e`#FF0000`\u003c/span\u003e |\n\n## Global configuration\n\nYou can provide a global default configuration for the whole module.\n\nFor that you can use the `forRoot()` method on the module.\n\n```typescript\nRoughNotationModule.forRoot({\n    type: 'circle',\n    animationDuration: 1000,\n})\n```\n\n*Note: this global configuration will be overriden by the configurations provided to the `roughNotation` directives.*\n\n## Annotation group\n\nYou can use the `rough-notation-group` component to wrap and toggle a bunch of annotations.\n\n```html\n\u003crough-notation-group [show]=\"showGroup\"\u003e\n   \u003cdiv\u003e\n      \u003cspan roughNotation\u003eFirst annotation\u003c/span\u003e\n   \u003c/div\u003e\n   \u003cdiv\u003e\n      \u003cspan [roughNotation]=\"{ type: 'underline' }\"\u003eSecond annotation\u003c/span\u003e\n   \u003c/div\u003e\n\u003c/rough-notation-group\u003e\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjornetsimon%2Fng-rough-notation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjornetsimon%2Fng-rough-notation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjornetsimon%2Fng-rough-notation/lists"}