Skip to content
Related Articles
Open in App
Not now

Related Articles

React Suite Modal Accessibility Keyboard Interaction

Improve Article
Save Article
  • Last Updated : 17 Jul, 2022
Improve Article
Save Article

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 Accessibility Keyboard Interaction. The keyboard prop is used to interact with the keyboard which closes the modal using the ‘Esc’ key.

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.

Modal.Header Props:

  • as: It is used to add a custom element for this component.
  • classPrefix: It denotes the prefix of the component CSS class.
  • closeButton: It displays the close button.
  • onHide: It is a callback function that is triggered when Modal is hidden.

Modal.Title Props:

  • as: It is used to add a custom element for this component.
  • classPrefix: It denotes the prefix of the component CSS class.

Modal.Footer Props:

  • as: It is used to add a custom element for this component.
  • classPrefix: It denotes the prefix of the component CSS class.

Modal.Body Props:

  • as: It is used to add a custom element for this component.
  • classPrefix: It denotes the prefix of the component CSS class.

Syntax:

import { Modal } from "rsuite";

export default function App() {
    return (
        <Modal keyboard={false}>
            ...
        </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 modal when the keyboard is set to ‘false’.

Note: In the given example, the modal is closed using the close button and not using the ‘Esc’ key.

Javascript




import { useState } from "react";
import { Button, Modal } from "rsuite";
import "rsuite/dist/rsuite.min.css";
  
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 Accessibility 
                    Keyboard Interaction
                </h4>
  
                <div style={{ marginTop: 20, width: 400 }}>
                    <div className="modal-container">
                        <Button onClick={handleOpen} 
                            appearance="primary" color="green">
                            Open
                        </Button>
  
                        <Modal open={open} onClose={handleClose} 
                            keyboard={false}>
                            <Modal.Header>
                                <Modal.Title>GeeksforGeeks</Modal.Title>
                            </Modal.Header>
                            <Modal.Body>
                                <div>
                                    <h3>You can't close this Modal 
                                        using ESC key.</h3>
                                </div>
                            </Modal.Body>
                            <Modal.Footer>
                                <Button
                                    onClick={handleClose}
                                    appearance="primary"
                                    color="green"
                                >
                                    Ok
                                </Button>
                                <Button onClick={handleClose} 
                                    appearance="subtle">
                                    Cancel
                                </Button>
                            </Modal.Footer>
                        </Modal>
                    </div>
                </div>
            </div>
        </center>
    );
}


Steps to run the application: Write the below code in the terminal to run the server:

node index.js

Output:

 

Example 2: Below example demonstrates the modal when the keyboard is set to ‘true’.

Note: In the given example, the modal is closed using the ‘Esc’ key.

Javascript




import { useState } from "react";
import { Button, Modal } from "rsuite";
import "rsuite/dist/rsuite.min.css";
  
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 Accessibility 
                    Keyboard Interaction
                </h4>
  
                <div style={{ marginTop: 20, width: 400 }}>
                    <div className="modal-container">
                        <Button onClick={handleOpen} 
                            appearance="primary" color="green">
                            Open
                        </Button>
  
                        <Modal open={open} onClose={handleClose} 
                            keyboard={true}>
                            <Modal.Header>
                                <Modal.Title>GeeksforGeeks</Modal.Title>
                            </Modal.Header>
                            <Modal.Body>
                                <div>
                                    <h3>You can close this Modal 
                                        using ESC key.</h3>
                                </div>
                            </Modal.Body>
                            <Modal.Footer>
                                <Button
                                    onClick={handleClose}
                                    appearance="primary"
                                    color="green"
                                >
                                    Ok
                                </Button>
                                <Button onClick={handleClose} 
                                appearance="subtle">
                                    Cancel
                                </Button>
                            </Modal.Footer>
                        </Modal>
                    </div>
                </div>
            </div>
        </center>
    );
}


Output:

 

Reference: https://rsuitejs.com/components/modal/#keyboard-interaction


My Personal Notes arrow_drop_up
Related Articles

Start Your Coding Journey Now!