Chakra UI is a powerful component library for React that is designed and developed by Segun Adebayo to build front-end applications. The Chakra UI comes with simple yet easy-to-understand documentation that gives us guidelines on how to build a reusable component. In this article, we will learn about the useDisclosure hook in React and, why it is used, and learn its implementation with the help of examples.
Pre-requisites:
useDisclosure hook in React.
The Chakra UI useDisclosure is a hook that is commonly used to handle cases like open, close, and toggle click events for similar components like Modal, Drawer, Popovers, and Alert Dialog boxes. It also manages the boolean states of any event. It handles the showing and hiding of some content.
Features of useDisclosure hook:
1. Accessibility: Chakra UI puts a strong focus on accessibility. It ensures that the component is fully accessible to users who rely on assistive technologies, meeting the required accessibility standards.
2. Customization: With the Disclosure component, you have a wide range of customization options. Customization options include tweaking the trigger element, defining animation effects, and applying custom styling.
3. Controlled and Uncontrolled Modes: Chakra UI offers support for both controlled and uncontrolled modes with the Disclosure component. In the controlled mode, developers retain complete control over the open/closed state of the disclosure panels. On the other hand, in the uncontrolled mode, the component autonomously handles its state internally, providing a more hands-off approach.
Reason to choose useDisclosure hook
It gives good control to open-close behavior for modals, tooltips, etc. It is simple to use and access for creating acustom user interface with togglable panels to show and hide important content.
Importing useDisclosure hook:
To import the useDisclosure hook, write the following code at the top level of your component.
import { useDisclosure } from '@chakra-ui/react'This method returns an object with the "isOpen" boolean field and the following callback functions
- onClose
- onOpen
- onToggle
- getDisclosureProps
- getButtonProps
Note: The user can use a combination of the values and methods returned by the useDisclosure hook for controlling various components affected by the hook.
Steps to Create React Application And Installing Module:
Step 1: Create a React application using the following command:
npx create-react-app chakra-disclosure-app
Step 2: After creating your project folder(i.e. my-app), move to it by using the following command:
cd chakra-disclosure-app
Step 3: After creating the React application, Install the required package using the following command:
npm i @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6
Project Structure:
The updated dependencies in package.json file will look like:
"dependencies": {
"@chakra-ui/react": "^2.8.2",
"@emotion/react": "^11.11.3",
"@emotion/styled": "^11.11.0",
"framer-motion": "^6.5.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
}Example 1: Write down the code in respective files. This will demonstrate a button which will toggle the text when the user clicks the button. The getDisclosureProps() and getButtonProps() methods provides the handler and attributes for accessibility by various UI components for the required action.
JavaScript
//App.js
import { ChakraProvider, Text,Box} from "@chakra-ui/react";
import React,{ useState } from 'react';
import Basic from "./Basic";
import "./App.css";
function App() {
return (
<ChakraProvider>
<Text
color="#2F8D46"
fontSize="2rem"
textAlign="center"
fontWeight="600"
my="1rem"
>
GeeksforGeeks - ReactJS Chakra UI concepts
</Text>
<Basic />
</ChakraProvider>
);
}
export default App;
//Basic.js
import {
useDisclosure, Button, extendTheme,
Text
} from '@chakra-ui/react'
function Basic() {
const { getDisclosureProps, getButtonProps, } = useDisclosure()
const btnProps = getButtonProps()
const disclosProps = getDisclosureProps()
return (
<>
<Button {...btnProps}>Toggle Text</Button>
<Text {...disclosProps} mt={4}>
This text will show and hide itself..
</Text>
</>
)
}
export default Basic;
Step to run the application: Run the application using the following command:
npm run start
Output: Now go to http://localhost:3000 in your browser:
Example 2: The following code will demonstrate using a Modal Dialog using the fields returned by the hook. Similar steps are followed as mentioned in the above example 1. Just change the above "Basic.js" file code with the following and run the program.
JavaScript
//Basic.js
import {
useDisclosure, useModalContext,
Button, extendTheme,
Modal, ModalContent,
ModalHeader, ModalOverlay,
ModalFooter, Box,
ModalBody, ModalCloseButton,
} from '@chakra-ui/react'
function Basic() {
const { isOpen, onOpen, onClose,
} = useDisclosure()
return (
<>
<Box bg="lightgrey" w="100%" h="100%" p={4}>
<Button onClick={onOpen}>Open Modal</Button>
<Modal isOpen={isOpen} onClose={onClose}>
<ModalOverlay />
<ModalContent>
<ModalHeader>GeeksforGeeks</ModalHeader>
<ModalCloseButton />
<ModalBody>
It is a dialog box/popup window that is
displayed on top of the current page.
</ModalBody>
<ModalFooter>
<Button colorScheme='green' mr={3} onClick={onClose}>
Close
</Button>
</ModalFooter>
</ModalContent>
</Modal>
</Box>
</>
);
};
export default Basic;
Output:
Example 3: The following code will demonstrate using a Alert Dialog box which seems to be a mandatory message for the user. The alert dialog uses the fields returned by the hook. AlertDialog requires that you provide the leastDestructiveRef prop. Change the "Basic.js" file code with the following.
JavaScript
//Basic.js
import { useRef } from 'react';
import {
useDisclosure,Button,extendTheme,
Text,AlertDialog,Box,
AlertDialogBody,
AlertDialogFooter,
AlertDialogHeader,
AlertDialogContent,
AlertDialogOverlay,
AlertDialogCloseButton,
} from '@chakra-ui/react'
function Basic() {
const { isOpen, onOpen, onClose} = useDisclosure()
const cancelRefer = useRef()
return (
<>
<Box ml='5' bg="lightgrey" w="100%" h="100%" p={4}>
<Button onClick={onOpen}>
Open Demo Alert Dialog
</Button>
<AlertDialog
isOpen={isOpen}
leastDestructiveRef={cancelRefer} onClose={onClose}
>
<AlertDialogOverlay>
<AlertDialogContent>
<AlertDialogHeader fontSize='md' fontWeight='bold'>
Chakra UI Alert Dialogs
</AlertDialogHeader>
<AlertDialogBody>
Hello, I am good , hope the same from you
</AlertDialogBody>
<AlertDialogFooter>
<Button ref={cancelRefer} onClick={onClose}>
Cancel
</Button>
<Button colorScheme='pink' onClick={onClose} ml={3}>
Delete
</Button>
</AlertDialogFooter>
</AlertDialogContent>
</AlertDialogOverlay>
</AlertDialog>
</Box>
</>
)
}
export default Basic;
Output:
Example 4: The following code will demonstrate using a Drawer component showing a panel sliding from the edge of the screen. Just change the "Basic.js" file with the following code and run the program
JavaScript
import { useRef } from 'react';
import {
useDisclosure, Button, extendTheme,
Text, Box, Input,
Drawer,
DrawerBody,
DrawerFooter,
DrawerHeader,
DrawerOverlay,
DrawerContent,
DrawerCloseButton
} from '@chakra-ui/react'
function Basic() {
const { isOpen, onOpen, onClose } = useDisclosure()
const btnRefer = useRef()
return (
<>
<Box ml='5' bg="lightgrey" w="100%" h="100%" p={4}>
<Button ref={btnRefer} colorScheme='green' onClick={onOpen}>
Open Drawer
</Button>
<Drawer isOpen={isOpen} placement='left'
onClose={onClose} finalFocusRef={btnRefer}
>
<DrawerOverlay />
<DrawerContent>
<DrawerCloseButton />
<DrawerHeader>My Account</DrawerHeader>
<DrawerBody>
<Input placeholder='Enter...' />
</DrawerBody>
<DrawerFooter>
<Button mr={3} onClick={onClose}>
Logout
</Button>
<Button colorScheme='lightblue'>Save</Button>
</DrawerFooter>
</DrawerContent>
</Drawer>
</Box>
</>
)
}
export default Basic;
Output:
Similar Reads
React Tutorial React is a powerful JavaScript library for building fast, scalable front-end applications. Created by Facebook, it's known for its component-based structure, single-page applications (SPAs), and virtual DOM,enabling efficient UI updates and a seamless user experience.Note: The latest stable version
7 min read
React Fundamentals
React IntroductionReactJS is a component-based JavaScript library used to build dynamic and interactive user interfaces. It simplifies the creation of single-page applications (SPAs) with a focus on performance and maintainability.React.jsWhy Use React?Before React, web development faced issues like slow DOM updates
7 min read
React Environment SetupTo run any React application, we need to first setup a ReactJS Development Environment. In this article, we will show you a step-by-step guide to installing and configuring a working React development environment.Pre-requisite:We must have Nodejs installed on our PC. So, the very first step will be
3 min read
React JS ReactDOMReactDom is a core react package that provides methods to interact with the Document Object Model or DOM. This package allows developers to access and modify the DOM. Let's see in brief what is the need to have the package. Table of ContentWhat is ReactDOM ?How to use ReactDOM ?Why ReactDOM is used
3 min read
React JSXJSX stands for JavaScript XML, and it is a special syntax used in React to simplify building user interfaces. JSX allows you to write HTML-like code directly inside JavaScript, enabling you to create UI components more efficiently. Although JSX looks like regular HTML, it’s actually a syntax extensi
5 min read
ReactJS Rendering ElementsIn this article we will learn about rendering elements in ReactJS, updating the rendered elements and will also discuss about how efficiently the elements are rendered.What are React Elements?React elements are the smallest building blocks of a React application. They are different from DOM elements
3 min read
React ListsReact Lists are used to display a collection of similar data items like an array of objects and menu items. It allows us to dynamically render the array elements and display repetitive data.Rendering List in ReactTo render a list in React, we will use the JavaScript array map() function. We will ite
5 min read
React FormsForms are an essential part of any application used for collecting user data, processing payments, or handling authentication. React Forms are the components used to collect and manage the user inputs. These components include the input elements like text field, check box, date input, dropdowns etc.
5 min read
ReactJS KeysA key serves as a unique identifier in React, helping to track which items in a list have changed, been updated, or removed. It is particularly useful when dynamically creating components or when users modify the list. In this article, we'll explore ReactJS keys, understand their importance, how the
5 min read
Components in React
React ComponentsIn React, React components are independent, reusable building blocks in a React application that define what gets displayed on the UI. They accept inputs called props and return React elements describing the UI.In this article, we will explore the basics of React components, props, state, and render
4 min read
ReactJS Functional ComponentsIn ReactJS, functional components are a core part of building user interfaces. They are simple, lightweight, and powerful tools for rendering UI and handling logic. Functional components can accept props as input and return JSX that describes what the component should render.What are Reactjs Functio
5 min read
React Class ComponentsClass components are ES6 classes that extend React.Component. They allow state management and lifecycle methods for complex UI logic.Used for stateful components before Hooks.Support lifecycle methods for mounting, updating, and unmounting.The render() method in React class components returns JSX el
4 min read
ReactJS Pure ComponentsReactJS Pure Components are similar to regular class components but with a key optimization. They skip re-renders when the props and state remain the same. While class components are still supported in React, it's generally recommended to use functional components with hooks in new code for better p
4 min read
ReactJS Container and Presentational Pattern in ComponentsIn this article we will categorise the react components in two types depending on the pattern in which they are written in application and will learn briefly about these two categories. We will also discuss about alternatives to this pattern. Presentational and Container ComponentsThe type of compon
2 min read
ReactJS PropTypesIn ReactJS PropTypes are the property that is mainly shared between the parent components to the child components. It is used to solve the type validation problem. Since in the latest version of the React 19, PropeTypes has been removed. What is ReactJS PropTypes?PropTypes is a tool in React that he
5 min read
React Lifecycle In React, the lifecycle refers to the various stages a component goes through. These stages allow developers to run specific code at key moments, such as when the component is created, updated, or removed. By understanding the React lifecycle, you can better manage resources, side effects, and perfo
7 min read
React Hooks
Routing in React
Advanced React Concepts
React Projects