@nypl/design-system-react-components 0.25.0 → 0.25.4

package/src/components/CardEdition/_CardEdition.scss

@@ -1,12 +1,12 @@
 .card-edition {
-  @include space-stack-s;
+  margin-bottom: var(--nypl-space-s);
 
   align-items: flex-start;
-  border: 1px solid var(--ui-gray-light);
+  border: 1px solid var(--nypl-colors-ui-gray-light-cool);
   border-radius: 5px;
   display: flex;
   flex-flow: column wrap;
-  padding: var(--space) var(--space-l);
+  padding: var(--nypl-space-s) var(--nypl-space-l);
 
   &__heading,
   &__footer {
@@ -19,20 +19,20 @@
     justify-content: space-between;
     width: 100%;
 
-    @include breakpoint($breakpoint-medium) {
+    @include breakpoint($nypl-breakpoint-medium) {
       flex-flow: row wrap;
     }
   }
 
   &__columns + &__footer {
-    margin-top: var(--space-xs);
+    margin-top: var(--nypl-space-xs);
   }
 
   &__image {
-    @include space-stack-s;
+    margin-bottom: var(--nypl-space-s);
 
     align-items: center;
-    background-color: var(--ui-gray-xlight);
+    background-color: var(--nypl-colors-ui-gray-x-light-cool);
     display: flex;
     flex: 0 0 150px;
     height: 150px;
@@ -43,9 +43,9 @@
       max-width: 100%;
     }
 
-    @include breakpoint($breakpoint-medium) {
-      @include space-stack-none;
-      @include space-inline-s;
+    @include breakpoint($nypl-breakpoint-medium) {
+      margin-bottom: 0;
+      margin-right: var(--nypl-space-s);
 
       align-self: center;
       width: 150px;
@@ -53,45 +53,44 @@
   }
 
   &__content {
-    @include space-stack-s;
+    margin-bottom: var(--nypl-space-s);
 
     flex: 1 1;
 
-    @include breakpoint($breakpoint-medium) {
-      @include space-inline-s;
-      @include space-stack-none;
+    @include breakpoint($nypl-breakpoint-medium) {
+      margin-right: var(--nypl-space-s);
+      margin-bottom: 0;
     }
   }
 
   &__ctas {
     flex: 0 1 20%;
 
-    @include breakpoint($breakpoint-medium) {
-      @include space-inline-s;
+    @include breakpoint($nypl-breakpoint-medium) {
+      margin-right: var(--nypl-space-s);
     }
   }
 
   &__content + &__ctas {
-    @include space-inline-s;
+    margin-right: var(--nypl-space-s);
   }
 }
 
 // Stories-only styles
 .sb-show-main {
   .var-docs {
-    padding: 0 0 var(--space) 0;
+    padding: 0 0 var(--nypl-space-s) 0;
   }
 
   .example-card-edition {
     .card__content {
       > * {
-        @include space-stack-xxs;
+        margin-bottom: var(--nypl-space-xxs);
       }
     }
 
     .book__callout {
-      // formerly imported with @include heading-xs;
-      font-size: var(--font-size-1);
+      font-size: var(--nypl-fontSizes-1);
       font-weight: 400;
       line-height: 1.15;
       margin: 0 0 0.5em;
@@ -123,12 +122,12 @@
       }
 
       > * {
-        @include space-stack-xxs;
+        margin-bottom: var(--nypl-space-xxs);
       }
     }
 
     .book__filetype {
-      @include space-stack-s;
+      margin-bottom: var(--nypl-space-s);
     }
 
     .book__description {

package/src/components/Chakra/Box.stories.mdx

@@ -7,6 +7,7 @@ import {
   VideoPlayerTypes,
   VideoPlayerAspectRatios,
 } from "../VideoPlayer/VideoPlayerTypes";
+import DSProvider from "../../theme/provider";
 
 <Meta title={getCategory("Box")} component={Box} />
 
@@ -16,7 +17,8 @@ import {
 | ----------------- | ---------- |
 | Added             | `0.24.0`   |
 
-Note: This needs the use of the `DSProvider` component. See the [README](https://github.com/NYPL/nypl-design-system#using-the-design-system-in-your-product)
+Note: This needs the use of the `DSProvider` component. See the
+[README](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/chakra-ui--page#dsprovider)
 for more information.
 
 This component is directly exported from Chakra UI. The `Box` is a simple and
@@ -30,28 +32,25 @@ guide on the Chakra UI site.
   <Story
     name="Box"
     args={{
-      p: "5",
-      bg: "var(--brand-primary)",
+      padding: "s",
+      bg: "var(--nypl-colors-brand-primary)",
       color: "white",
     }}
   >
-    {(args) => (
-      <Box {...args}>
-        So when I look up at the stars, I just wonder...what will they all
-        become someday?
-      </Box>
-    )}
+    {(args) => <Box {...args}>This text is inside a `Box` component.</Box>}
   </Story>
 </Canvas>
 
 ## With VideoPlayer Component Example
 
 <Canvas>
-  <Box borderWidth="3px" padding="6" borderRadius="lg" overflow="hidden">
-    <VideoPlayer
-      videoId="nm-dD2tx6bk"
-      videoType={VideoPlayerTypes.YouTube}
-      aspectRatio={VideoPlayerAspectRatios.SixteenByNine}
-    />
-  </Box>
+  <DSProvider>
+    <Box borderWidth="3px" padding="s" borderRadius="lg" overflow="hidden">
+      <VideoPlayer
+        videoId="nm-dD2tx6bk"
+        videoType={VideoPlayerTypes.YouTube}
+        aspectRatio={VideoPlayerAspectRatios.SixteenByNine}
+      />
+    </Box>
+  </DSProvider>
 </Canvas>

package/src/components/Chakra/Center.stories.mdx

@@ -1,10 +1,12 @@
 import { Meta, Story, Canvas } from "@storybook/addon-docs/blocks";
-import { Box, Center, Square, Circle } from "@chakra-ui/react";
+import { Box, Center, Square, Circle, HStack } from "@chakra-ui/react";
 
 import { getCategory } from "../../utils/componentCategories";
 import Image from "../Image/Image";
+import { ImageSizes } from "../Image/ImageTypes";
 import Icon from "../Icons/Icon";
-import { IconNames, IconColors } from "../Icons/IconTypes";
+import { IconNames, IconColors, IconSizes } from "../Icons/IconTypes";
+import DSProvider from "../../theme/provider";
 
 <Meta title={getCategory("Center, Circle, Square")} component={Center} />
 
@@ -14,7 +16,8 @@ import { IconNames, IconColors } from "../Icons/IconTypes";
 | ----------------- | ---------- |
 | Added             | `0.24.0`   |
 
-Note: This needs the use of the `DSProvider` component. See the [README](https://github.com/NYPL/nypl-design-system#using-the-design-system-in-your-product)
+Note: This needs the use of the `DSProvider` component. See the
+[README](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/chakra-ui--page#dsprovider)
 for more information.
 
 These components are directly exported from Chakra UI. The `Center`, `Circle`,
@@ -29,17 +32,16 @@ guide on the Chakra UI site.
   <Story
     name="Center, Circle, Square"
     args={{
-      p: "5",
-      bg: "var(--brand-primary)",
-      color: "var(--ui-white)",
+      padding: "s",
+      bg: "var(--nypl-colors-brand-primary)",
+      color: "var(--nypl-colors-ui-white)",
     }}
   >
     {(args) => (
       <Box>
         Some text at the beginning.
         <Center {...args}>
-          So when I look up at the stars, I just wonder...what will they all
-          become someday?
+          This text is centered inside a `Center` component.
         </Center>
         Some text at the end.
       </Box>
@@ -49,34 +51,64 @@ guide on the Chakra UI site.
 
 <Canvas>
   <DSProvider>
-    <Center>
-      <Image src="https://placeimg.com/300/400/arch" alt="Centered Image" />
+    <Center border="1px solid" borderColor="var(--nypl-colors-ui-gray-medium)">
+      <Image
+        src="https://placeimg.com/300/400/arch"
+        alt="Centered Image"
+        imageSize={ImageSizes.Medium}
+      />
     </Center>
   </DSProvider>
 </Canvas>
 
 ## Circle
 
-Similar to `Center` but is always a circle!
+This component is similar to the `Center` component but it is always rendered as
+a circle.
 
 <Canvas>
-  <Circle size="50px" bg="var(--ui-test)">
-    <Icon name={IconNames.download} />
-  </Circle>
-  <Circle size="50px" bg="var(--ui-link-primary)">
-    <Icon name={IconNames.check} color={IconColors.ui_white} />
-  </Circle>
+  <DSProvider>
+    <HStack spacing="s">
+      <Circle size="50px" bg="var(--nypl-colors-brand-secondary)">
+        <Icon
+          name={IconNames.Download}
+          color={IconColors.UiWhite}
+          size={IconSizes.Large}
+        />
+      </Circle>
+      <Circle size="50px" bg="var(--nypl-colors-ui-link-primary)">
+        <Icon
+          name={IconNames.Check}
+          color={IconColors.UiWhite}
+          size={IconSizes.Large}
+        />
+      </Circle>
+    </HStack>
+  </DSProvider>
 </Canvas>
 
 ## Square
 
-Similar to `Center` but always has equal height and width.
+This component is similar to the `Circle` component but always has equal height
+and width.
 
 <Canvas>
-  <Square size="50px" bg="var(--ui-test)">
-    <Icon name={IconNames.download} />
-  </Square>
-  <Square size="50px" bg="var(--ui-link-primary)">
-    <Icon name={IconNames.check} color={IconColors.ui_white} />
-  </Square>
+  <DSProvider>
+    <HStack spacing="s">
+      <Square size="50px" bg="var(--nypl-colors-brand-secondary)">
+        <Icon
+          name={IconNames.Download}
+          color={IconColors.UiWhite}
+          size={IconSizes.Large}
+        />
+      </Square>
+      <Square size="50px" bg="var(--nypl-colors-ui-link-primary)">
+        <Icon
+          name={IconNames.Check}
+          color={IconColors.UiWhite}
+          size={IconSizes.Large}
+        />
+      </Square>
+    </HStack>
+  </DSProvider>
 </Canvas>

package/src/components/Chakra/Grid.stories.mdx

@@ -0,0 +1,92 @@
+import { Meta, Story, Canvas } from "@storybook/addon-docs/blocks";
+import { Box } from "@chakra-ui/react";
+import { Grid, GridItem } from "@chakra-ui/react";
+import { getCategory } from "../../utils/componentCategories";
+import DSProvider from "../../theme/provider";
+
+<Meta title={getCategory("Grid")} component={Grid} />
+
+# Grid
+
+| Component Version | DS Version |
+| ----------------- | ---------- |
+| Added             | `0.25.1`   |
+
+Note: This needs the use of the `DSProvider` component. See the
+[README](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/chakra-ui--page#dsprovider)
+for more information.
+
+This component is directly exported from Chakra UI. The `Grid` component is
+useful for grid layouts and offers more complexity and formatting options than
+the DS `SimpleGrid` component. `Grid` is `Box` with `display: grid` and it comes
+with helpful style shorthand. It renders a `div` element.
+
+Details about available props and related child components can be found on the
+[Grid component](https://chakra-ui.com/docs/layout/grid) page on the Chakra UI site.
+
+<Canvas>
+  <Story
+    name="Grid"
+    args={{
+      templateColumns: "repeat(5, 1fr)",
+      gap: "l",
+    }}
+  >
+    {(args) => (
+      <Grid {...args}>
+        <Box w="100%" h="20" bg="brand.primary" />
+        <Box w="100%" h="20" bg="brand.secondary" />
+        <Box w="100%" h="20" bg="brand.primary" />
+        <Box w="100%" h="20" bg="brand.secondary" />
+        <Box w="100%" h="20" bg="brand.primary" />
+        <Box w="100%" h="20" bg="brand.secondary" />
+        <Box w="100%" h="20" bg="brand.primary" />
+        <Box w="100%" h="20" bg="brand.secondary" />
+        <Box w="100%" h="20" bg="brand.primary" />
+        <Box w="100%" h="20" bg="brand.secondary" />
+      </Grid>
+    )}
+  </Story>
+</Canvas>
+
+## Complex Layouts with Grid Child Components
+
+In some layouts, you may need certain grid items to span a specific amount of
+columns or rows instead of an even distribution. To achieve this, you need to
+pass the `colSpan` prop to the `GridItem` component to span across columns and
+also pass the `rowSpan` component to span across rows. You also need to specify
+the `templateColumns` and `templateRows`.
+
+<Canvas>
+  <DSProvider>
+    <Grid
+      height="200px"
+      templateRows="repeat(2, 1fr)"
+      templateColumns="repeat(5, 1fr)"
+      gap="32"
+    >
+      <GridItem
+        rowSpan={2}
+        colSpan={1}
+        bg="var(--nypl-colors-ui-link-primary)"
+      />
+      <GridItem colSpan={2} bg="var(--nypl-colors-ui-success-primary)" />
+      <GridItem colSpan={2} bg="var(--nypl-colors-ui-success-secondary)" />
+      <GridItem colSpan={4} bg="var(--nypl-colors-ui-link-secondary)" />
+    </Grid>
+  </DSProvider>
+</Canvas>
+
+```jsx
+<Grid
+  height="200px"
+  templateRows="repeat(2, 1fr)"
+  templateColumns="repeat(5, 1fr)"
+  gap="32"
+>
+  <GridItem rowSpan={2} colSpan={1} bg="var(--nypl-colors-ui-link-primary)" />
+  <GridItem colSpan={2} bg="var(--nypl-colors-ui-success-primary)" />
+  <GridItem colSpan={2} bg="var(--nypl-colors-ui-success-secondary)" />
+  <GridItem colSpan={4} bg="var(--nypl-colors-ui-link-secondary)" />
+</Grid>
+```

package/src/components/Chakra/Stack.stories.mdx

@@ -4,8 +4,7 @@ import { Box, Stack, HStack, VStack, Circle } from "@chakra-ui/react";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
 import Icon from "../Icons/Icon";
-import { IconNames, IconRotationTypes, IconColors } from "../Icons/IconTypes";
-import Radio from "../Radio/Radio";
+import { IconNames, IconSizes } from "../Icons/IconTypes";
 
 <Meta title={getCategory("Stack, HStack, VStack")} component={Stack} />
 
@@ -15,7 +14,8 @@ import Radio from "../Radio/Radio";
 | ----------------- | ---------- |
 | Added             | `0.24.0`   |
 
-Note: This needs the use of the `DSProvider` component. See the [README](https://github.com/NYPL/nypl-design-system#using-the-design-system-in-your-product)
+Note: This needs the use of the `DSProvider` component. See the
+[README](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/chakra-ui--page#dsprovider)
 for more information.
 
 These components are directly exported from Chakra UI. The `Stack`, `HStack`,
@@ -25,17 +25,21 @@ with spacing between them.
 All available props can be found on the [Style Props](https://chakra-ui.com/docs/features/style-props)
 guide on the Chakra UI site.
 
+In all the following examples, Design System `Icon` components are wrapped in
+Chakra's `Circle` component.
+
 ## Stack
 
-The `Stack` component is the most flexible component because it can stack elements
-both horizontally and vertically through the `direction` prop.
+The `Stack` component is the most flexible component because it can stack
+elements both horizontally and vertically through the `direction` prop and the
+`"row"` and `"column"` values, respectively.
 
 <Canvas>
   <Story
     name="Stack, HStack, VStack"
     args={{
       direction: "column",
-      spacing: "10px",
+      spacing: "s",
     }}
     argTypes={{
       direction: {
@@ -49,13 +53,13 @@ both horizontally and vertically through the `direction` prop.
     {(args) => (
       <Stack {...args}>
         <Circle size="50px" borderColor="ui.black" borderWidth="1px">
-          <Icon name={IconNames.error_filled} />
+          <Icon name={IconNames.ErrorFilled} size={IconSizes.Large} />
         </Circle>
         <Circle size="50px" borderColor="ui.black" borderWidth="1px">
-          <Icon name={IconNames.error_outline} />
+          <Icon name={IconNames.ErrorOutline} size={IconSizes.Large} />
         </Circle>
         <Circle size="50px" borderColor="ui.black" borderWidth="1px">
-          <Icon name={IconNames.check} />
+          <Icon name={IconNames.Check} size={IconSizes.Large} />
         </Circle>
       </Stack>
     )}
@@ -64,30 +68,43 @@ both horizontally and vertically through the `direction` prop.
 
 ## HStack
 
-Stacks components horizontally.
+Stacks components horizontally. This is the same as the `Stack` component with
+a `direction` value of `"row"`.
 
 <Canvas>
   <DSProvider>
-    <HStack>
-      <Radio checked labelText="Tom Nook" name="testChecked" />
-      <Radio labelText="Timmy" name="testChecked" />
-      <Radio labelText="Tommy" name="testChecked" />
-      <Radio labelText="Celeste" name="testChecked" />
+    <HStack spacing="s">
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.ErrorFilled} size={IconSizes.Large} />
+      </Circle>
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.ErrorOutline} size={IconSizes.Large} />
+      </Circle>
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.Check} size={IconSizes.Large} />
+      </Circle>
     </HStack>
   </DSProvider>
 </Canvas>
 
 ## VStack
 
-Stacks components vertically.
+Stacks components vertically. This is the same as the `Stack` component with
+a `direction` value of `"column"`.Pass in a value to the `align` prop to align
+all the elements in the stack.
 
 <Canvas>
   <DSProvider>
-    <VStack>
-      <Radio isChecked labelText="Tom Nook" name="testChecked" />
-      <Radio labelText="Timmy" name="testChecked" />
-      <Radio labelText="Tommy" name="testChecked" />
-      <Radio labelText="Celeste" name="testChecked" />
+    <VStack align="left" spacing="s">
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.ErrorFilled} size={IconSizes.Large} />
+      </Circle>
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.ErrorOutline} size={IconSizes.Large} />
+      </Circle>
+      <Circle size="50px" borderColor="ui.black" borderWidth="1px">
+        <Icon name={IconNames.Check} size={IconSizes.Large} />
+      </Circle>
     </VStack>
   </DSProvider>
 </Canvas>

package/src/components/Checkbox/Checkbox.stories.mdx

@@ -38,7 +38,7 @@ import { onChangeDefault } from "./Checkbox";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.1.0`    |
-| Latest            | `0.25.0`   |
+| Latest            | `0.25.3`   |
 
 <Description of={Checkbox} />
 
@@ -49,16 +49,18 @@ cause an accessibility violation if none is present.
   <Story
     name="Checkbox"
     args={{
-      labelText: "Test Label",
-      showLabel: true,
+      helperText: "This is the helper text!",
       id: "test_id",
-      name: "test_name",
-      value: "1",
+      invalidText: "This is the error text :(",
       isDisabled: false,
-      isRequired: false,
+      isIndeterminate: false,
       isInvalid: false,
-      helperText: "This is the helper text!",
-      errorText: "This is the error text :(",
+      isRequired: false,
+      labelText: "Test Label",
+      name: "test_name",
+      showHelperInvalidText: true,
+      showLabel: true,
+      value: "1",
     }}
   >
     {(args) => <Checkbox {...args} />}
@@ -69,9 +71,29 @@ cause an accessibility violation if none is present.
 
 ## Checked
 
+Note that the `isChecked` property in this example is set to `true` and clicking
+on it won't remove the checkmark; the `isChecked` prop must now be controlled
+and removed manually by the parent component that controls this state.
+
 <Canvas>
   <DSProvider>
-    <Checkbox labelText="I am checked" isChecked value="1" />
+    <Checkbox id="isChecked" labelText="I am checked" isChecked value="1" />
+  </DSProvider>
+</Canvas>
+
+## Indeterminate
+
+Note: This state only changes the icon through the `isIndeterminate` prop. This
+does not affect whether the checkbox is checked. The `isIndeterminate` prop must
+now be controlled and removed by the parent component in order to remove this state.
+
+<Canvas>
+  <DSProvider>
+    <Checkbox
+      id="indeterminate"
+      labelText="I am indeterminate"
+      isIndeterminate
+    />
   </DSProvider>
 </Canvas>
 
@@ -126,9 +148,9 @@ cause an accessibility violation if none is present.
 <Canvas>
   <DSProvider>
     <Checkbox
-      name="testErrorText"
+      name="testinvalidText"
       labelText="I have error text"
-      errorText="I am the error text for this Checkbox"
+      invalidText="I am the error text for this Checkbox"
       isInvalid
     />
   </DSProvider>