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

@material/react-dialog

v0.15.0

Published

Material Components React Dialog

Downloads

2,253

Readme

React Dialog

A React version of an MDC Dialog.

Installation

npm install @material/react-dialog

Usage

Styles

with Sass:

import '@material/react-dialog/index.scss';

with CSS:

import "@material/react-dialog/dist/dialog.css";

Javascript Instantiation

Basic Usage

Below is a basic example of a dialog. <MyDialogContent /> is not defined, but can be any element.

import React, {Component} from 'react';
import Dialog, {
  DialogTitle,
  DialogContent,
  DialogFooter,
  DialogButton,
} from '@material/react-dialog';

class MyApp extends Component {
  state = {isOpen: true};

  render() {
    return (
      <Dialog open={isOpen}>
        <DialogTitle>My Dialog</DialogTitle>
        <DialogContent>
          <MyDialogContent />
        </DialogContent>
        <DialogFooter>
          <DialogButton action='dismiss'>Dismiss</DialogButton>
          <DialogButton action='accept' isDefault>Accept</DialogButton>
        </DialogFooter>
      </Dialog>
    );
  }
}

NOTE: Titles cannot contain leading whitespace due to how mdc-typography-baseline-top() works.

Variants

Alert Dialog

The Alert Dialog interrupt users with urgent information, details, or actions.

import React, {Component} from 'react';
import Dialog, {
  DialogContent,
  DialogFooter,
  DialogButton,
} from '@material/react-dialog';

class Alert extends Component {
  state = {isOpen: true, action: ''};

  render() {
    return (
      <Dialog
        onClose={(action: string) => this.setState({isOpen: false, action})}
        open={this.state.isOpen}>
        <DialogContent>
          <p>Discard Draft?</p>
        </DialogContent>
        <DialogFooter>
          <DialogButton action='dismiss'>Cancel</DialogButton>
          <DialogButton action='discard' isDefault>Discard</DialogButton>
        </DialogFooter>
      </Dialog>
    );
  }
}

Simple Dialog

The Simple Dialog contains a list of potential actions. It does not contain buttons.

import React, {Component} from 'react';
import Dialog, {DialogTitle, DialogContent} from '@material/react-dialog';
import List, {ListItem, ListItemGraphic, ListItemText} from '@material/react-list';
import MaterialIcon from '@material/react-material-icon';

class Simple extends Component {
  state = {
    isOpen: true
    choices: ['[email protected]', '[email protected]', 'Add Account']
    action: ''
  };

  render() {
    return (
      <Dialog 
        open={isOpen} 
        onClose={(action) => this.setState({action, isOpen: false})}>
        <DialogTitle>Select User</DialogTitle>
        <DialogContent>
            <List avatarList>
              {choices.map((choice, i) => (
                <ListItem key={i} data-mdc-dialog-action={choice}>
                  <ListItemGraphic graphic={
                    <MaterialIcon icon={choice.match(/@/) ? 'person' : 'add'}/>
                  }/>
                  <ListItemText primaryText={choice}/>
                </ListItem>
              ))
              }
            </List>
        </DialogContent>
      </Dialog>
    );
  }
}

NOTES: (1) the inclusion of the avatarList, which aligns with the Simple Dialog spec. (2) the data-mdc-dialog-action which singals the chosen action onClose()

Confirmation Dialog

The Confirmation Dialog contains a list of choices, and buttons to confirm or cancel. Choices are accompanied by radio buttons (indicating single selection) or checkboxes (indicating multiple selection).

import React, {Component} from 'react';
import Dialog, {
  DialogTitle,
  DialogContent,
  DialogFooter,
  DialogButton,
} from '@material/react-dialog';
import List, {ListItem, ListItemText} from '@material/react-list';
import Radio, {NativeRadioControl} from '@material/react-radio';


