Open In App

React Suite Modal Props

Improve
Improve
Like Article
Like
Save
Share
Report

React Suite is a library of React components, sensible UI design, and a friendly development experience. It is supported in all major browsers. It provides pre-built components of React which can be used easily in any web application.

In this article, we’ll learn about React Suite Modal Props. The modal can be different sizes which include extra-small, small, medium, large, and full page. The different modal props are discussed below.

Modal Props:

  • autoFocus: The Modal is opened and is automatically focused on its own when this is set to true.
  • backdrop: The Modal will display the background in its opened state when this is set to true.
  • backdropClassName: It is used to add an optional extra class name to .modal-backdrop.
  • classPrefix: It denotes the prefix of the component CSS class.
  • dialogClassName: It is used for the CSS class applied to Dialog DOM nodes.
  • enforceFocus: The Modal will prevent the focus from leaving when opened when this is set to true. 
  • keyboard: It closes a modal when the ESC key is pressed.
  • onClose: It is a callback function fired when Modal hides.
  • onEnter: It is a callback function that is triggered before the Modal transitions in.
  • onEntered: It is a callback function that is triggered after the Modal finishes transitioning in.
  • onEntering: It is a callback function that is triggered as the Modal begins to transition in.
  • onExit: It is a callback function that is triggered right before the Modal transitions out.
  • onExited: It is a callback function that is triggered after the Modal finishes transitioning out.
  • onExiting: It is a callback function that is triggered as the Modal begins to transition out.
  • onOpen: It is a callback function that is triggered when Modal displays.
  • overflow: It automatically sets the height when the body content is too long.
  • size: It sets the Modal size.

Syntax:

<Modal size="xs" open={open} 
       onClose={handleClose} 
       onEntered={handleEntered}>
  ...
</Modal>

Creating React Application And Installing Module:

Step 1: Create a React application using the given command:

npm create-react-app projectname

Step 2: After creating your project, move to it using the given command:

cd projectname

Step 3: Now Install the rsuite node package using the given command:

npm install rsuite

Project Structure: Now your project structure should look like the following:

 

Example 1: Below example demonstrates the open, onClose, size, and autofocus props of modal.

Javascript




import "rsuite/dist/rsuite.min.css";
import { Button, Modal } from "rsuite";
import { useState } from "react";
  
export default function App() {
    const [open, setOpen] = useState(false);
    const handleOpen = () => setOpen(true);
    const handleClose = () => setOpen(false);
  
    return (
        <center>
            <div>
                <h2>GeeksforGeeks</h2>
                <h4 style={{ color: "green" }}>
                    React Suite Modal Props
                </h4>
  
                <div style={{ marginTop: 20, width: 340 }}>
                    <Button onClick={handleOpen}>
                        Open
                    </Button>
                    <Modal open={open} 
                           onClose={handleClose} 
                           size="md" autoFocus>
                        <Modal.Header>
                            GeeksforGeeks
                        </Modal.Header>
                        <Modal.Body>
                            <p>
                              Welcome to GeeksforGeeks. Find all 
                              computer science content at one place.
                            </p>
                        </Modal.Body>
                        <Modal.Footer>
                            <Button onClick={handleClose} 
                                    appearance="primary">
                                Ok
                            </Button>
                            <Button onClick={handleClose} 
                                    appearance="subtle">
                                Close
                            </Button>
                        </Modal.Footer>
                    </Modal>
                </div>
            </div>
        </center>
    );
}


Output:

 

Example 2: Below example demonstrates the backdrop and role props of the modal.

Javascript




import "rsuite/dist/rsuite.min.css";
import { Button, Modal } from "rsuite";
import { useState } from "react";
  
export default function App() {
    const [open, setOpen] = useState(false);
    const handleOpen = () => setOpen(true);
    const handleClose = () => setOpen(false);
  
    return (
        <center>
            <div>
                <h2>GeeksforGeeks</h2>
                <h4 style={{ color: "green" }}>
                    React Suite Modal Props
                </h4>
  
                <div style={{ marginTop: 20, width: 340 }}>
                    <Button onClick={handleOpen}>
                        Open
                    </Button>
                    <Modal open={open} onClose={handleClose} 
                           size="md" backdrop={false
                           role="alertdialog">
                        <Modal.Header>
                            GeeksforGeeks
                        </Modal.Header>
                        <Modal.Body>
                            <p>
                              Hi! Welcome to Computer 
                              Science portal.
                            </p>
                        </Modal.Body>
                        <Modal.Footer>
                            <Button onClick={handleClose} 
                                    appearance="primary">
                                Ok
                            </Button>
                            <Button onClick={handleClose} 
                                    appearance="subtle">
                                Cancel
                            </Button>
                        </Modal.Footer>
                    </Modal>
                </div>
            </div>
        </center>
    );
}


Output:

 

Reference: https://rsuitejs.com/components/modal/#props



Last Updated : 05 Jul, 2022
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads