@gdo-bzh/use-reminders-state
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-rc.4 • Public • Published

version

use-reminders-state

Create reminders and set alerts based on time.

You can:

  • set a due date
  • flag a reminder
  • complete a reminder
  • set a level of priority ( Low | Medium | High)

NPM JavaScript Style Guide

Install

yarn add @gdo-bzh/use-reminders-state react lodash.pickby use-deep-compare-effect
# or
npm i @gdo-bzh/use-reminders-state react lodash.pickby use-deep-compare-effect -S

Usage

import React from 'react'

import { useRemindersState } from 'use-reminders-state'

const Example = () => {
  const {
    reminders /* reminder list */,
    alarms /* list of scheduled alarms */,
    addReminder /* add a reminder */,
    deleteReminder /* delete a reminder */,
    toggleCompleteReminder /* toggle complete status */,
    toggleFlagReminder /* toggle flag status */,
    updateReminder /* update reminder */,
    setReminderPriority /* set level of priority */
  } = useRemindersState()

  return <div>...</div>
}

License

MIT © gdo-bzh

Package Sidebar

Install

npm i @gdo-bzh/use-reminders-state

Weekly Downloads

1

Version

1.0.0-rc.4

License

MIT

Unpacked Size

51 kB

Total Files

9

Last publish

Collaborators

  • gdo