class Confirmation extends Component
  state = {
    isOpen: false, 
    action: '', 
    selectedIndex: -1,
    choices: ['Never gonna give you up', 'Host cross buns', 'None'];
   };

  isChecked = (i) => i === this.state.selectedIndex;

  render() {
    return (
      <Dialog
        onClose={(action) => this.setState({isOpen: false, action})}
        open={this.state.isOpen}>
        <DialogTitle>Chose a Phone Ringtone</DialogTitle>
        <DialogContent>
          <List 
            singleSelection 
            handleSelect={ (selectedIndex) => this.setState({selectedIndex})}
          >{choices.map((choice, i) => {
              let cleanChoice = choice.replace(/\s/g, '-');
              return (
                <ListItem key={i}>
                  <!-- Note: <ListItemGraphic/> will not work here -->
                  <span className='mdc-list-item__graphic'>
                    <Radio>
                      <NativeRadioControl
                        name='ringtone'
                        value={choice}
                        id={cleanChoice}
                        checked={this.isChecked(i)}
                        onChange={() => {}}
                      />
                    </Radio>
                  </span>
                  <label htmlFor={cleanChoice}>
                    <ListItemText primaryText={choice}/>
                </label>
                </ListItem>
              );
            })}
          </List>
        </DialogContent>
        <DialogFooter>
          <DialogButton action='dismiss'>Cancel</DialogButton>
          <DialogButton action='confirm' isDefault>Ok</DialogButton>
        </DialogFooter>
      </Dialog>
    );
  }
}

Props

Dialog

Prop Name | Type | Description | Default --- | --- | --- | --- autoStackButtons | Boolean | reverses the buttons when applying the stacked layout. | true className | String | classes to applied to the root element | n/a children | Node | ReactElement to render in the dialog only available children are DialogTitle,DialogContent, or DialogFooter. | n/a escapeKeyAction | String | the action reflected when the Escape key is pressed. Setting to '' disables closing via the escape key | close id | String | the id attribute placed on the root element | mdc-dialog onClose | Function (action) => void | Callback after the dialog has closed. | n/a onClosing | Function (action) => void | Callback for when the dialog begins to close. | () => {} onOpen | Function () => void | Callback after the dialog has opened | n/a onOpening | Function () => void | Callback for when the dialog begins to open. | () => {} open | Boolean | If true opens the dialog. If false closes the dialog | false role | String | ARIA attribute that specifies the role of dialog. Must be alertdialog or dialog | alertdialog scrimClickAction | String | the action reflected when the scrim is clicked. Setting to '' disables closing via scrim click| close tag | String | Customizes the Dialog tag type. | div

DialogTitle

Prop Name | Type | Description --- | --- | --- className | String | the classes applied to the root element of DialogTitle id | String | the id attribute placed on the root element. tag | String | customizes the DialogTitle tag type. (defaults: h2)

NOTE: that id is also set to aria-labelledby on the <Dialog/> element . Additionally, if unset will default to the id of <Dialog/> with the suffix -title.

DialogContent

Prop Name | Type | Description --- | --- | --- className | String | the classes applied to the root element of DialogContent id | String | the id attribute placed on the root element. tag | String | customizes the DialogContent tag type. (defaults: div)

NOTE: that id value is also set to aria-describedby on the <Dialog/> element. Additionally, if unset will default the to id of <Dialog/> with the suffix -content.

DialogFooter

Prop Name | Type | Description --- | --- | --- className | String | the classes applied to the root element of DialogContent tag | String | customizes the DialogFooter tag type. (defaults: footer)

DialogButton

Prop Name | Type | Description --- | --- | --- action | String | required action of the button. Returned onClose && onClosing in <Dialog/> className | String | the classes applied to the root element of DialogButton isDefault | Boolean | represents the default action, triggered by pressing the Enter key (defaults: false)

Sass Mixins

Sass mixins may be available to customize various aspects of the Components. Please refer to the MDC Web repository for more information on what mixins are available, and how to use them.

Advanced Sass Mixins