{"id":13808161,"url":"https://github.com/namitoyokota/ngx-notation-reveal","last_synced_at":"2025-05-14T02:31:22.285Z","repository":{"id":226953287,"uuid":"770052065","full_name":"namitoyokota/ngx-notation-reveal","owner":"namitoyokota","description":"Angular component to add rough notation animation when element is visible.","archived":false,"fork":false,"pushed_at":"2024-07-20T16:53:48.000Z","size":3134,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-15T02:10:34.732Z","etag":null,"topics":["angular","npm","rough-notation"],"latest_commit_sha":null,"homepage":"https://notation-reveal.namitoyokota.com","language":"HTML","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/namitoyokota.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-10T19:33:47.000Z","updated_at":"2024-07-29T07:50:44.000Z","dependencies_parsed_at":"2024-03-21T18:50:32.270Z","dependency_job_id":"10ca6c53-0451-465f-be5b-d98d5651fde0","html_url":"https://github.com/namitoyokota/ngx-notation-reveal","commit_stats":null,"previous_names":["namitoyokota/ngx-notation-reveal"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/namitoyokota%2Fngx-notation-reveal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/namitoyokota%2Fngx-notation-reveal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/namitoyokota%2Fngx-notation-reveal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/namitoyokota%2Fngx-notation-reveal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/namitoyokota","download_url":"https://codeload.github.com/namitoyokota/ngx-notation-reveal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225273220,"owners_count":17448071,"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","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","npm","rough-notation"],"created_at":"2024-08-04T01:01:36.364Z","updated_at":"2024-11-19T00:30:35.795Z","avatar_url":"https://github.com/namitoyokota.png","language":"HTML","funding_links":[],"categories":["Third Party Components"],"sub_categories":["Animations"],"readme":"\u003ch1 align=\"center\"\u003e\u003cimg height=\"150\" src=\"https://raw.githubusercontent.com/namitoyokota/ngx-notation-reveal/master/src/assets/logo.png\" /\u003e\u003cbr\u003e Notation Reveal\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/namitoyokota/ngx-notation-reveal/blob/master/LICENSE\"\u003e\n        \u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/namitoyokota/ngx-notation-reveal\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/ngx-notation-reveal\"\u003e\n        \u003cimg alt=\"NPM Version\" src=\"https://img.shields.io/npm/v/ngx-notation-reveal.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/ngx-notation-reveal\"\u003e\n        \u003cimg alt=\"NPM Downloads\" src=\"https://img.shields.io/npm/dt/ngx-notation-reveal\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cb\u003eNotation Reveal\u003c/b\u003e is an Angular component to add the Rough Notation animation when element scrolls into view.\n\u003c/p\u003e\n\n## Demo\n\n![Demo Gif](https://raw.githubusercontent.com/namitoyokota/ngx-notation-reveal/master/src/assets/demo.gif)\n\nView the [live demo](https://notation-reveal.namitoyokota.com/) or [CodeSandbox](https://codesandbox.io/p/devbox/ngx-notation-reveal-demo-mf875r)!\n\n## Installation\n\nInstall using a package manager:\n\n```shell\nnpm i ngx-notation-reveal\n```\n\nor\n\n```shell\nyarn add ngx-notation-reveal\n```\n\n## Usage\n\nFirst, import the module.\n\n```typescript\nimport { NotationRevealModule } from 'ngx-notation-reveal';\n\n@NgModule({\n    imports: [NotationRevealModule],\n})\nexport class AppModule {}\n```\n\nNext, set up a config property. You can read all annotation types on Rough Notation's official documentation.\n\n```typescript\nimport { RoughAnnotationConfig } from 'ngx-notation-reveal';\n\nreadonly underline = {\n    type: 'underline',\n    color: '#F38181',\n} as RoughAnnotationConfig;\n```\n\nLastly, add component in the HTML.\n\n```html\n\u003cnotation-reveal [config]=\"underline\"\u003eThis sentence will be underlined.\u003c/notation-reveal\u003e\n```\n\n## API\n\nThis readonly component takes in the following properties as inputs:\n\n| Name     | Type                                                                                                                 | Default | Description                                                         |\n| -------- | -------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------- |\n| `config` | [RoughAnnotationConfig](https://github.com/rough-stuff/rough-notation?tab=readme-ov-file#configuring-the-annotation) |         | Styling of the annotation.                                          |\n| `reset`  | boolean                                                                                                              | true    | Whether to re-animate annotation each time element enters viewport. |\n| `delay`  | number                                                                                                               | 1000    | Time before animation after element enters viewport (in ms).        |\n\n## License\n\n[MIT](https://github.com/namitoyokota/ngx-notation-reveal/blob/master/LICENSE) \u0026copy; [Namito Yokota](https://www.namitoyokota.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamitoyokota%2Fngx-notation-reveal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnamitoyokota%2Fngx-notation-reveal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamitoyokota%2Fngx-notation-reveal/lists"}