From 8c94305269715cfee1652a6cf96e7c718fffbf0a Mon Sep 17 00:00:00 2001 From: Namito Yokota Date: Fri, 17 May 2024 19:11:31 -0500 Subject: [PATCH] API section to readme. --- README.md | 18 +++++++----------- projects/ngx-notation-reveal/package.json | 2 +- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 96d2b8d..a9005ed 100644 --- a/README.md +++ b/README.md @@ -66,19 +66,15 @@ Lastly, add component in the HTML. This sentence will be underlined. ``` -## Directives +## API -Optionally, override the reset flag to avoid re-animations. +This readonly component takes in the following properties as inputs: -```html - -``` - -Delay, set to 1000 milliseconds (1 second) by default, can also be overridden. - -```html - -``` +| Name | Type | Default | Description | +| -------- | -------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------- | +| `config` | [RoughAnnotationConfig](https://github.com/rough-stuff/rough-notation?tab=readme-ov-file#configuring-the-annotation) | | Styling of the annotation. | +| `reset` | boolean | true | Whether to re-animate annotation each time element enters viewport. | +| `delay` | number | 1000 | Time before animation after element enters viewport (in ms). | ## License diff --git a/projects/ngx-notation-reveal/package.json b/projects/ngx-notation-reveal/package.json index 74c640f..9c33d8f 100755 --- a/projects/ngx-notation-reveal/package.json +++ b/projects/ngx-notation-reveal/package.json @@ -1,6 +1,6 @@ { "name": "ngx-notation-reveal", - "version": "17.0.0", + "version": "17.0.1", "description": "Angular component to add rough notation when element is visible.", "author": { "name": "Namito Yokota",