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

react-hook-use-dialog

v0.9.5

Published

React hook to control and trigger dialogs

Downloads

1

Readme

react-use-dialog

React hook to control and trigger dialogs.

Installation

npm i react-use-dialog

Usage

  1. Include the DialogContextProvider, before any component that uses the useDialog hook.
import React from "react";
import ReactDOM from "react-dom/client";
import App from "./App";
import { DialogContextProvider } from "react-hook-use-dialog";

ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
  <React.StrictMode>
    <DialogContextProvider>
      <App />
    </DialogContextProvider>
  </React.StrictMode>
);
  1. Use your own dialog.
import { useCallback } from "react";
import MyCustomConfirmDialog from "./MyCustomConfirmDialog";
import useDialog from "react-hook-use-dialog";

export default function App() {
  const confirmDialog = useDialog(MyCustomConfirmDialog);

  const handleClick = useCallback(() => {
    confirmDialog.open({
      confirmMessage: "Are you sure you want to delete this item?",
      onConfirm: () => alert("confirmed!"),
    });
  }, [confirmDialog]);

  return <Button onClick={handleClick}>Show confirm dialog</Button>;
}
  1. Dialog example (with mui dialog):
import {
  Dialog,
  DialogContent,
  DialogActions,
  Button,
  DialogProps,
  Slide,
} from "@mui/material";
import { TransitionProps } from "@mui/material/transitions";
import React, { useCallback } from "react";

type ConfirmDialogProps = DialogProps & {
  confirmMessage: string;
  cancelText?: string;
  confirmText?: string;
  onCancel?: () => void | Promise<void>;
  onConfirm?: () => void | Promise<void>;
};

const Transition = React.forwardRef(function Transition(
  props: TransitionProps & { children: React.ReactElement<any, any> },
  ref: React.Ref<unknown>
) {
  return <Slide direction="up" ref={ref} {...props} />;
});

export default function ConfirmDialog({
  confirmMessage,
  cancelText,
  confirmText,
  onCancel,
  onConfirm,
  ...dialogProps
}: ConfirmDialogProps) {
  const handleConfirm = useCallback(
    async (event: {}) => {
      onConfirm && (await onConfirm());
      dialogProps.onClose && dialogProps.onClose(event, "backdropClick");
    },
    [onConfirm]
  );

  const handleCancel = useCallback(
    async (event: {}) => {
      onCancel && (await onCancel());
      dialogProps.onClose && dialogProps.onClose(event, "backdropClick");
    },
    [onCancel]
  );

  return (
    <Dialog TransitionComponent={Transition} {...dialogProps}>
      <DialogContent>{confirmMessage}</DialogContent>
      <DialogActions>
        <Button onClick={handleCancel} color="error">
          {cancelText || "Cancel"}
        </Button>
        <Button onClick={handleConfirm} color="primary">
          {confirmText || "Confirm"}
        </Button>
      </DialogActions>
    </Dialog>
  );
}

API

useDialog

Your custom dialog must atleast have an open and onClose prop. All other props will be available for override when you init useDialog or as parameters in the open method that is returned.

type DialogComponent = React.ComponentType<{ open: boolean, onClose: () => void }>
function useDialog<T = DialogComponent,  P = React.ComponentProps<T>>(dialogComponent: T, dialogProps?: Omit<P, 'open' | 'onClose'>): { open: (dialogProps?: Omit<P, 'open' | 'onClose'> )}