Getting Started

Installation

How to install and set up @pulsesync/uikit in your project.

1. Install the package
npmnpm install @pulsesync/uikit
yarnyarn add @pulsesync/uikit
pnpmpnpm add @pulsesync/uikit
2. Import styles
// In your app entry (e.g. layout.tsx, main.tsx)
import '@pulsesync/uikit/styles'
3. Wrap with Provider (optional — for NavLink routing)
// Next.js example
import { PulseSyncUIProvider } from '@pulsesync/uikit'
import Link from 'next/link'
import { usePathname } from 'next/navigation'

<PulseSyncUIProvider
  LinkComponent={Link}
  usePathname={usePathname}
>
  <App />
</PulseSyncUIProvider>
4. Use components
import { Button, Avatar, Tooltip } from '@pulsesync/uikit'

export function MyPage() {
  return (
    <div>
      <Avatar src="/user.jpg" alt="John" status="online" />
      <Tooltip content="Click me!">
        <Button variant="primary">Hello</Button>
      </Tooltip>
    </div>
  )
}
Peer dependencies
react>= 18.0
react-dom>= 18.0
framer-motion>= 11.0