# cool-line-arrow

> Curvy arrows for your Angular project!

Latest version **0.1.2** (published 2020-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install cool-line-arrow
pnpm add cool-line-arrow
yarn add cool-line-arrow
bun add cool-line-arrow
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-05-06 |
| First published | 2020-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 134 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Melek Damak |
| Maintainers | melekdamak |
| Keywords | angular, javascript, typescript, typeahead, canvas, line, curved, arrow, explain, steps, Line Expline, Angular comic arrows, Angular whiteboard style -arrows, Angular self drawn arrows, Angular cool arrows, Angular arrows explain steps, demo |

## Links

- npm: https://www.npmjs.com/package/cool-line-arrow
- Repository: https://github.com/MelekDamak/curved-line-arrow-angular
- Homepage: https://github.com/MelekDamak/curved-line-arrow-angular#readme
- Issues: https://github.com/MelekDamak/curved-line-arrow-angular/issues
- npm.io page: https://npm.io/package/cool-line-arrow

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2020-05-06
- 0.1.1 — 2020-05-05
- 0.1.0 — 2020-05-05
- 0.0.2 — 2020-05-05
- 0.0.1 — 2020-05-05

## README

![enter image description here](https://i.ibb.co/jWk55xg/example.png)
Fancy curved arrows for your Angular project! Great for tutorials and product tours!

Demo : https://vc6p1.csb.app/ 
<br />
Sandbox : https://codesandbox.io/s/vc6p1


## Usage

```jsx
import {CurvedLineArrowModule} from 'cool-line-arrow';

// Selector 

<tn-curved-line-arrow> </tn-curved-line-arrow>
```

## Inputs
|Name|Type|Description|Default|
|--- |--- |--- |--- |
|fromSelector|DOM selector|DOM element from which your arrow will start.|body|
|fromOffsetX|number|Amount of pixels to offset the arrow from the DOM element on the X axis.|0|
|fromOffsetY|number|Amount of pixels to offset the arrow from the DOM element on the Y axis.|0|
|toSelector|DOM selector|DOM element to which your arrow will go to.|(same as fromSelector)|
|toOffsetX|number|Amount of pixels to offset the arrow from the DOM element on the X axis.|0|
|toOffsetY|number|Amount of pixels to offset the arrow from the DOM element on the Y axis.|0|
|middleX|number|Middle point X position.|0|
|middleY|number|Middle point Y position.|40|
|width|number|Width of the arrow and arrowhead.|8|
|color|color|Color of the arrow and arrowhead.|"black"|
|hideIfFoundSelector|DOM selector|Optional. if the arrow can find this selector, it will hide itself. Useful for product tours when you only want to show an arrow whenever a user hasn't performed an action yet such as opening a menu.||
|debugLine|boolean|Show debug dots and lines for fromOffset, toOffset and middle vectors.|false|
|dynamicUpdate|boolean|Automatically adjust the arrow whenever the from/to DOM elements update. Useful for dynamic content such as sliding menus or content that is within a scrolling container.|false|
|zIndex|number|Adjust the z-index for this arrow.|0|

## Copyright



Made with ❤️ by [Melek Damak](https://www.linkedin.com/in/damak-melek-2a9819147/)

 <br />
Mail : melekdamak@gmail.com

## Inspired from

 [Styled Page](https://react-curved-arrow.nickjanssen.com), a tool that lets you visually build React apps & components!

# License
MIT

---
_Source: https://npm.io/package/cool-line-arrow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._