@pingux/astro 2.9.1 → 2.13.0-alpha.10

package/lib/cjs/components/TooltipTrigger/TooltipTrigger.test.js

@@ -1,6 +1,17 @@
 "use strict";
 
+var _typeof = require("@babel/runtime-corejs3/helpers/typeof");
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+var _Symbol = require("@babel/runtime-corejs3/core-js-stable/symbol");
+var _Object$create = require("@babel/runtime-corejs3/core-js-stable/object/create");
+var _Object$getPrototypeOf = require("@babel/runtime-corejs3/core-js-stable/object/get-prototype-of");
+var _forEachInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
+var _Object$setPrototypeOf = require("@babel/runtime-corejs3/core-js-stable/object/set-prototype-of");
+var _Promise = require("@babel/runtime-corejs3/core-js-stable/promise");
+var _reverseInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/reverse");
+var _sliceInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/slice");
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/asyncToGenerator"));
 var _react = _interopRequireDefault(require("react"));
 var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
 var _index = require("../../index");
@@ -8,6 +19,7 @@ var _theme = _interopRequireDefault(require("../../styles/theme"));
 var _testAxe = _interopRequireDefault(require("../../utils/testUtils/testAxe"));
 var _testWrapper = require("../../utils/testUtils/testWrapper");
 var _react2 = require("@emotion/react");
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = _Object$defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof _Symbol ? _Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return _Object$defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = _Object$create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = _Object$getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = _Object$create(IteratorPrototype); function defineIteratorMethods(prototype) { var _context2; _forEachInstanceProperty(_context2 = ["next", "throw", "return"]).call(_context2, function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], _forEachInstanceProperty(tryLocsList).call(tryLocsList, pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return _Object$setPrototypeOf ? _Object$setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = _Object$create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = _Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return _reverseInstanceProperty(keys).call(keys), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { var _context3; if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, _forEachInstanceProperty(_context3 = this.tryEntries).call(_context3, resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+_sliceInstanceProperty(name).call(name, 1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
 var getComponent = function getComponent() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   return (0, _testWrapper.render)((0, _react2.jsx)(_index.TooltipTrigger, props, (0, _react2.jsx)(_index.Button, props.buttonProps, "Mock Button"), (0, _react2.jsx)(_index.Tooltip, null, "Tooltip Content")));
@@ -81,4 +93,38 @@ test('passing in width applies the correct width to the container', function ()
   });
   var arrow = _testWrapper.screen.getByTestId('popover-container');
   expect(arrow).toHaveStyle('width: 100px');
-});
+});
+test('tooltip closes after closeDelay when mouse leaves trigger', /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+  var closeDelay, button;
+  return _regeneratorRuntime().wrap(function _callee$(_context) {
+    while (1) {
+      switch (_context.prev = _context.next) {
+        case 0:
+          closeDelay = 5000;
+          getComponent({
+            closeDelay: closeDelay
+          });
+          button = _testWrapper.screen.getByRole('button');
+          _testWrapper.fireEvent.mouseEnter(button);
+          expect(_testWrapper.screen.queryByRole('tooltip')).toBeInTheDocument();
+          _testWrapper.fireEvent.mouseLeave(button);
+          _context.next = 8;
+          return (0, _testWrapper.waitFor)(function () {
+            expect(_testWrapper.screen.queryByRole('tooltip')).toBeInTheDocument();
+          }, {
+            timeout: closeDelay / 2 + 100
+          });
+        case 8:
+          _context.next = 10;
+          return (0, _testWrapper.waitFor)(function () {
+            expect(_testWrapper.screen.queryByRole('tooltip')).not.toBeInTheDocument();
+          }, {
+            timeout: closeDelay + 100
+          });
+        case 10:
+        case "end":
+          return _context.stop();
+      }
+    }
+  }, _callee);
+})));

package/lib/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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.

package/lib/cjs/docs/theme/AstroNanoTheme.stories.mdx

@@ -0,0 +1,174 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Docs/Theme/Astro Nano Theme" />
+
+# Astro Nano Theme
+
+The Astro Nano Theme extends styles from the base Astro Theme with new variants and modifications to some of the base variants.    
+
+## Modified Astro Variants
+
+### Cards
+```
+{
+    container: {
+        alignItems: "stretch",
+        bg: "white",
+        borderRadius: 4,
+        boxShadow: ['none', 'standard'],
+        flexGrow: [1, 0],
+        maxWidth: "480px",
+        my: "auto",
+        py: [0, 'xl'],
+        width: ['100%', '450px']
+    },
+    cardBody: {
+        flexGrow: [1, 0],
+    },
+}
+```
+
+### Buttons
+
+#### Default
+```
+{
+    borderRadius: 4,
+    color: "active",
+    fontWeight: 400,
+    height: "50px",
+    &:focus-visible: {
+        boxShadow: 'none', 
+        outline: '1px solid #000000', 
+        outlineColor: 'active',
+        outlineOffset: 2 
+    },
+    &.is-pressed: {
+        bg: 'activeDarker'
+    },
+    &.is-hovered: {
+        bg: 'activeDark',
+        boxShadow: 'none', 
+        color: 'white'
+    }
+}
+```
+
+#### Primary
+```
+{
+    borderRadius: 4,
+    fontWeight: 400,
+    height: "50px",
+    &:focus-visible: {
+        boxShadow: 'none', 
+        outline: '1px solid #000000', 
+        outlineColor: 'active',
+        outlineOffset: 2 
+    },
+    &.is-pressed: {
+        bg: 'activeDarker'
+    },
+    &.is-hovered: {
+        bg: 'activeDark',
+        boxShadow: 'none', 
+        color: 'white'
+    }
+}
+```
+
+### Colors  
+Astro nano introduces two new colors, `activeDark: "#154dd3"` and `activeDarker: "#0039ba"`.
+
+### Font Sizes
+
+Font sizes in Astro Nano use the font sizes from the Astro theme and scales them by 1.2. Astro nano also introduces a new font size, `xxx: "48px"`.
+
+### Forms
+
+#### Input
+```
+{
+    borderRadius: 4,
+    height: "50px",
+    &:focus: {
+        borderColor: 'active', 
+        outline: '4px solid #000000', 
+        outlineColor: 
+        'accent.90'
+    }
+}
+```
+
+### Links
+```
+{
+    "&.is-hovered": {
+        color: "activeDark"
+     },
+    "&.is-pressed": {
+        color: "activeDarker"
+    }
+}
+```
+
+### Text
+
+#### Label
+`color: "text.primary"`
+
+#### Title
+`fontWeight: 600`
+
+## Variants Introduced in Astro Nano
+
+### Card Body
+`flexGrow: [1, 0]`
+
+### Wrapper
+```
+{
+    alignItems: "center",
+    justifyContent: "space-between",
+    bg: ["white", "accent.99"],
+    py: "lg",
+    gap: "lg",
+    overflow: "auto",
+    position: "absolute",
+    top: 0,
+    bottom: 0,
+    left: 0,
+    right: 0
+}
+```
+
+### Forms.Input
+
+#### Primary
+```
+{
+    borderRadius,
+    fontSize: "xxx",
+    borderColor: "neutral.60",
+    height: "75px",
+    textAlign: "center",
+    letterSpacing: "12px",
+    fontWeight: "bold",
+    "&:focus": {
+        borderColor: "active",
+        outline: "4px solid #000000",
+        outlineColor: "accent.90"
+    }
+}
+```
+
+### Text
+
+#### Footer
+Footer is a text variant only included in Astro Nano. 
+```
+{
+    color: 'text.secondary', 
+    fontSize: 'xs'
+}
+```