@utilitywarehouse/hearth-react-native 0.2.0 → 0.3.1

package/src/components/DescriptionList/index.ts

@@ -0,0 +1,4 @@
+export { default as DescriptionList } from './DescriptionList';
+export type { default as DescriptionListProps } from './DescriptionList.props';
+export { default as DescriptionListItem } from './DescriptionListItem';
+export type { default as DescriptionListItemProps } from './DescriptionListItem.props';

package/src/components/Divider/Divider.props.ts

@@ -1,9 +1,9 @@
 import type { DimensionValue, ViewProps } from 'react-native';
-import type { ColorValue } from '../../types';
+import type { ColorValue, SpacingValues } from '../../types';
 
 interface DividerProps extends Omit<ViewProps, 'children'> {
   color?: ColorValue;
-  space?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+  space?: SpacingValues;
   orientation?: 'horizontal' | 'vertical';
   height?: DimensionValue;
   width?: DimensionValue;

package/src/components/Divider/Divider.stories.tsx

@@ -1,7 +1,7 @@
-import { Divider } from '.';
 import { Meta, StoryObj } from '@storybook/react-vite';
-import { Box } from '../Box';
+import { Divider } from '.';
 import { coloursAsArray } from '../../utils';
+import { Box } from '../Box';
 
 const meta = {
   title: 'Stories / Divider',
@@ -21,7 +21,7 @@ const meta = {
       description: 'Color of the divider',
     },
     space: {
-      options: ['none', 'xs', 'sm', 'md', 'lg', 'xl'],
+      options: ['none', '2xs', 'xs', 'sm', 'md', 'lg', 'xl', '2xl'],
       control: 'select',
       description: 'Space between the divider',
     },

package/src/components/Divider/Divider.tsx

@@ -44,11 +44,13 @@ const styles = StyleSheet.create(theme => ({
       },
       space: {
         none: {},
+        '2xs': {},
         xs: {},
         sm: {},
         md: {},
         lg: {},
         xl: {},
+        '2xl': {},
       },
       flexItem: {
         true: {
@@ -64,6 +66,17 @@ const styles = StyleSheet.create(theme => ({
           marginVertical: 0,
         },
       },
+      {
+        orientation: 'horizontal',
+        space: '2xs',
+        styles: {
+          marginVertical: {
+            base: theme.layout.mobile.spacing['2xs'],
+            md: theme.layout.tablet.spacing['2xs'],
+            lg: theme.layout.desktop.spacing['2xs'],
+          },
+        },
+      },
       {
         orientation: 'horizontal',
         space: 'xs',
@@ -119,6 +132,17 @@ const styles = StyleSheet.create(theme => ({
           },
         },
       },
+      {
+        orientation: 'horizontal',
+        space: '2xl',
+        styles: {
+          marginVertical: {
+            base: theme.layout.mobile.spacing['2xl'],
+            md: theme.layout.tablet.spacing['2xl'],
+            lg: theme.layout.desktop.spacing['2xl'],
+          },
+        },
+      },
       {
         orientation: 'vertical',
         space: 'none',
@@ -126,6 +150,17 @@ const styles = StyleSheet.create(theme => ({
           marginHorizontal: 0,
         },
       },
+      {
+        orientation: 'vertical',
+        space: '2xs',
+        styles: {
+          marginHorizontal: {
+            base: theme.layout.mobile.spacing['2xs'],
+            md: theme.layout.tablet.spacing['2xs'],
+            lg: theme.layout.desktop.spacing['2xs'],
+          },
+        },
+      },
       {
         orientation: 'vertical',
         space: 'xs',
@@ -181,6 +216,17 @@ const styles = StyleSheet.create(theme => ({
           },
         },
       },
+      {
+        orientation: 'vertical',
+        space: '2xl',
+        styles: {
+          marginHorizontal: {
+            base: theme.layout.mobile.spacing['2xl'],
+            md: theme.layout.tablet.spacing['2xl'],
+            lg: theme.layout.desktop.spacing['2xl'],
+          },
+        },
+      },
     ],
   },
   extraStyles: (color, width, height) => ({

package/src/components/Flex/Flex.docs.mdx

@@ -1,7 +1,7 @@
-import { Meta, Canvas, Story, Controls, Primary } from '@storybook/addon-docs/blocks';
+import { Canvas, Controls, Meta, Primary, Story } from '@storybook/addon-docs/blocks';
+import { BodyText, Center, Flex, Pressable } from '../..';
+import { BackToTopButton, UsageWrap, ViewFigmaButton } from '../../../docs/components';
 import * as Stories from './Flex.stories';
-import { Center, Pressable, Flex, BodyText } from '../..';
-import { UsageWrap, BackToTopButton, ViewFigmaButton } from '../../../docs/components';
 
 <Meta title="Primitives / Flex" />
 
@@ -57,4 +57,4 @@ const MyComponent = () => (
 | `wrap`      | `'wrap' \| 'nowrap' \| 'wrap-reverse'`                                                                  | `nowrap`     | The wrap of the flex container.            |
 | `justify`   | `'flex-start' \| 'flex-end' \| 'center' \| `<br />`'space-between' \| 'space-around' \| 'space-evenly'` | `flex-start` | The justify content of the flex container. |
 | `align`     | `'flex-start' \| 'flex-end' \| 'center' \| 'stretch' \| 'baseline'`                                     | `flex-start` | The align items of the flex container.     |
-| `space`     | `'none' \| 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'`                                                        | `md`         | The space between the content.             |
+| `space`     | `'none' \| '2xs' \| 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| '2xl'`                                      | `md`         | The space between the content.             |

package/src/components/Flex/Flex.props.ts

@@ -1,11 +1,12 @@
-import type { ViewProps, ViewStyle, FlexAlignType } from 'react-native';
+import type { FlexAlignType, ViewProps, ViewStyle } from 'react-native';
+import { SpacingValues } from '../../types';
 
 interface FlexProps extends ViewProps {
   direction?: ViewStyle['flexDirection'];
   align?: FlexAlignType;
   justify?: ViewStyle['justifyContent'];
   wrap?: ViewStyle['flexWrap'];
-  space?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+  space?: SpacingValues;
 }
 
 export default FlexProps;

package/src/components/Flex/Flex.stories.tsx

@@ -40,7 +40,7 @@ const meta = {
       description: 'The justify of the flex container.',
     },
     space: {
-      options: ['none', 'xs', 'sm', 'md', 'lg', 'xl'],
+      options: ['none', '2xs', 'xs', 'sm', 'md', 'lg', 'xl', '2xl'],
       control: 'radio',
       description: 'The space of the flex container.',
     },

package/src/components/Grid/Grid.docs.mdx

@@ -1,7 +1,7 @@
-import { Meta, Canvas, Story, Controls, Primary } from '@storybook/addon-docs/blocks';
+import { Canvas, Controls, Meta, Primary, Story } from '@storybook/addon-docs/blocks';
+import { BodyText, Box, Center, Grid } from '../..';
+import { BackToTopButton, UsageWrap, ViewFigmaButton } from '../../../docs/components';
 import * as Stories from './Grid.stories';
-import { Center, Grid, Box, BodyText } from '../..';
-import { UsageWrap, BackToTopButton, ViewFigmaButton } from '../../../docs/components';
 
 <Meta title="Primitives / Grid" />
 
@@ -173,15 +173,15 @@ const MyComponent = () => (
 
 The Grid component extends all the props from the [View component](https://reactnative.dev/docs/view), and adds the following:
 
-| Name             | Type                                             | Default | Description                                                   |
-| ---------------- | ------------------------------------------------ | ------- | ------------------------------------------------------------- |
-| `columns`        | `number` or `GridColumns`                        | 2       | Number of columns or responsive object with breakpoint values |
-| `space`          | `'none' \| 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | -       | Spacing between grid items (both rows and columns)            |
-| `columnGap`      | `number`                                         | -       | Gap between columns (overrides spacing if provided)           |
-| `rowGap`         | `number`                                         | -       | Gap between rows (overrides spacing if provided)              |
-| `containerStyle` | `StyleProp\<ViewStyle\>`                         | -       | Style for the grid container                                  |
-| `itemStyle`      | `StyleProp\<ViewStyle\>`                         | -       | Style applied to each grid item                               |
-| `rowStyle`       | `StyleProp\<ViewStyle\>`                         | -       | Style applied to each row                                     |
+| Name             | Type                                                               | Default | Description                                                   |
+| ---------------- | ------------------------------------------------------------------ | ------- | ------------------------------------------------------------- |
+| `columns`        | `number` or `GridColumns`                                          | 2       | Number of columns or responsive object with breakpoint values |
+| `space`          | `'none' \| '2xs' \| 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| '2xl'` | -       | Spacing between grid items (both rows and columns)            |
+| `columnGap`      | `number`                                                           | -       | Gap between columns (overrides spacing if provided)           |
+| `rowGap`         | `number`                                                           | -       | Gap between rows (overrides spacing if provided)              |
+| `containerStyle` | `StyleProp\<ViewStyle\>`                                           | -       | Style for the grid container                                  |
+| `itemStyle`      | `StyleProp\<ViewStyle\>`                                           | -       | Style applied to each grid item                               |
+| `rowStyle`       | `StyleProp\<ViewStyle\>`                                           | -       | Style applied to each row                                     |
 
 Where `GridColumns` is defined as:
 

package/src/components/Grid/Grid.props.ts

@@ -1,6 +1,6 @@
 import { StyleProp, ViewProps, ViewStyle } from 'react-native';
 import { UnistylesBreakpoints } from 'react-native-unistyles';
-import { SpaceValue } from '../../types';
+import { SpaceValue, SpacingValues } from '../../types';
 
 // Create a type that uses the keys from our breakpoints object
 export type GridColumns = {
@@ -17,7 +17,7 @@ export interface GridProps extends ViewProps {
   /**
    * Spacing between grid items (applies to both rows and columns)
    */
-  space?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+  space?: SpacingValues;
 
   /**
    * Gap between items (overrides spacing if provided)

package/src/components/Grid/Grid.stories.tsx

@@ -1,5 +1,5 @@
 import { Meta, StoryObj } from '@storybook/react-vite';
-import { View, Text } from 'react-native';
+import { Text, View } from 'react-native';
 import { Grid } from '.';
 
 const meta = {
@@ -14,7 +14,7 @@ const meta = {
       description: 'Number of columns or responsive object with breakpoints',
     },
     space: {
-      options: ['none', 'xs', 'sm', 'md', 'lg', 'xl'],
+      options: ['none', '2xs', 'xs', 'sm', 'md', 'lg', 'xl', '2xl'],
       control: 'radio',
       description: 'Responsive spacing between grid items (applied to both rows and columns).',
     },

package/src/components/IconContainer/IconContainer.docs.mdx

@@ -0,0 +1,90 @@
+import { Canvas, Controls, Meta, Story } from '@storybook/addon-docs/blocks';
+import {
+  BroadbandMediumIcon,
+  CashbackCardMediumIcon,
+  ElectricityMediumIcon,
+  EmailMediumIcon,
+  InsuranceMediumIcon,
+  MobileMediumIcon,
+} from '@utilitywarehouse/hearth-react-native-icons';
+import { Center, Flex, IconContainer } from '../../';
+import { BackToTopButton, UsageWrap } from '../../../docs/components';
+import * as Stories from './IconContainer.stories';
+
+<BackToTopButton />
+
+<Meta title="Components / Icon Container" />
+
+# Icon Container
+
+The `IconContainer` component provides a consistent background and sizing (via component tokens) for any standalone icon, with semantic colour families and subtle/emphasis variants.
+
+- [Playground](#playground)
+- [Usage](#usage)
+- [Props](#props)
+- [Variants](#variants)
+
+## Playground
+
+<Canvas of={Stories.Playground} />
+
+<Controls of={Stories.Playground} />
+
+## Usage
+
+Wrap an icon with the `IconContainer` to apply sizing + background styles without repeating layout code.
+
+<UsageWrap>
+  <Center>
+    <Flex direction="row" space="lg" alignItems="center">
+      <IconContainer icon={ElectricityMediumIcon} size="md" variant="emphasis" color="energy" />
+      <IconContainer icon={BroadbandMediumIcon} size="md" variant="emphasis" color="broadband" />
+      <IconContainer icon={MobileMediumIcon} size="md" variant="emphasis" color="mobile" />
+      <IconContainer icon={InsuranceMediumIcon} size="md" variant="emphasis" color="insurance" />
+      <IconContainer icon={CashbackCardMediumIcon} size="md" variant="emphasis" color="cashback" />
+      <IconContainer icon={EmailMediumIcon} size="md" variant="emphasis" color="pig" />
+    </Flex>
+  </Center>
+</UsageWrap>
+
+```jsx
+import { IconContainer } from '@utilitywarehouse/hearth-react-native';
+import {
+  ElectricityMediumIcon,
+  BroadbandMediumIcon,
+  MobileMediumIcon,
+  InsuranceMediumIcon,
+  CashbackCardMediumIcon,
+  ,
+} from '@utilitywarehouse/hearth-react-native-icons';
+
+const MyComponent = () => (
+  <>
+    <IconContainer icon={ElectricityMediumIcon} size="md" variant="emphasis" color="energy" />
+    <IconContainer icon={BroadbandMediumIcon} size="md" variant="emphasis" color="broadband" />
+    <IconContainer icon={MobileMediumIcon} size="md" variant="emphasis" color="mobile" />
+    <IconContainer icon={InsuranceMediumIcon} size="md" variant="emphasis" color="insurance" />
+    <IconContainer icon={CashbackCardMediumIcon} size="md" variant="emphasis" color="cashback" />
+    <IconContainer icon={EmailMediumIcon} size="md" variant="emphasis" color="pig" />
+  </>
+);
+```
+
+## Props
+
+| Name         | Type                                                                                               | Description                                     | Default    |
+| ------------ | -------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ---------- |
+| `icon`       | `React.ComponentType`                                                                              | Icon component rendered inside the container    | (required) |
+| `size`       | `'sm' \| 'md' \| 'lg'`                                                                             | Size variant (token-based width/height/padding) | `md`       |
+| `radiusNone` | `boolean`                                                                                          | Remove border radius (square container)         | `false`    |
+| `variant`    | `'subtle' \| 'emphasis'`                                                                           | Background emphasis level                       | `subtle`   |
+| `color`      | `'pig' \| 'energy' \| 'broadband' \| 'mobile' \|` <br />`'insurance' \| 'cashback' \| 'highlight'` | Semantic colour family for surface tokens       | `pig`      |
+| `...View`    | React Native `ViewProps`                                                                           | Any additional View props                       | -          |
+
+> Colours resolve to `theme.color.surface.<family>.{subtle|default}` depending on variant.
+
+## Variants
+
+Use the matrix below to compare every combination of size, variant, and color.
+
+<Canvas of={Stories.KitchenSink} />

package/src/components/IconContainer/IconContainer.props.ts

@@ -0,0 +1,17 @@
+import type { ComponentType } from 'react';
+import type { ViewProps } from 'react-native';
+
+export interface IconContainerProps extends ViewProps {
+  /** Icon component to render inside the container */
+  icon: ComponentType;
+  /** Size of the container */
+  size?: 'sm' | 'md' | 'lg';
+  /** If true, removes border radius from the container */
+  radiusNone?: boolean;
+  /** Background style of the container */
+  variant?: 'subtle' | 'emphasis';
+  /** Background color token of the container */
+  color?: 'pig' | 'energy' | 'broadband' | 'mobile' | 'insurance' | 'cashback' | 'highlight';
+}
+
+export default IconContainerProps;

package/src/components/IconContainer/IconContainer.stories.tsx

@@ -0,0 +1,130 @@
+import { Meta, StoryObj } from '@storybook/react-vite';
+import * as Icons from '@utilitywarehouse/hearth-react-native-icons';
+import { IconContainer } from '.';
+import { VariantTitle } from '../../../docs/components';
+import { Box } from '../Box';
+import { Flex } from '../Flex';
+
+type IconKey = keyof typeof Icons;
+
+const meta: Meta<typeof IconContainer> = {
+  title: 'Stories / IconContainer',
+  component: IconContainer,
+  parameters: {
+    layout: 'centered',
+  },
+  argTypes: {
+    icon: {
+      control: 'select',
+      options: Object.keys(Icons),
+      mapping: Icons,
+      description: 'Icon component rendered inside the container',
+    },
+    size: {
+      control: 'select',
+      options: ['sm', 'md', 'lg'],
+      description: 'Size variant',
+    },
+    radiusNone: {
+      control: 'boolean',
+      description: 'Remove border radius (square edges)',
+    },
+    variant: {
+      control: 'select',
+      options: ['subtle', 'emphasis'],
+      description: 'Background emphasis style',
+    },
+    color: {
+      control: 'select',
+      options: ['pig', 'energy', 'broadband', 'mobile', 'insurance', 'cashback', 'highlight'],
+      description: 'Semantic color surface family',
+    },
+  },
+  args: {
+    icon: Icons[Object.keys(Icons)[0] as IconKey],
+    size: 'md',
+    radiusNone: false,
+    variant: 'subtle',
+    color: 'pig',
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Playground: Story = { render: args => <IconContainer {...args} /> };
+
+export const Subtle: Story = {
+  parameters: {
+    controls: { exclude: ['variant'] },
+  },
+  args: {
+    variant: 'subtle',
+  },
+};
+
+export const Emphasis: Story = {
+  parameters: {
+    controls: { exclude: ['variant'] },
+  },
+  args: {
+    variant: 'emphasis',
+  },
+};
+
+export const RadiusNone: Story = {
+  parameters: {
+    controls: { exclude: ['radiusNone'] },
+  },
+  args: {
+    radiusNone: true,
+  },
+};
+
+export const KitchenSink: Story = {
+  parameters: {
+    controls: { exclude: ['radiusNone', 'variant', 'color', 'size'] },
+  },
+  render: ({ icon }) => {
+    const sizes: Array<'sm' | 'md' | 'lg'> = ['sm', 'md', 'lg'];
+    const colors: Array<
+      'pig' | 'energy' | 'broadband' | 'mobile' | 'insurance' | 'cashback' | 'highlight'
+    > = ['pig', 'energy', 'broadband', 'mobile', 'insurance', 'cashback', 'highlight'];
+    return (
+      <Flex direction="column" space="lg">
+        {sizes.map(size => (
+          <Box key={size} gap="300">
+            <VariantTitle title={`Size: ${size.toUpperCase()} / Subtle`}> </VariantTitle>
+            <Flex direction="row" wrap="wrap" space="md">
+              {colors.map(color => (
+                <IconContainer
+                  key={`${size}-subtle-${color}`}
+                  icon={icon}
+                  size={size}
+                  variant="subtle"
+                  color={color}
+                />
+              ))}
+            </Flex>
+            <VariantTitle title={`Size: ${size.toUpperCase()} / Emphasis`}> </VariantTitle>
+            <Flex direction="row" wrap="wrap" space="md">
+              {colors.map(
+                color =>
+                  color !== 'highlight' && (
+                    <IconContainer
+                      key={`${size}-emphasis-${color}`}
+                      icon={icon}
+                      size={size}
+                      variant="emphasis"
+                      color={color}
+                    />
+                  )
+              )}
+            </Flex>
+          </Box>
+        ))}
+      </Flex>
+    );
+  },
+};

package/src/components/IconContainer/IconContainer.tsx

@@ -0,0 +1,180 @@
+import { View } from 'react-native';
+import { StyleSheet, withUnistyles } from 'react-native-unistyles';
+import { Icon } from '../Icon';
+import type IconContainerProps from './IconContainer.props';
+
+const IconContainer = withUnistyles(
+  ({
+    icon: IconComp,
+    size = 'md',
+    radiusNone = false,
+    variant = 'subtle',
+    color = 'pig',
+    style,
+    ...props
+  }: IconContainerProps) => {
+    styles.useVariants({ size, radiusNone, variant, color });
+
+    return (
+      <View style={[styles.container, style]} {...props}>
+        {IconComp ? <Icon as={IconComp} style={styles.icon} /> : null}
+      </View>
+    );
+  }
+);
+
+IconContainer.displayName = 'IconContainer';
+
+const styles = StyleSheet.create(theme => ({
+  container: {
+    alignItems: 'center',
+    justifyContent: 'center',
+    overflow: 'hidden',
+    variants: {
+      size: {
+        sm: {
+          width: theme.components.iconContainer.sm.width,
+          height: theme.components.iconContainer.sm.height,
+          padding: theme.components.iconContainer.sm.padding,
+          borderRadius: theme.components.iconContainer.sm.borderRadiusRounded,
+        },
+        md: {
+          width: theme.components.iconContainer.md.width,
+          height: theme.components.iconContainer.md.height,
+          padding: theme.components.iconContainer.md.padding,
+          borderRadius: theme.components.iconContainer.md.borderRadiusRounded,
+        },
+        lg: {
+          width: theme.components.iconContainer.lg.width,
+          height: theme.components.iconContainer.lg.height,
+          padding: theme.components.iconContainer.lg.padding,
+          borderRadius: theme.components.iconContainer.lg.borderRadiusRounded,
+        },
+      },
+      radiusNone: {
+        true: {
+          borderRadius: 0,
+        },
+        false: {},
+      },
+      variant: {
+        subtle: {},
+        emphasis: {},
+      },
+      color: {
+        pig: {},
+        energy: {},
+        broadband: {},
+        mobile: {},
+        insurance: {},
+        cashback: {},
+        highlight: {},
+      },
+    },
+    compoundVariants: [
+      {
+        variant: 'emphasis',
+        color: 'pig',
+        styles: {
+          backgroundColor: theme.color.surface.pig.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'pig',
+        styles: {
+          backgroundColor: theme.color.surface.pig.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'energy',
+        styles: {
+          backgroundColor: theme.color.surface.energy.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'energy',
+        styles: {
+          backgroundColor: theme.color.surface.energy.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'broadband',
+        styles: {
+          backgroundColor: theme.color.surface.broadband.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'broadband',
+        styles: {
+          backgroundColor: theme.color.surface.broadband.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'mobile',
+        styles: {
+          backgroundColor: theme.color.surface.mobile.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'mobile',
+        styles: {
+          backgroundColor: theme.color.surface.mobile.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'insurance',
+        styles: {
+          backgroundColor: theme.color.surface.insurance.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'insurance',
+        styles: {
+          backgroundColor: theme.color.surface.insurance.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'cashback',
+        styles: {
+          backgroundColor: theme.color.surface.cashback.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'cashback',
+        styles: {
+          backgroundColor: theme.color.surface.cashback.subtle,
+        },
+      },
+      {
+        variant: 'emphasis',
+        color: 'highlight',
+        styles: {
+          backgroundColor: theme.color.surface.highlight.default,
+        },
+      },
+      {
+        variant: 'subtle',
+        color: 'highlight',
+        styles: {
+          backgroundColor: theme.color.surface.highlight.subtle,
+        },
+      },
+    ],
+  },
+  icon: {
+    color: theme.color.icon.primary,
+  },
+}));
+
+export default IconContainer;

package/src/components/IconContainer/index.tsx

@@ -0,0 +1,2 @@
+export { default as IconContainer } from './IconContainer';
+export type { default as IconContainerProps } from './IconContainer.props';