npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@chewhx/use-todo

v0.1.5

Published

Hook for React todos state

Downloads

51

Readme

@chewhx/use-todo

React hook for creating and managing todo state.

Demo

Install

npm install @chewhx/use-todo

Import

import { useTodo } from '@chewhx/use-todo';

useTodo

const {
	allTodos,
	todos,
	completedTodos,
	push,
	pop,
	markDone,
	markNotDone,
	toggleTodo,
	remove,
	update,
	listName,
} = useTodo(listName, {
	initialData?,
	onUpdate?,
	useLocalStorage?,
});

Options

  • listName: string

    • Required
    • A unique key to identify state
    • Ensure that each todo hook has a unique key or it will cause errors with local storage
  • initialData: ITodo[]

    • Optional
    • An array of data to initialize the todo state
  • onUpdate: (ITodo[]) => void

    • Optional
    • A function which will be executed on every state update
    • Receives the full array of todos as param
  • useLocalStorage: boolean

    • Optional
    • To store the todo state on local storage for persistence
    • Data from local storage will take precedence over initialData

Returns

  • allTodos: ITodo[]

    • Array of all todos
  • todos: ITodo[]

    • Array of all todos which are not done
  • completedTodos: ITodo[]

    • Array of all todos which are done
  • push: IPushTodo = (title: string) => void

    • Appends a new todo
  • pop: IPopTodo = () => void

    • Removes the last added todo
  • markDone: IMarkDone = (id: string) => void

    • Mark a todo as done
  • markNotDone: IMarkNotDone = (id: string) => void

    • Mark a todo as not done
  • toggleTodo: IToggleTodo = (id: string) => void

    • Toggle the done status of todo
  • update: IUpdateTodo = (id: string, title: string) => void;

    • Update the title of todo
  • remove: IRemoveTodo = (id: string) => void

    • Remove a specific todo