# dpk_cursor

> high performance smooth custom cursor library that helps you to create cool things.

Latest version **1.0.7** (published 2021-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install dpk_cursor
pnpm add dpk_cursor
yarn add dpk_cursor
bun add dpk_cursor
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2021-12-04 |
| First published | 2021-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 278.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dushyant.dev |
| Maintainers | dushyant1295 |
| Keywords | dpkCursor, Custom Cursor, Mouse Events |

## Links

- npm: https://www.npmjs.com/package/dpk_cursor
- Homepage: https://github.com/Dushyant1295/dpkCursor#readme
- Issues: https://github.com/Dushyant1295/dpkCursor/issues
- npm.io page: https://npm.io/package/dpk_cursor

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2021-12-04
- 1.0.6 — 2021-12-04
- 1.0.5 — 2021-12-04
- 1.0.4 — 2021-12-04
- 1.0.3 — 2021-06-12
- 1.0.2 — 2021-06-11
- 1.0.1 — 2021-06-11

## README

# dpkCursor.js

#### High performance smooth custom cursor library that helps you to create cool things.

#

<p align="left">        
    <a href="#">
        <img src="dpkCursor.gif" height="350">
    </a>
</p>

##### [Play with Codepen]

#

### How to use:

##### CSS

[Add dpkCursor.min.css]  or  [CDN dpkCursor.min.css]

##### JAVASCRIPT

[Add dpkCursor.min.js]   or  [CDN dpkcursor.min.js]

#

##### USAGE

```HTML


<link rel="stylesheet" href="dpkCursor.min.css" />

<div class="dpk-hover" data-hover-text="Hello"> Text </div>
<div class="dpk-hover" data-hover-class="class-name"> Add class to cursor </div>
<div class="dpk-hover" data-hover-bg="#222"> Background Color </div>
<div class="dpk-hover" data-hover-img="img/a.png"> Add Image As Background </div>

<script src="dpkCursor.min.js"></script>

<script>
    const customCursor = new dpkCursor({ ease: 0.25 });
</script>


```

#### Installation Using NPM

```sh
npm install dpk_cursor

import { dpkCursor } from "dpk_cursor/src/dpkCursor";

const customCursor = new dpkCursor({ ease: 0.25 });

```

#

##### HTML Element attributes

#

| Attribute          | Values           | Description         |
| ------------------ | ---------------- | ------------------- |
| `data-hover-text`  | string           | text inside Cursor  |
| `data-hover-class` | string           | add class to Cursor |
| `data-hover-bg`    | color- name/code | bg Color of Circle  |
| `data-hover-img`   | img/path         | img inside Cursor   |

#

##### dpkCursor Provides Following Functions

#

| Name              | Parameter | Defaults | Desc             |
| ----------------- | --------- | -------- | ---------------- |
| `init()`          | -         |          | initialization   |
| `effect()`        | -         | -        | Use the Effects  |
| `reset()`         | -         | -        | reset dpkCursor  |
| `destroy()`       | -         | -        | delete dpkCursor |

#

[CDN dpkcursor.min.js]: https://cdn.jsdelivr.net/gh/Dushyant1295/dpkCursor/dpkCursor.min.js
[CDN dpkCursor.min.css]: https://cdn.jsdelivr.net/gh/Dushyant1295/dpkCursor/dpkCursor.min.css
[Play with Codepen]: https://codepen.io/dushyant1295/pen/JjWrwZa
[Add dpkCursor.min.css]: https://github.com/Dushyant1295/dpkCursor/blob/master/dpkCursor.min.css
[Add dpkCursor.min.js]: https://github.com/Dushyant1295/dpkCursor/blob/master/dpkCursor.min.js

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