@pingux/astro 2.9.2 → 2.13.0-alpha.3

package/lib/components/Tabs/Tabs.mdx

@@ -0,0 +1,40 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/Tabs/Tabs" />
+
+# Tabs
+
+The Tabs component is used to divide content and navigate to other views within the same page. 
+
+Tabs should:
+- Have only one active tab at a time.
+- Group similar content under each tab.
+
+Tabs shouldn’t be used as the primary method of navigation or for sequential content.
+
+### Required Components
+
+This component requires the Tab component.
+
+### Accessibility
+
+This component should adhere to the [WAI-ARIA Tabs](https://www.w3.org/WAI/ARIA/apg/patterns/tabs/) accessibility guidelines. 
+
+#### Keyboard Navigation
+
+These keys provide additional functionality to the component. 
+
+| Keys | Function |
+| ---- | ---- |
+| Tab | The field is focusable using the Tab key and follows the page tab sequence. |
+| Arrow keys | When a tab is focused, tabs can be navigated using the left and right arrow keys. |
+| Shift + Tab | Moves focus to the previous focusable component.  |
+| Home(Fn + Right Arrow Key) Or Control/Command + Home| Shifts the focus to the first tab. |
+| End(Fn + Left Arrow Key) Or Control/Command + End | Shifts the focus to the last tab. |
+
+#### Screen Readers
+
+This component uses the following attributes to assist screen readers:
+- The **`aria-orientation`** attribute indicates whether the orientation is horizontal, vertical, unknown, or ambiguous. 
+- Each tab uses the **`aria-selected`** attribute to indicate the selection status, and the **`aria-control`** attribute is supplied with the associated panel ID that displays the content.
+- Each tab uses the **`aria-labelledby`** with the label ID to reference it.

package/lib/components/Text/Text.js

@@ -1,17 +1,16 @@
 import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
 import _styled from "@emotion/styled/base";
 import React from 'react';
-import PropTypes from 'prop-types';
 import { flexbox, layout, typography } from 'styled-system';
 import { Text as ThemeUIText } from 'theme-ui';
 import { textVariants } from '../../utils/devUtils/constants/variants';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 var ExtendedText = /*#__PURE__*/_styled(ThemeUIText, process.env.NODE_ENV === "production" ? {
-  target: "eifd86o0"
+  target: "etvnvar0"
 } : {
-  target: "eifd86o0",
+  target: "etvnvar0",
   label: "ExtendedText"
-})(layout, flexbox, typography, process.env.NODE_ENV === "production" ? "" : "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL1RleHQvVGV4dC5qcyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFRcUIiLCJmaWxlIjoiLi4vLi4vLi4vc3JjL2NvbXBvbmVudHMvVGV4dC9UZXh0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFJlYWN0IGZyb20gJ3JlYWN0JztcbmltcG9ydCBzdHlsZWQgZnJvbSAnQGVtb3Rpb24vc3R5bGVkJztcbmltcG9ydCBQcm9wVHlwZXMgZnJvbSAncHJvcC10eXBlcyc7XG5pbXBvcnQgeyBmbGV4Ym94LCBsYXlvdXQsIHR5cG9ncmFwaHkgfSBmcm9tICdzdHlsZWQtc3lzdGVtJztcbmltcG9ydCB7IFRleHQgYXMgVGhlbWVVSVRleHQgfSBmcm9tICd0aGVtZS11aSc7XG5cbmltcG9ydCB7IHRleHRWYXJpYW50cyB9IGZyb20gJy4uLy4uL3V0aWxzL2RldlV0aWxzL2NvbnN0YW50cy92YXJpYW50cyc7XG5cbmNvbnN0IEV4dGVuZGVkVGV4dCA9IHN0eWxlZChUaGVtZVVJVGV4dCkobGF5b3V0LCBmbGV4Ym94LCB0eXBvZ3JhcGh5KTtcblxuY29uc3QgVGV4dCA9IFJlYWN0LmZvcndhcmRSZWYoKHByb3BzLCByZWYpID0+IChcbiAgPEV4dGVuZGVkVGV4dCB2YXJpYW50PVwiYmFzZVwiIHsuLi5wcm9wc30gcmVmPXtyZWZ9IC8+XG4pKTtcblxuVGV4dC5wcm9wVHlwZXMgPSB7XG4gIHZhcmlhbnQ6IFByb3BUeXBlcy5zdHJpbmcsXG59O1xuXG5cblRleHQuZGVmYXVsdFByb3BzID0ge1xuICB2YXJpYW50OiB0ZXh0VmFyaWFudHMuQkFTRSxcbn07XG5cblRleHQuZGlzcGxheU5hbWUgPSAnVGV4dCc7XG5cbmV4cG9ydCBkZWZhdWx0IFRleHQ7XG4iXX0= */");
+})(layout, flexbox, typography, process.env.NODE_ENV === "production" ? "" : "/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21wb25lbnRzL1RleHQvVGV4dC50c3giXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBUXFCIiwiZmlsZSI6Ii4uLy4uLy4uL3NyYy9jb21wb25lbnRzL1RleHQvVGV4dC50c3giLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgUmVhY3QgZnJvbSAncmVhY3QnO1xuaW1wb3J0IHN0eWxlZCBmcm9tICdAZW1vdGlvbi9zdHlsZWQnO1xuaW1wb3J0IHsgZmxleGJveCwgbGF5b3V0LCB0eXBvZ3JhcGh5IH0gZnJvbSAnc3R5bGVkLXN5c3RlbSc7XG5pbXBvcnQgeyBUZXh0IGFzIFRoZW1lVUlUZXh0IH0gZnJvbSAndGhlbWUtdWknO1xuXG5pbXBvcnQgeyBUZXh0UHJvcHMgfSBmcm9tICcuLi8uLi90eXBlcyc7XG5pbXBvcnQgeyB0ZXh0VmFyaWFudHMgfSBmcm9tICcuLi8uLi91dGlscy9kZXZVdGlscy9jb25zdGFudHMvdmFyaWFudHMnO1xuXG5jb25zdCBFeHRlbmRlZFRleHQgPSBzdHlsZWQoVGhlbWVVSVRleHQpKFxuICBsYXlvdXQsXG4gIGZsZXhib3gsXG4gIHR5cG9ncmFwaHksXG4pO1xuXG5jb25zdCBUZXh0ID0gUmVhY3QuZm9yd2FyZFJlZigocHJvcHM6IFRleHRQcm9wcywgcmVmOiBSZWFjdC5SZWY8SFRNTERpdkVsZW1lbnQ+KSA9PiAoXG4gIDxFeHRlbmRlZFRleHQgdmFyaWFudD1cImJhc2VcIiB7Li4ucHJvcHN9IHJlZj17cmVmfSAvPlxuKSk7XG5cblRleHQuZGVmYXVsdFByb3BzID0ge1xuICB2YXJpYW50OiB0ZXh0VmFyaWFudHMuQkFTRSxcbn07XG5cblRleHQuZGlzcGxheU5hbWUgPSAnVGV4dCc7XG5cbmV4cG9ydCBkZWZhdWx0IFRleHQ7XG4iXX0= */");
 var Text = /*#__PURE__*/React.forwardRef(function (props, ref) {
   return ___EmotionJSX(ExtendedText, _extends({
     variant: "base"
@@ -19,9 +18,6 @@ var Text = /*#__PURE__*/React.forwardRef(function (props, ref) {
     ref: ref
   }));
 });
-Text.propTypes = {
-  variant: PropTypes.string
-};
 Text.defaultProps = {
   variant: textVariants.BASE
 };

package/lib/components/Text/Text.mdx

@@ -0,0 +1,13 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/Text/Text" />
+
+# Text
+
+The Text component is used to display text and supports [Typography Props from Styled System](https://styled-system.com/table/#typography) from Styled System.
+
+Text should be adjusted in terms of font weight, size and formatting to emphasize hierarchy, and shouldn’t: rely only on color to convey importance.
+
+### Required Components
+
+This component can be used independently and does not require additional components.

package/lib/components/TextAreaField/TextAreaField.mdx

@@ -0,0 +1,34 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/TextAreaField/TextAreaField" />
+
+# TextAreaField
+
+The TextAreaField component combines a text area, label, and helper text for a resizable field, which is suitable for long plain-text input. 
+
+This field should:
+- Be used to accommodate varying amounts of text that can span multiple lines, such as a description, message, comments, or feedback.
+- Use the maxLength prop for character limitations.
+
+This field shouldn’t:
+- Be used when the character count fits in a single line. Use the [TextField](./?path=/docs/form-textfield--default) component instead.
+- Use quiet styles, such as a blended background with only a bottom border, for fixed height. Since it is taller and wider than most components, it might be harder to interact with it without visual cues.
+
+### Required components
+
+This component can be used independently and does not require additional components. 
+
+### Accessibility
+
+#### Keyboard Navigation
+
+These keys provide additional functionality to the component. 
+
+| Keys | Functions |
+| ---- | --------- |
+| Tab | The field is focusable using the Tab key and follows the page tab sequence. |
+| Shift + Tab | Moves focus to the previous focusable component. |
+
+#### Screen readers
+
+This component uses the **`aria-labelledby`** attribute pointing to the label, and the **`aria-invalid`** attribute to detect incorrect values or status errors, which is set to “False” by default.

package/lib/components/TextField/TextField.mdx

@@ -0,0 +1,34 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/TextField/TextField" />
+
+# TextField
+
+The component combines a text input, label, and helper text to enter, read or edit data.
+
+TextField should be used:
+- To enter no more than a single line of text.
+- To input unique information known only to the user and is difficult to predict with preset options.
+- When the data can be entered easily in a free format rather than using complex controls.
+- WithSlots props to insert extra UI elements.
+
+TextField shouldn’t be used to collect text longer than a single line. Use the [TextAreaField](./?path=/docs/form-textareafield--default) component instead.
+
+### Required components
+
+This component can be used independently and does not require additional components. 
+
+### Accessibility
+
+#### Keyboard Navigation
+
+These keys provide additional functionality to the component. 
+
+| Keys | Functions |
+| ---- | --------- |
+| Tab | The field is focusable using the Tab key and follows the page tab sequence. |
+| Shift + Tab | Moves focus to the previous focusable component. |
+
+#### Screen readers
+
+This component uses the **`aria-labelledby`** attribute pointing to the label, and the **`aria-invalid`** attribute to detect incorrect values or status errors, which is set to “False” by default.

package/lib/components/TimeZonePicker/TimeZonePicker.mdx

@@ -0,0 +1,18 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/TimeZonePicker/TimeZonePicker" />
+
+# TimeZonePicker
+
+This component allows users to choose a timezone from a [list of timezones](https://github.com/yury-dymov/react-bootstrap-timezone-picker/blob/master/src/timezones.json). 
+It uses the [ComboBoxField](./?path=/docs/form-comboboxfield--default) component and its props. 
+
+The TimeZonePicker should be used for searching and filtering through the available timezones. Use the additonalTimeZones prop to add a new timezone.
+
+### Required components
+
+This component can be used independently and does not require additional components. 
+
+### Accessibility
+
+The component follows the same accessibility patterns as [ComboBoxField](./?path=/docs/form-comboboxfield--default).

package/lib/components/TooltipTrigger/TooltipTrigger.mdx

@@ -0,0 +1,21 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Components/TooltipTrigger/TooltipTrigger" />
+
+# TooltipTrigger
+
+The TooltipTrigger is a composed component that displays additional information on hover, click or focus. 
+This component is typically used as a design fallback for contextual information that may be hard to convey otherwise. It can also be disabled without disabling button-press events.
+
+This component should provide useful, supplementary information or clarification regarding the element it points to. 
+It shouldn’t contain essential content, error or feedback messages, or action items.
+
+### Required Components
+
+This component requires the [Button](./?path=/docs/components-button--default) and Tooltip components.
+
+### Accessibility
+
+#### Screen Readers
+
+The trigger button uses the **`aria-describedby`** attribute with the tooltip container ID to announce the screen reader content when it becomes visible.

package/lib/docs/Props.stories.mdx

@@ -0,0 +1,35 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Docs/Props" />
+
+## Understanding Astro Props
+
+Most of the Astro components can be customized through props which are documented in there respective component examples. If you want to pass your own custom props to an Astro component many components have wrapperProps, containerProps, and controlProps designed just for this.
+
+- **containerProps:** an object that gets spread to the outermost container commonly used for passing styles
+- **wrapperProps:** an object that gets spread to the container directly wrapping and input field
+- **controlProps:** an object that gets spread to an input field
+
+```
+const ExampleComponent = ({
+ containerProps,
+ controlProps,
+ wrapperProps,
+}) => (
+   <ContainerBox {...containerProps}>
+     <Box {...wrapperProps}>
+       <input type="text" {...controlProps} />
+     </Box>
+   </ContainerBox>
+ );
+};
+```
+
+Most of the Field/Input components have the following props, see the individual component for more details: 
+- `isDisabled`
+- `isOpen`
+- `isReadOnly`
+- `isRequired`
+- `onChange`
+- `onFocus`
+- `onFocusChange`

package/lib/docs/Welcome.stories.mdx

@@ -0,0 +1,149 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Docs/Welcome" />
+
+# Welcome to Astro
+
+<br />
+
+## Introduction
+
+Astro is a lightweight, composable, and themeable React component library. Astro was created to help developers and designers create consistent, user-friendly, and accessible UIs across all Ping products.
+
+<br />
+
+## Getting Started
+
+<br />
+
+### Installing
+
+To consume Astro within your own project, install it via NPM or Yarn.
+
+NPM: 
+`npm install @pingux/astro`
+
+Yarn: 
+`yarn add @pingux/astro`
+
+### Requirements
+
+- Node: 18+
+- React: 16.8+
+
+### Usage
+
+All apps should be wrapped in an `<AstroWrapper>` for full functionality and styling.
+
+```
+import { AstroWrapper } from ‘@pingux/astro’;
+
+<AstroWrapper>
+  <App />
+</AstroWrapper>
+```
+
+### Running Storybook Locally
+
+Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
+
+`yarn && yarn start`
+
+The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at the [Storybook docs](https://storybook.js.org/docs/react/api/cli-options). 
+
+Component prop documentation is available under the “documentation” tab per each component story. Most props can be toggled and configured for preview purposes within the prop table.
+For example, to view the disabled button styling, navigate to the Button story’s props table, locate the “isDisabled” prop, and toggle to “true”. This change allows you to preview the disabled button’s styling and functionality.
+
+There are two options to view the source code for stories within Storybook:
+- While on the "Documentation" tab, click the tab below the rendered story labelled "Show Code". This option may not show the entire source code for a story.
+- To view the entire source code of a story:
+    - Click the ellipsis menu next to the version number located at the top of the navigation menu. 
+    - Click "Show Addons" or ensure this option has been previously enabled.
+    - Navigate to a story's "Canvas" tab. Select "Story" from the now displaying add-on panel. More information on this add-on can be found here: [Story Source Add-on](https://storybook.js.org/addons/@storybook/addon-storysource#displaying-full-source)
+
+
+
+
+## Libraries used within Astro
+
+<br />
+
+- [React Aria](https://react-spectrum.adobe.com/react-aria/index.html) / [React Stately](https://react-spectrum.adobe.com/react-stately/index.html) / [React Spectrum](https://react-spectrum.adobe.com/react-spectrum/index.html)
+- [ThemeUI](https://theme-ui.com/)
+- [Styled System](https://styled-system.com/)
+
+<br />
+
+## Components
+
+<br />
+
+Astro is a library of small composable components that can be combined in many ways to create many more complex components. You can read more about the composition model in the [React Docs](https://reactjs.org/docs/composition-vs-inheritance.html). 
+
+Beyond the composable components, Astro also has form components to be used for gathering user input. Form components consist of field components and base components. Field components are composed from base components which are the building blocks used to compose form inputs.
+
+<br />
+
+## Understanding Astro Props
+
+<br />
+
+Most Astro components can be customized through props, find [more details here](./?path=/story/docs-props--page). 
+
+<br />
+
+## Theming
+
+<br />
+
+You can customize the base Astro theme by [creating theme overrides](./?path=/docs/docs-theme-custom-themes--page). 
+You can find the default [Astro theme here](./?path=/docs/docs-theme-astro-theme--page).
+
+<br />
+
+## Styling
+
+<br />
+
+Astro uses [styled-system,](https://styled-system.com/table/) a javascript dependency that facilitates the building of custom UI components by adding constraint-based style props based on scales defined in the theme. This can be used to quickly add custom styling to components.
+
+The Ping UX Dev team follows best practices related to styling as outlined in the [Styling Guidelines](./?path=/story/docs-theme-styling-guideline--page). These best practices encourage the separation of component code from styling code. This practice removes the custom styles that are applied in StoryBook code examples. If you want to see how the Astro team applies custom styles to our recipes you can find the entire story code file in the Story section of the Addons panel. 
+- Select **Show Addons** in the Storybook menu, located in the left navigation panel at the top beside the “@pingux/astro” title (it’s a circle with 3 dots).
+- Inside the **Addon panel** that pops up, select the **Story panel** to see the full code file.
+
+<br />
+
+## Development Notes
+
+<br />
+
+There is currently a [known conflict](https://github.com/adobe/react-spectrum/issues/779) between React.StrictMode and react-spectrum. The current recommended solution is to avoid using StrictMode in your apps. In the latest versions of Create React App the app is wrapped in StrictMode by default, this should be removed if you’re using any of the react-spectrum or pingux libraries. We will monitor this issue and make updates when possible.
+
+<br />
+
+## Help
+
+<br />
+
+For assistance with the Astro library reach out to the Astro team on Slack
+- #ui-astro
+- #ux-forum
+
+<br />
+
+
+## Browser Compatibility
+
+<br />
+
+Astro fully supports the following browsers and versions:
+
+| Browser     | Version     |
+| ----------- | ----------- |
+| Chrome      | 80+         |
+| Firefox     | 76+         |
+| Safari      | 12+         |
+| Edge        | 44+         |
+
+
+Support for IE11 is left up to developers and is not tested by the Astro team. Polyfills are necessary for full functionality.

package/lib/docs/hooks/useDebounce.stories.mdx

@@ -0,0 +1,59 @@
+import { Meta, Title, ArgsTable, Canvas, Story } from '@storybook/addon-docs';
+import useDebounce from '../../hooks/useDebounce/useDebounce';
+
+<Meta title="Docs/Hooks/useDebounce" />
+
+# useDebounce
+
+A hook that provides a simple way to debounce updates to a variable.
+
+## Overview
+
+This hook can be used to debounce a value so it is only updated after a certain amount of time has passed. 
+This can be particularly useful for any action involving a network request after a user types, such as searching.
+
+## Usage
+
+To use this hook, import it from `@pingux/astro/lib/hooks`.
+
+`import { useDebounce } from "@pingux/astro/lib/hooks";`
+
+## API
+
+<br />
+
+### useDebounce([props]) => result
+
+<br />
+
+#### props
+
+Type: `Object` Default: `{}`
+
+* **value**
+
+  Type: `unknown`
+
+  The value to be updated after a period of time has passed.
+
+* **delay**
+
+  Type: `number`
+
+  The amount of time (in milliseconds) to debounce.
+
+#### result
+
+Type: `any`
+
+The updated value after `delay` milliseconds have passed with no additional updates.
+
+
+## Example
+
+`const [searchTerm, setSearchTerm] = useState(null);`
+
+`const debouncedSearchTerm = useDebounce({ searchTerm, value: 500 });`
+
+`debouncedSearchTerm` will only be updated after 500 milliseconds have passed since `searchTerm` was updated without
+an additional update.

package/lib/docs/hooks/useModalState.stories.mdx

@@ -0,0 +1,83 @@
+import { Meta, Title, ArgsTable, Canvas, Story } from '@storybook/addon-docs';
+import useModalState, { DummyComponent } from '../../hooks/useModalState/useModalState';
+
+<Meta title="Docs/Hooks/useModalState" />
+
+# useModalState
+
+A hook that manages and supplies state intended for Astro-UI's `Modal` component.
+
+## Overview
+
+This hook utilizes React Stately's [useOverlayTriggerState](https://react-spectrum.adobe.com/react-stately/useOverlayTriggerState.html) hook to generate the necessary state management for
+a `Modal` component with minimal modifications.
+
+## Usage
+
+To use this hook, import it from `@pingux/astro/lib/hooks`.
+
+`import { useModalState } from "@pingux/astro/lib/hooks";`
+
+## API
+
+<br />
+
+### useModalState([props]) => result
+
+<br />
+
+#### props
+
+Type: `Object` Default: `{}`
+
+* **isDefaultOpen**
+
+  Type: `boolean`
+
+  Whether the modal is open by default (uncontrolled).
+
+* **isOpen**
+
+  Type: `boolean`
+
+  Whether the modal is currently open (controlled).
+
+* **onOpenChange**
+
+  Type: `Function`
+
+  Handler that is called when the open state changes. `(isOpen: boolean) => void`
+
+#### result
+
+Type: `Object`
+
+* **isOpen**
+
+  Type: `boolean`
+
+  Whether the modal is currently open.
+
+* **open**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to `true`.
+
+* **close**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to `false`.
+  
+* **toggle**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to the opposite of what it just was.
+
+
+## Example
+
+See the [entire Modal source code](./?path=/story/components-modal--default) for an example of how to implement this hook.
+To view a story's entire source code, enable 'Show-addons' in the Storybook ellipsis menu in the lefthand navigation, and click the Story tab.

package/lib/docs/hooks/useOverlayPanelState.stories.mdx

@@ -0,0 +1,84 @@
+import { Meta, Title, ArgsTable, Canvas, Story } from '@storybook/addon-docs';
+import LinkTo from '@storybook/addon-links/react';
+import useOverlayPanelState, { DummyComponent } from '../../hooks/useOverlayPanelState/useOverlayPanelState';
+
+<Meta title="Docs/Hooks/useOverlayPanelState" />
+
+# useOverlayPanelState
+
+A hook that manages and supplies state intended for Astro-UI's `OverlayPanel` component.
+
+## Overview
+
+This hook utilizes React Stately's [useOverlayTriggerState](https://react-spectrum.adobe.com/react-stately/useOverlayTriggerState.html) hook to generate the necessary state management for
+a `OverlayPanel` component with minimal modifications.
+
+## Usage
+
+To use this hook, import it from `@pingux/astro/lib/hooks`.
+
+`import { useOverlayPanelState } from "@pingux/astro/lib/hooks";`
+
+## API
+
+<br />
+
+### useOverlayPanelState([props]) => result
+
+<br />
+
+#### props
+
+Type: `Object` Default: `{}`
+
+* **isDefaultOpen**
+
+  Type: `boolean`
+
+  Whether the overlay panel is open by default (uncontrolled).
+
+* **isOpen**
+
+  Type: `boolean`
+
+  Whether the overlay panel is currently open (controlled).
+
+* **onOpenChange**
+
+  Type: `Function`
+
+  Handler that is called when the open state changes. `(isOpen: boolean) => void`
+
+#### result
+
+Type: `Object`
+
+* **isOpen**
+
+  Type: `boolean`
+
+  Whether the overlay panel is currently open.
+
+* **open**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to `true`.
+
+* **close**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to `false`.
+
+* **toggle**
+
+  Type: `Function`
+
+  Sets the returned `isOpen` to the opposite of what it just was.
+
+
+## Example
+
+See the [Overlay Panel docs](./?path=/story/components-overlaypanel--default) for an example of how to 
+implement this hook.