use-cursor

  

What is this?

A React hook to cycle an index within some max length

Installation

``bash
yarn add use-cursor
`

Usage

`javascript
import React from "react";
import { useCursor } from "use-cursor";

const App: React.FC = () => {
const { index, cursor, handlePrev, handleNext } = useCursor({ max: 10 });

return (
Next
Previous


      {JSON.stringify({ index, cursor })}
    


);
};
`

Interface

`typescript
const useCursor: ({
max,
initialCursor
}: {
max: number;
initialCursor?: number | undefined;
}) => {
handlePrev: () => void;
handleNext: () => void;
cursor: number;
index: number;
};
``