{"id":3760,"date":"2021-07-14T15:34:12","date_gmt":"2021-07-14T15:34:12","guid":{"rendered":"https:\/\/ionicframework.com\/blog\/?p=3760"},"modified":"2021-07-15T01:51:19","modified_gmt":"2021-07-15T01:51:19","slug":"introducing-the-new-overlay-hooks-for-ionic-react","status":"publish","type":"post","link":"https:\/\/ionic.io\/blog\/introducing-the-new-overlay-hooks-for-ionic-react","title":{"rendered":"Introducing the New Overlay Hooks for Ionic React"},"content":{"rendered":"

Hello Friends! We know everyone is excited about the new features in Ionic Framework 6.0 beta, but that doesn’t mean we’re done with V5! In Ionic React 5.6, we packaged up a new set of hooks for controlling our overlay components that we think you might like. What is an overlay you ask? It\u2019s the term we give components that display over your current content, such as alerts, modals, toasts, etc.<\/p>\n

In this post, I\u2019m going to go over how to use the new hooks to display these components in your apps. But first, let’s do a quick recap on how overlays worked before, and some of the challenges that you might encounter with them.<\/p>\n

<\/p>\n

Overlay Components<\/h2>\n

Each of the overlays has a React component that is exported from @ionic\/react<\/code>, such as IonAlert<\/code> and IonLoading<\/code>. These components take a prop called isOpen<\/code>, which determines if the overlay should be displayed or not:<\/p>\n

<IonAlert\n  isOpen={showAlert}\n\/>\n<\/code><\/pre>\n
These components are great and they aren\u2019t going away. The new hooks don’t deprecate them in any way. However, there’s some ceremony you have to observe to use them.<\/p>\n
First, managing the state that handles the isOpen<\/code> prop could be a challenge. If the state was contained in the component that the overlay was in, then it was no problem (like a local state variable from useState<\/code>). However, if the action to display the overlays was in a different part of the app, then you needed to use some state management technique or library to pass the isOpen<\/code> prop along.<\/p>\n
Second, each of the Overlay components required you to provide an onDidDismiss<\/code> callback that would flip the isOpen<\/code> prop back to false in case the overlay dismissed itself somehow. Not overriding it would cause isOpen<\/code> to stay true, and if your app tried to show the overlay again, then you would be setting true to true, and Ionic wouldn\u2019t detect the change and, thus, wouldn’t display it again.<\/p>\n
<IonAlert\n  isOpen={showAlert}\n  message='Hello there friend'\n  onDidDismiss={() => setShowAlert(false)}\n\/>\n<\/code><\/pre>\n
A third challenge was that it was difficult to display an overlay from outside of your component; for instance, if you wanted to display an alert when an API request failed. Ionic Angular had controller instances you could import to use in services to display overlays. In React, this was more difficult to do.<\/p>\n
The new overlay hooks in Ionic React 5.6 help with all these scenarios.<\/p>\n
Overlay Hooks<\/h2>\n
The goal of the overlay hooks was to reduce this process and to make the usage of the overlays feel more natural for those writing functional React components.<\/p>\n
To get started with the hooks, you import the hook for the overlay you want to use from @ionic\/react<\/code> like so:<\/p>\n
import { useIonAlert } from '@ionic\/react'\n<\/code><\/pre>\n
Next, in your functional component, you call the hook to get back the show and hide methods, which get returned in an array similar to how useState<\/code> returns its members. We choose the array method of destructuring so naming the methods is easier:<\/p>\n
const [showAlert, hideAlert] = useIonAlert();\n<\/code><\/pre>\n
\n  Most overlays dismiss themselves when the user is done interacting with them, so you won\u2019t need the hide method for most scenarios.\n<\/p><\/blockquote>\n
Then to display the overlay, you call the show method:<\/p>\n
showAlert('Hello!');\n<\/code><\/pre>\n
\"\"
The alert will dismiss itself after the user clicks the “Ok” button. You don\u2019t need to worry about doing any additional work when the overlays go away.<\/p>\n
Most of the overlay hooks have options that you can pass to them. The more common options can be passed in as additional parameters. For instance, the toast overlay’s show method also takes the time to display the toast as its second parameter:<\/p>\n
showToast('Hello from a toast!',  3000);\n<\/code><\/pre>\n
This will display the toast for three seconds, and then the toast will dismiss itself.<\/p>\n
More options can be sent by passing in an object instead of the separate parameters:<\/p>\n
showToast({\n  buttons: [{ text: 'hide', handler: () => hideToast() }],\n  message: 'Hello, click hide to dismiss',\n  onDidDismiss: () => console.log('dismissed')              \n})\n<\/code><\/pre>\n
React hooks can be used in other hooks as well. Because of this, it’s possible to display an overlay from within other hooks, such as one responsible for fetching some data. Here is a sample custom hook to fetch a customer that displays a toast when the request fails:<\/p>\n
const useCustomer = (customerId: number) => {\n  const [customer, setCustomer] = useState<Customer>();\n  const [showToast] = useIonToast();\n  useEffect(() => {\n    fetchCustomer();\n    async function fetchCustomer() {\n      try {\n        const response = fetch(`myapi.com\/customers\/${customerId}`);\n        const data = await (await response).json();\n        setCustomer(data);\n      } catch {\n        showToast({\n          message: 'Oops, unable to get customer',\n          color: 'warning',\n          buttons: [{ icon: close }],\n        });\n      }\n    }\n  }, [customerId, showToast]);\n  return customer;\n};\n<\/code><\/pre>\n
More Info<\/h2>\n
To learn more about the new hooks, visit our guide on using overlays in Ionic React<\/a>, and check out the docs for each of the overlay components for usage examples:<\/p>\n