@pingux/astro 2.9.2 → 2.13.0-alpha.10

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.

package/lib/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'
+}
+```

package/lib/docs/theme/AstroTheme.stories.mdx

@@ -0,0 +1,20 @@
+import { Meta } from '@storybook/addon-docs';
+import { JSONTree } from 'react-json-tree';
+import ThemeView from './ThemeView';
+
+<Meta title="Docs/Theme/Astro Theme" />
+
+# Theme Overview
+Astro utilizes [Theme UI](https://theme-ui.com/) to apply styles consistently using their
+[theme specification](https://theme-ui.com/theme-spec). This allows us to specify reusable colors,
+font sizes, component variants, and so much more. This document will focus on how we structure
+our theme object to align with the Theme UI paradigm and is meant to serve as a reference for any
+developers wishing to add or edit the theme.
+
+# Theme Values
+
+This is the raw theme object that is passed in the Astro wrapper. Its values can be referenced in `styled-system` properties. See [https://styled-system.com/table](https://styled-system.com/table) for details.
+
+For example, to set a background color on a `Box` component, you can reference one of the keys under the `colors` section. Like: `bg="black"`, `bg="accent.20"`, `bg="decorative.4"`, or `bg="critical.bright"`.
+
+<ThemeView />

package/lib/docs/theme/CustomThemes.stories.mdx

@@ -0,0 +1,70 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Docs/Theme/Custom Themes" />
+
+# Custom Themes
+<br/>
+
+## Creating Theme Overrides
+
+The Astro component library ships with [a default theme](./?path=/docs/docs-theme-astro-theme--page) based on Ping's 
+Astro design system. To extend, modify, or replace the theme to change the visual look 
+of components then there are two options:
+
+1. `themeOverrides` - this prop on the `AstroWrapper` component facilitates extending and modifying the base theme. 
+See AstroWrapper custom theme story for more information.
+The `themeOverrides` prop uses [the merge function from ThemeUI](https://theme-ui.com/guides/merging-themes/).
+With this approach, only variants that you specifically target within your new theme will be changed, 
+but those not targeted will still inherit styles from the default theme. If you are attempting to keep the majority of styling from the 
+Astro Design System (and therefore base astroTheme), but wish to override a few global styles, this is the favored approach. 
+
+2. `defaultTheme` - this is another prop on the `AstroWrapper` component, 
+but this _replaces_ the base theme with the object passed in. We discourage using this in most situations.
+
+
+To assist in customizing the theme, Astro includes the following objects:
+- astroTheme - The base Astro theme, includes all styles from the Astro design system: `@pingux/astro/lib/styles/theme`
+- endUserTheme - An alternative theme which matches Ping's End User library styling: `@pingux/astro/lib/styles/themes/end-user`
+- overrideUILib - An override object to address conflicting styles between Astro and Ping's UI Library CSS: `@pingux/astro/lib/styles/themeOverrides/uiLibraryOverride`
+
+
+
+
+## How to Customize Astro Styles
+
+Components typically use a custom variant to apply styles. See the [Astro Theme](./?path=/docs/docs-theme-astro-theme--page) documentation for more information on this. To override these styles, 
+the variant included within the component will need to be targeted. For example, to override the border color on all primary buttons, 
+search within the /theme file for the button structure. Within this file, `buttons` is not nested within another object so,
+the theme structure is straight forward and would look like:
+
+```
+const myThemeOverride = {
+    buttons: {
+        primary: {
+            borderColor: 'red',
+        }
+    }
+}
+```
+
+Some components and their variants are nested, for example components within /Forms. To change the hovered border color on a TextArea component, the following would be added to myThemeOverride.
+
+
+```
+const myThemeOverride = {
+    forms: {
+        textarea: {
+            '&:hover': {
+                borderColor: 'red',
+            }
+        }
+    },
+    buttons: {
+        primary: {
+            borderColor: 'red',
+        }
+    }
+}
+```
+
+These overrides can then be passed to the `themeOverrides` prop on the `AstroWrapper` as mentioned above.

package/lib/docs/theme/StylingGuideline.stories.mdx

@@ -0,0 +1,116 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Docs/Theme/Styling Guideline" />
+
+# Styling Guidelines
+
+<br />
+
+## Sx prop
+
+The majority of Astro components are built using `<Box>` from Theme UI as their foundation. Therefore, the `sx` prop can be passed directly to these components. More information about how the sx prop works can be found on the [ThemeUI site](https://theme-ui.com/sx-prop/).
+There are a few different approaches developers can take for adding custom styles utilizing the SX prop which are listed below. Each approach comes with different benefits and caveats. 
+
+It is always best practice to check if a styling variant exists before adding custom styling. It is rare that a style included within the Astro Design System does not have a matching style variant in the Astro Component Library.
+If you often find yourself reusing the same custom styles often, 
+reach out to the UX Dev team (via slack channel : #ui-astro) to discuss having the styles added as a reusable component variant.
+<br />
+
+### Passing inline styles to the Sx prop
+
+**Example:** 
+
+`<Box sx={{marginRight: ‘sm’}} />`
+
+**This approach works best for**
+
+- Small style adjustments
+- Adding or overwriting less than 3 additional styles to a component
+- Overwriting specific styles that have been passed in through a custom theme
+
+**Considerations**
+
+- Styles passed through the sx prop are not maintained by the library, so if a theme change occurs, these inline styles with not be adjusted accordingly. 
+- Styles passed through the sx prop are not reusable unless saved as an object.
+
+<br />
+
+### Passing a style object to the sx prop
+
+**Example:** 
+```
+const ExampleStoryComponent = () => {
+  const sx = {
+    boxOne: {
+      bg: 'blue',
+      height: '35px',
+      fontSize: 3,
+      p: 'md',
+    },
+    boxTwo: {
+      bg: 'red',
+      height: '10px',
+      fontSize: 2,
+      s: 'sm',
+    },
+  };
+
+  return (
+    <>
+      <BoxOne sx={sx.boxOne} />
+      <BoxTwo sx={sx.boxTwo} />
+    </>
+  );
+};
+```
+
+**This approach works best for**
+
+- Applying the same styles to multiple components
+- Adding 3 or greater additional styles
+- Cleaner code presentation; separating style from logic
+- Overwriting multiple styles that have been passed in through a custom theme
+- Added maintainability
+
+**Considerations**
+
+- Style objects passed through the sx prop are not maintained by the library, so if a theme change occurs, these inline styles with not be adjusted accordingly. 
+
+<br/>
+
+### Dos & Don’ts for SX Prop
+
+Astro components have been built using [Theme UI](https://theme-ui.com/guides/variants) which enables the use of variants.
+Using pre-existing variants to match design mocks is considered the best pratice as these styles are maintained by the library and match the Astro Design System.
+
+If a component has variants, they can be found in that individual component's documentation table within Storybook. You can also find the full list of Astro theme variants and pre-defined design tokens here:
+
+- [Astro Base Theme](./?path=/docs/docs-theme-astro-theme--page)
+- [Container Sizes](./?path=/story/docs-design-container-sizes--container-sizes)
+- [Spacing Sizes](./?path=/story/docs-design-spacing--spacing)
+- [Typography](./?path=/story/docs-design-typography--typography-tokens)
+- [Colors](./?path=/story/docs-design-color-schema--colors)
+
+If the pre-existing variants don’t meet your needs, and you wish to apply styling using [Theme UI](https://theme-ui.com/sx-prop)'s Sx prop, the following are best practices for applying CSS rules to children components and elements.
+
+- When possible pass styles directly to a components sx prop either inline or via an object as mentioned in the above sections. In composed components, [controlProps or containerProps](./?path=/story/docs-props--page) may help you more
+accurately target elements.
+- If you can’t style a component directly through the sx prop, try to use [CSS selectors to style select elements](https://www.w3schools.com/cssref/css_selectors.php). Please avoid targeting aria attributes or other attributes that are likely to change or be translated.
+- If you can’t target an element for styling with the above suggestions, do not hesitate to reach out to the UX development team and they will assess the best approach, be it adding a theme variant or adding a dedicated prop.
+
+<br />
+
+## Custom Themes
+	
+**When to create a custom theme?**<br />
+Custom themes are ideal for adding styles to components consistently throughout your app. You can learn more about creating a custom theme and pre-existing themes available to you [here](./?path=/docs/docs-theme-custom-themes--page).
+
+**This approach works best for**
+- Applying styling changes to components consistently throughout an application
+
+**Considerations**
+- Unless you’re using a custom theme exported by the Astro library, your custom themes will not be maintained by the library. 
+- If you create a theme or theme adjustments that you believe could be beneficial to others, please let the UX Dev team know. Several developers have contributed to the UiLibraryOverride and EndUser themes.
+This helps us keep styling consistent across products.
+- Keep in mind, similar to inline hierarchical CSS, if styles are passed in through the SX prop, 
+they will overwrite your custom theme styling. 

package/lib/docs/utils/messagesReducer.stories.mdx

@@ -0,0 +1,64 @@
+import { Meta, Title, ArgsTable, Canvas, Story } from '@storybook/addon-docs';
+import LinkTo from '@storybook/addon-links/react';
+
+<Meta title="Docs/Utils/MessagesReducer" />
+
+# Messages Reducer
+
+<br />
+
+## Usage
+
+To use Messages Reducer, import it from `@pingux/astro`.
+
+`import { messagesReducer, multiMessagesReducer } from '@pingux/astro';`
+
+<br />
+
+## Overview
+
+`messagesReducer` provides a reducer to store a list of messages.
+
+`messagesReducer.actions` provides actions that can be dispatched to the reducer. By default the next actions are available:
+
+* **addMessage**
+
+Create an action to add a message
+
+`addMessage(message: {key: string, text: string, status: string})`
+
+* **removeMessage**
+
+Create an action to remove a message by key
+
+`removeMessage(key: string)`
+
+* **showMessage**
+
+Create an action to add a message and then remove it if there's a timeout
+
+`showMessage(message: {key: string, text: string, status: string}, timeout: number)`
+
+* **clearMessages**
+
+Create an action to clear all messages
+
+`clearMessages()`
+
+<br />
+
+## Example
+
+See the [Messages with Reducer](./?path=/story/components-messages--use-reducer) for an example of implementation.
+
+<br />
+
+## Multiple messages reducer
+
+`multiMessagesReducer` is used for storing messages in different containers.
+
+`multiMessagesReducer.actions` utilizes the same actions as `messagesReducer`, only needs to provide container name, as a first argument, e.g.:
+
+`addMessage(container: string, message: {key: string, text: string, status: string})`
+
+See the [story](./?path=/story/components-messages--use-reducer-with-multiple-containers) for an example of implementation.