@opentrons/components 0.1.6-alpha.2 → 0.1.6-alpha.21

package/Makefile

@@ -5,7 +5,7 @@ port ?= 6060
 
 # These variables can be overriden when make is invoked to customize the
 # behavior of jest
-tests ?=
+tests ?= src
 cov_opts ?= --coverage=true
 test_opts ?=
 
@@ -31,6 +31,10 @@ lib: export NODE_ENV := production
 lib:
 	yarn vite build
 
+.PHONY: build-ts
+build-ts:
+	yarn tsc --build --emitDeclarationOnly
+
 # development
 #####################################################################
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@opentrons/components",
-  "version": "0.1.6-alpha.2",
+  "version": "0.1.6-alpha.21",
   "description": "React components library for Opentrons' projects",
   "source": "src/index.ts",
   "types": "lib/index.d.ts",
   "style": "src/index.module.css",
-  "main": "lib/opentrons-components.js",
+  "main": "src/index.ts",
   "module": "src/index.ts",
   "repository": {
     "type": "git",
@@ -19,12 +19,10 @@
   "homepage": "https://github.com/Opentrons/opentrons#readme",
   "peerDependencies": {
     "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "react-router-dom": "5.3.4",
-    "@types/react-router-dom": "5.3.3"
+    "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@opentrons/shared-data": "0.1.6-alpha.2",
+    "@opentrons/shared-data": "0.1.6-alpha.21",
     "@popperjs/core": "2.1.1",
     "@react-spring/types": "9.6.1",
     "@react-spring/web": "9.6.1",
@@ -33,8 +31,9 @@
     "@types/styled-components": "^5.1.26",
     "@types/webpack-env": "^1.16.0",
     "classnames": "2.2.5",
-    "interactjs": "^1.10.17",
+    "interactjs": "^1.10.27",
     "lodash": "4.17.21",
+    "react-i18next": "14.0.0",
     "react-popper": "1.0.0",
     "react-remove-scroll": "2.4.3",
     "react-select": "5.4.0",

package/src/__mocks__/file.js

@@ -0,0 +1,10 @@
+// File transformer for Jest
+// Makes asset filenames appear in snapshots
+// see https://facebook.github.io/jest/docs/en/webpack.html
+const path = require('path')
+
+module.exports = {
+  process(src, filename, config, options) {
+    return 'module.exports = ' + JSON.stringify(path.basename(filename))
+  },
+}

package/src/alerts/AlertItem.stories.tsx

@@ -0,0 +1,49 @@
+import type * as React from 'react'
+import { AlertItem } from './AlertItem'
+
+import type { Story, Meta } from '@storybook/react'
+
+export default {
+  title: 'Library/Molecules/AlertItem',
+  component: AlertItem,
+  argTypes: { onCloseClick: { action: 'clicked' } },
+} as Meta
+
+const Template: Story<React.ComponentProps<typeof AlertItem>> = args => (
+  <AlertItem {...args} />
+)
+
+export const Basic = Template.bind({})
+Basic.args = {
+  type: 'success',
+  title: 'good job!',
+}
+
+export const OverriddenIcon = Template.bind({})
+OverriddenIcon.args = {
+  type: 'info',
+  title: 'Alert with overridden icon',
+  icon: { name: 'pause-circle' },
+}
+
+export const Stackable: Story<
+  React.ComponentProps<typeof AlertItem>
+> = args => (
+  <div>
+    <Template {...args} type="warning" title={'Warning with close button'} />
+    <Template
+      {...args}
+      onCloseClick={undefined}
+      type="warning"
+      title={'Warning with no close button'}
+    />
+    <Template {...args} type="warning" title={'Warning with no children'} />
+    <Template
+      {...args}
+      type="warning"
+      title={'Warning with React Node children'}
+    >
+      <p>Some additional info</p>
+    </Template>
+  </div>
+)

package/src/alerts/AlertItem.tsx

@@ -0,0 +1,85 @@
+import type * as React from 'react'
+import cx from 'classnames'
+import { Icon } from '../icons'
+import { IconButton } from '../buttons'
+import styles from './alerts.module.css'
+
+import type { IconProps } from '../icons'
+
+export type AlertType = 'success' | 'warning' | 'error' | 'info'
+
+export interface AlertItemProps {
+  /** name constant of the icon to display */
+  type: AlertType
+  /** title/main message of colored alert bar */
+  title: React.ReactNode
+  /** Alert message body contents */
+  children?: React.ReactNode
+  /** Additional class name */
+  className?: string
+  /** optional handler to show close button/clear alert  */
+  onCloseClick?: () => unknown
+  /** Override the default Alert Icon */
+  icon?: IconProps
+}
+
+/**
+ * Alert overlay,
+ * change style and icon by using type 'success' 'warning' 'error'
+ */
+
+const ALERT_PROPS_BY_TYPE: Record<
+  AlertType,
+  { icon: IconProps; className: string }
+> = {
+  success: {
+    icon: { name: 'check-circle' },
+    className: styles.success,
+  },
+  error: {
+    icon: { name: 'alert-circle' },
+    className: styles.error,
+  },
+  warning: {
+    icon: { name: 'alert-circle' },
+    className: styles.warning,
+  },
+  info: {
+    icon: { name: 'information' },
+    className: styles.info,
+  },
+}
+
+/**
+ * @deprecated Use 'Banner' instead
+ */
+
+export function AlertItem(props: AlertItemProps): JSX.Element {
+  const alertProps = ALERT_PROPS_BY_TYPE[props.type]
+  const icon = props.icon ? props.icon : alertProps.icon
+  const className = cx(styles.alert, alertProps.className, props.className)
+
+  const iconProps = {
+    ...icon,
+    className: styles.icon,
+  }
+
+  return (
+    <div className={className}>
+      <div className={styles.title_bar}>
+        <Icon {...iconProps} />
+        <span className={styles.title} data-testid="alert_item_title">
+          {props.title}
+        </span>
+        {props.onCloseClick && (
+          <IconButton
+            name="close"
+            onClick={props.onCloseClick}
+            className={styles.close}
+          />
+        )}
+      </div>
+      {props.children && <div className={styles.message}>{props.children}</div>}
+    </div>
+  )
+}

package/src/alerts/index.ts

@@ -0,0 +1,3 @@
+// alert components
+
+export * from './AlertItem'

package/src/atoms/Checkbox/Checkbox.stories.tsx

@@ -0,0 +1,24 @@
+import { Checkbox } from './index'
+
+import type { StoryObj, Meta } from '@storybook/react'
+
+const meta: Meta<typeof Checkbox> = {
+  title: 'Library/Atoms/Checkbox',
+  component: Checkbox,
+}
+
+type Story = StoryObj<typeof Checkbox>
+
+export const Basic: Story = {
+  args: {
+    isChecked: true,
+    labelText: 'Button Text',
+    onClick: () => {
+      console.log('clicked')
+    },
+    tabIndex: 1,
+    disabled: false,
+  },
+}
+
+export default meta

package/src/atoms/Checkbox/index.tsx

@@ -0,0 +1,127 @@
+import type * as React from 'react'
+import { css } from 'styled-components'
+import { COLORS, BORDERS } from '../../helix-design-system'
+import { Flex } from '../../primitives'
+import { Icon } from '../../icons'
+import {
+  ALIGN_CENTER,
+  CURSOR_AUTO,
+  CURSOR_POINTER,
+  DIRECTION_ROW,
+  FLEX_MAX_CONTENT,
+  JUSTIFY_SPACE_BETWEEN,
+} from '../../styles'
+import { RESPONSIVENESS, SPACING } from '../../ui-style-constants'
+import { StyledText } from '../StyledText'
+
+export interface CheckboxProps {
+  /** checkbox is checked if value is true */
+  isChecked: boolean
+  /** label text that describes the option */
+  labelText: string
+  /** callback click/tap handler */
+  onClick: React.MouseEventHandler
+  /** html tabindex property */
+  tabIndex?: number
+  /** if disabled is true, mouse events will not trigger onClick callback */
+  disabled?: boolean
+  /** optional borderRadius type */
+  type?: 'round' | 'neutral'
+  /** optional width for helix */
+  width?: string
+}
+export function Checkbox(props: CheckboxProps): JSX.Element {
+  const {
+    isChecked,
+    labelText,
+    onClick,
+    tabIndex = 0,
+    disabled = false,
+    width = FLEX_MAX_CONTENT,
+    type = 'round',
+  } = props
+
+  const CHECKBOX_STYLE = css`
+    width: ${width};
+    grid-gap: ${SPACING.spacing12};
+    border: none;
+    align-items: ${ALIGN_CENTER};
+    flex-direction: ${DIRECTION_ROW};
+    color: ${isChecked ? COLORS.white : COLORS.black90};
+    background-color: ${isChecked ? COLORS.blue50 : COLORS.blue30};
+    border-radius: ${type === 'round'
+      ? BORDERS.borderRadiusFull
+      : BORDERS.borderRadius8};
+    padding: ${SPACING.spacing12} ${SPACING.spacing16};
+    justify-content: ${JUSTIFY_SPACE_BETWEEN};
+    cursor: ${CURSOR_POINTER};
+
+    &:active {
+      background-color: ${isChecked ? COLORS.blue55 : COLORS.blue40};
+    }
+    &:focus-visible {
+      background-color: ${isChecked ? COLORS.blue50 : COLORS.blue35};
+      outline: 3px ${BORDERS.styleSolid} ${COLORS.blue50};
+      outline-offset: 2px;
+    }
+    &:disabled {
+      background-color: ${COLORS.grey35};
+      color: ${COLORS.grey50};
+    }
+    &:hover {
+      background-color: ${isChecked ? COLORS.blue55 : COLORS.blue35};
+    }
+
+    @media ${RESPONSIVENESS.touchscreenMediaQuerySpecs} {
+      padding: ${SPACING.spacing20};
+      border-radius: ${BORDERS.borderRadius16};
+      width: 100%;
+      cursor: ${CURSOR_AUTO};
+    }
+  `
+
+  return (
+    <Flex
+      as="button"
+      role="checkbox"
+      onClick={onClick}
+      tabIndex={tabIndex}
+      disabled={disabled}
+      css={CHECKBOX_STYLE}
+    >
+      <StyledText desktopStyle="bodyDefaultRegular" oddStyle="bodyTextSemiBold">
+        {labelText}
+      </StyledText>
+      <Check isChecked={isChecked} />
+    </Flex>
+  )
+}
+
+interface CheckProps {
+  isChecked: boolean
+  color?: string
+  disabled?: boolean
+}
+export function Check(props: CheckProps): JSX.Element {
+  const { isChecked, color = COLORS.white, disabled = false } = props
+  return isChecked ? (
+    <Flex css={CHECK_STYLE}>
+      <Icon name="ot-checkbox" color={color} />
+    </Flex>
+  ) : (
+    <Flex
+      css={CHECK_STYLE}
+      border={`2px solid ${disabled ? COLORS.grey40 : COLORS.black90}`}
+      borderRadius={BORDERS.borderRadius4}
+    />
+  )
+}
+
+const CHECK_STYLE = css`
+  width: 1rem;
+  height: 1rem;
+  @media ${RESPONSIVENESS.touchscreenMediaQuerySpecs} {
+    width: 1.75rem;
+    height: 1.75rem;
+  }
+`

package/src/atoms/CheckboxField/CheckboxField.stories.tsx

@@ -0,0 +1,30 @@
+import * as React from 'react'
+import { CheckboxField as CheckboxFieldComponent } from './index'
+
+import type { Story, Meta } from '@storybook/react'
+
+export default {
+  title: 'Library/Atoms/Checkbox Field',
+  component: CheckboxFieldComponent,
+} as Meta
+
+const Template: Story<
+  React.ComponentProps<typeof CheckboxFieldComponent>
+> = args => {
+  const [isChecked, setIsChecked] = React.useState<boolean>(false)
+  return (
+    <CheckboxFieldComponent
+      {...args}
+      onChange={e => {
+        setIsChecked(!isChecked)
+        args.onChange(e)
+      }}
+      value={isChecked}
+    />
+  )
+}
+export const CheckboxField = Template.bind({})
+CheckboxField.args = {
+  label: 'Remember this setting?',
+  isIndeterminate: false,
+}

package/src/atoms/CheckboxField/index.tsx

@@ -0,0 +1,171 @@
+import type * as React from 'react'
+import { css } from 'styled-components'
+import { SPACING, TYPOGRAPHY } from '../../ui-style-constants'
+import { COLORS, BORDERS } from '../../helix-design-system'
+import { Flex, Box } from '../../primitives'
+import { Icon } from '../../icons'
+import {
+  ALIGN_CENTER,
+  CURSOR_AUTO,
+  CURSOR_POINTER,
+  JUSTIFY_CENTER,
+} from '../../styles'
+
+export interface CheckboxFieldProps {
+  /** change handler */
+  onChange: React.ChangeEventHandler
+  /** checkbox is checked if value is true */
+  value?: boolean
+  /** name of field in form */
+  name?: string
+  /** label text for checkbox */
+  label?: React.ReactNode
+  /** checkbox is disabled if value is true */
+  disabled?: boolean
+  /** html tabindex property */
+  tabIndex?: number
+  /** props passed into label div. TODO IMMEDIATELY what is the Flow type? */
+  labelProps?: React.ComponentProps<'div'>
+  /** if true, render indeterminate icon */
+  isIndeterminate?: boolean
+}
+
+const INPUT_STYLE = css`
+  position: absolute;
+  overflow: hidden;
+  clip: rect(0 0 0 0);
+  height: 1px;
+  width: 1px;
+  margin: -1px;
+  padding: 0;
+  border: 0;
+`
+const OUTER_STYLE = css`
+  font-size: var(--fs-body-1); /* from legacy --font-form-default */
+  font-weight: var(--fw-regular); /* from legacy --font-form-default */
+  color: var(--c-font-dark); /* from legacy --font-form-default */
+
+  display: flex;
+  align-items: ${ALIGN_CENTER};
+  line-height: 1;
+`
+
+const INNER_STYLE_VALUE = css`
+  width: ${SPACING.spacing20};
+  min-width: ${SPACING.spacing20};
+  color: ${COLORS.blue50};
+  display: flex;
+  border-radius: ${BORDERS.borderRadius2};
+  justify-content: ${JUSTIFY_CENTER};
+  align-items: ${ALIGN_CENTER};
+
+  &:hover {
+    cursor: ${CURSOR_POINTER};
+    color: ${COLORS.blue55};
+  }
+
+  &:active {
+    color: ${COLORS.blue60};
+  }
+
+  &:focus {
+    box-shadow: 0 0 0 3px ${COLORS.blue50};
+  }
+  &:disabled {
+    color: ${COLORS.blue60};
+  }
+`
+
+const INNER_STYLE_NO_VALUE = css`
+  width: ${SPACING.spacing20};
+  min-width: ${SPACING.spacing20};
+  color: ${COLORS.grey50};
+  display: flex;
+  border-radius: ${BORDERS.borderRadius2};
+  justify-content: ${JUSTIFY_CENTER};
+  align-items: ${ALIGN_CENTER};
+
+  &:hover {
+    cursor: ${CURSOR_POINTER};
+    color: ${COLORS.grey60};
+  }
+
+  &:active {
+    color: ${COLORS.grey60};
+  }
+
+  &:focus {
+    box-shadow: 0 0 0 3px ${COLORS.blue50};
+  }
+
+  &:disabled {
+    color: ${COLORS.grey50};
+    cursor: ${CURSOR_AUTO};
+  }
+`
+
+const LABEL_TEXT_STYLE = css`
+  font-size: ${TYPOGRAPHY.fontSizeP};
+  font-weight: ${TYPOGRAPHY.fontWeightRegular};
+  color: ${COLORS.black90};
+  flex: 0 0 auto;
+  padding: ${SPACING.spacing8} ${SPACING.spacing8};
+
+  &:empty {
+    padding: 0;
+  }
+`
+
+export function CheckboxField(props: CheckboxFieldProps): JSX.Element {
+  const {
+    onChange,
+    value,
+    name,
+    label,
+    disabled,
+    tabIndex = 0,
+    isIndeterminate,
+  } = props
+  const indeterminate = isIndeterminate ?? false ? 'true' : undefined
+
+  return (
+    <label css={OUTER_STYLE}>
+      {props.isIndeterminate ?? false ? (
+        <Flex
+          alignItems={ALIGN_CENTER}
+          justifyContent={JUSTIFY_CENTER}
+          borderRadius={BORDERS.borderRadius2}
+          backgroundColor={COLORS.grey30}
+          size="1.25rem"
+        >
+          <Box
+            height="1.5px"
+            width="0.375rem"
+            backgroundColor={COLORS.grey50}
+          />
+        </Flex>
+      ) : (
+        <Icon
+          css={value ?? false ? INNER_STYLE_VALUE : INNER_STYLE_NO_VALUE}
+          name={value ?? false ? 'ot-checkbox' : 'checkbox-blank-outline'}
+          width="100%"
+          data-testid="CheckboxField_icon"
+        />
+      )}
+      <input
+        css={INPUT_STYLE}
+        type="checkbox"
+        name={name}
+        checked={(value ?? false) || false}
+        disabled={disabled}
+        onChange={onChange}
+        tabIndex={tabIndex}
+        /* @ts-expect-error */
+        indeterminate={indeterminate}
+      />
+      <Box css={LABEL_TEXT_STYLE} tabIndex={tabIndex}>
+        {label}
+      </Box>
+    </label>
+  )
+}

package/src/atoms/Chip/Chip.stories.tsx

@@ -0,0 +1,59 @@
+import { Flex } from '../../primitives'
+import { COLORS } from '../../helix-design-system'
+import { SPACING, VIEWPORT } from '../../ui-style-constants'
+import { Chip as ChipComponent } from '.'
+import type { Meta, StoryObj } from '@storybook/react'
+
+const meta: Meta<typeof ChipComponent> = {
+  title: 'Library/Atoms/Chip',
+  argTypes: {
+    type: {
+      options: ['error', 'info', 'neutral', 'success', 'warning'],
+      control: {
+        type: 'select',
+      },
+    },
+    hasIcon: {
+      control: {
+        type: 'boolean',
+      },
+    },
+    chipSize: {
+      options: ['medium', 'small'],
+      control: {
+        type: 'select',
+      },
+    },
+    iconName: {
+      options: ['connection-status', 'ot-check', 'ot-alert'],
+      control: {
+        type: 'select',
+      },
+    },
+  },
+  component: ChipComponent,
+  parameters: VIEWPORT.touchScreenViewport,
+  decorators: [
+    Story => (
+      <Flex
+        padding={SPACING.spacing16}
+        backgroundColor={COLORS.grey50}
+        width="59rem"
+      >
+        <Story />
+      </Flex>
+    ),
+  ],
+}
+
+export default meta
+type Story = StoryObj<typeof ChipComponent>
+
+export const Chip: Story = {
+  args: {
+    type: 'success',
+    text: 'Chip component',
+    hasIcon: true,
+    chipSize: 'medium',
+  },
+}