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

@drawbotics/modal

v3.0.1

Published

Basic modal component used in Drawbotics applications.

Downloads

9

Readme

Modal

A basic modal component used in Drawbotics applications. It only provides the functionality (hide/show) and animations, meaning that, the style of the final component would have to be implemented at the application level.

Installation

Install it as usual with npm:

$ npm i @drawbotics/modal

Usage

This is a controlled component so the visibility of the modal is managed by the parent component. We can toggle the modal by using the prop isVisible. Remember that by default, the modal doesn't provide any styling, it's just a container for our actual modal component (the one with styling). A basic example is:

import React from 'react';
import { StyleSheet, css } from 'aphrodite-jss';
import Modal from '@drawbotics/modal';


const styles = StyleSheet.create({
  route: {

  },
  modal: {
    background: 'white',
    padding: 32,
  },
});


class MyRoute extends React.Component {
  state = {
    isVisible: false,
  };

  render() {
    const { isVisible } = this.state;
    return (
      <div className={css(styles.route)}>
        <button onClick={() => this.setState({ isVisible: true })}>
          Open Modal
        </button>
        <Modal isVisible={isVisible} onClickOverlay={() => this.setState({ isVisible: false })}>
          <div className={css(styles.modal)}>
            Hello World
          </div>
        </Modal>
      </div>
    );
  }
}


export default MyRoute;

BaseModal

If you want to start with a basic style, you can use BaseModal instead of a generic div inside the Modal component. It provides a unified style and a close button on the corner. You can bind an event listener to the close button with the onClickClose prop.

import Modal, { BaseModal } from '@drawbotics/modal';

//...
  <Modal isVisible={isVisible}>
    <BaseModal className={styles.myModal}>
      Rest of the component
    </BaseModal>
  </Modal>
//...

ConfirmModal

If you want to display a confirmation modal to let the user continue or cancel an action, you can use the ConfirmModal component. It works by enhancing the children with a confirm action that will trigger the modal and the corresponding cancel/continue behavior.

import React from 'react';
import { BaseModal, ConfirmModal } from '@drawbotics/modal';


const MyConfirmModal = ({
  children,
}) => {
  return (
    <ConfirmModal enhance={children}>
      {(onClickConfirm, onClickCancel) => (
        <BaseModal>
          <p>
            A warning message
          </p>
          <button onClick={onClickConfirm}>Confirm</button>
          <button onClick={onClickCancel}>Cancel</button>
        </BaseModal>
      )}
    </ConfirmModal>
  );
};


class MyComponent extends React.Component {
  render() {
    return (
      <MyConfirmModal>
        {(confirm) => (
          <button onClick={() => this._handleClick(confirm)}>
            My Action
          </button>
        )}
      </MyConfirmModal>
    );
  }

  async _handleClick(confirm) {
    const confirmed = await confirm();
    if (confirmed) {
      // do something
    }
  }
}