@apvarun/pointerjs

PointerJS

A tiny JavaScript library to visually guide users with an animated pointer and onboarding flow.

Features

• Animated pointer to highlight elements
• Onboarding flow with notes
• Customizable colors and styles
• Zero dependencies

Installation

npm install @apvarun/pointerjs
# or
bun add @apvarun/pointerjs
# or
pnpm add @apvarun/pointerjs

Usage

Basic Onboarding

import { startOnboarding } from '@apvarun/pointerjs'

startOnboarding([
  { element: '#invite-btn', note: 'Click on the invite team button' },
  { element: '#profile', note: 'Check your profile here!' },
])

Advanced: Custom Pointer Options

startOnboarding([{ element: '#invite-btn', note: 'Invite your team!' }], {
  color: '#FF6F61',
  fontFamily: 'monospace',
  fontSize: '18px',
})

Onboarding with URLs

startOnboarding([
  { element: '#step1', note: 'Step 1', url: '/page1' },
  { element: '#step2', note: 'Step 2', url: '/page2' },
])

Using the Pointer Class Directly

import { Pointer } from '@apvarun/pointerjs'

const pointer = new Pointer({ color: '#00C853' })
pointer.moveToElement(document.querySelector('#my-element'), 'Hello!')

Or use via CDN:

<script src="https://unpkg.com/@apvarun/pointerjs"></script>
<script>
  PointerJS.startOnboarding([...])
</script>

API

startOnboarding(steps, options?, event?)

• steps: Array of { element, note, url? }
• options: Pointer customization (color, fontFamily, fontSize)
• event: Optional MouseEvent to set initial pointer position

Demo

See the demo for a working example.

Contributing

Pull requests and issues are welcome!

License

MIT © Varun A P