react-toolbox/components/dialog
Keren Chandran cdd6ee5f05 Merge branch 'dev' of https://github.com/react-toolbox/react-toolbox into update-docs
# Conflicts:
#	components/autocomplete/readme.md
#	components/dropdown/readme.md
2016-04-06 20:50:12 -04:00
..
Dialog.jsx Don't show actions container in dialog if no actions exist 2016-04-02 00:28:48 +02:00
_config.scss Added !default to all config values as per #424 2016-04-02 00:47:39 +02:00
index.js Remove jsx extension from imports in components 2015-11-28 20:24:46 +01:00
readme.md Updated Dialog Example and sorted properties. 2016-03-25 10:11:13 -04:00
style.scss Use new Overlay component in dialogs and dependencies 2015-11-14 21:51:33 +01:00

readme.md

Dialog

Dialogs contain text and UI controls focused on a specific task. They inform users about critical information, require users to make decisions, or involve multiple tasks. You would need an additional component to take actions and display or hide the dialog.

import Dialog from 'react-toolbox/lib/dialog';

class DialogTest extends React.Component {
  state = { 
    active: false 
  };

  handleToggle = () => {
    this.setState({active: !this.state.active});
  }

  actions = [
    { label: "Cancel", onClick: this.handleToggle },
    { label: "Save", onClick: this.handleToggle }
  ];

  render () {
    return (
      <div>
        <Button label='Show my dialog' onClick={this.handleToggle} />
        <Dialog
          actions={this.actions}
          active={this.state.active}
          onEscKeyDown={this.handleToggle}
          onOverlayClick={this.handleToggle}
          title='My awesome dialog'
        >
          <p>Here you can add arbitrary content. Components like Pickers are using dialogs now.</p>
        </Dialog>
      </div>
    );
  }
}

Properties

Name Type Default Description
actions Array [] A array of objects representing the buttons for the dialog navigation area. The properties will be transferred to the buttons.
active Boolean false If true, the dialog will be active.
className String '' Sets a class to give customized styles to the dialog.
onEscKeyDown Function Callback called when the ESC key is pressed with the overlay active.
onOverlayClick Function Callback to be invoked when the dialog overlay is clicked.
onOverlayMouseDown Function Callback called when the mouse button is pressed on the overlay.
onOverlayMouseMove Function Callback called when the mouse is moving over the overlay.
onOverlayMouseUp Function Callback called when the mouse button is released over the overlay.
title String The text string to use as standar title of the dialog.
type String normal Used to determine the size of the dialog. It can be small, normal or large.