@opentrons/components 0.1.6-alpha.16 → 0.1.6-alpha.17

package/lib/atoms/StyledText/StyledText.d.ts

@@ -1,6 +1,6 @@
 import { Text } from '../../primitives';
 import type * as React from 'react';
-import type { FlattenSimpleInterpolation } from '../../patches';
+import type { FlattenSimpleInterpolation } from 'styled-components';
 declare const helixProductStyleMap: {
     readonly displayBold: {
         readonly as: "h1";

package/lib/hardware-sim/Labware/LabwareRender.d.ts

@@ -1,5 +1,5 @@
 import type * as React from 'react';
-import type { CSSProperties } from '../../patches';
+import type { CSSProperties } from 'styled-components';
 import type { LabwareDefinition2 } from '@opentrons/shared-data';
 import type { HighlightedWellLabels, WellMouseEvent, WellFill, WellStroke, WellGroup } from './labwareInternals/types';
 export declare const WELL_LABEL_OPTIONS: {

package/lib/hardware-sim/Labware/labwareInternals/FilledWells.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import type { LabwareDefinition2 } from '@opentrons/shared-data';
-import type { CSSProperties } from '../../../patches';
+import type { CSSProperties } from 'styled-components';
 export interface FilledWellsProps {
     definition: LabwareDefinition2;
     fillByWell: Record<string, CSSProperties['fill']>;

package/lib/hardware-sim/Labware/labwareInternals/LabwareOutline.d.ts

@@ -1,4 +1,4 @@
-import type { CSSProperties } from '../../../patches';
+import type { CSSProperties } from 'styled-components';
 import type { LabwareDefinition2 } from '@opentrons/shared-data';
 export interface LabwareOutlineProps {
     /** Labware definition to outline */

package/lib/hardware-sim/Labware/labwareInternals/StaticLabware.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import type { LabwareDefinition2 } from '@opentrons/shared-data';
 import type { WellMouseEvent, WellStroke } from './types';
-import type { CSSProperties } from '../../../patches';
+import type { CSSProperties } from 'styled-components';
 export interface StaticLabwareProps {
     /** Labware definition to render */
     definition: LabwareDefinition2;

package/lib/hardware-sim/Labware/labwareInternals/StrokedWells.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import type { LabwareDefinition2 } from '@opentrons/shared-data';
-import type { CSSProperties } from '../../../patches';
+import type { CSSProperties } from 'styled-components';
 export interface StrokedWellProps {
     definition: LabwareDefinition2;
     strokeByWell: Record<string, CSSProperties['stroke']>;

package/lib/instrument/InstrumentDiagram.d.ts

@@ -1,4 +1,4 @@
-import type { FlattenSimpleInterpolation } from '../patches';
+import type { FlattenSimpleInterpolation } from 'styled-components';
 import type { PipetteV2Specs } from '@opentrons/shared-data';
 import type { Mount } from '../robot-types';
 import type { StyleProps } from '..';

package/lib/primitives/Btn.d.ts

@@ -1,4 +1,4 @@
-import type { StyledComponent } from '../patches';
+import type { StyledComponent } from 'styled-components';
 import type { StyleProps } from './types';
 export declare const BUTTON_TYPE_SUBMIT: 'submit';
 export declare const BUTTON_TYPE_RESET: 'reset';

package/lib/primitives/style-props.d.ts

@@ -1,4 +1,4 @@
 import type * as Types from './types';
-import type { CSSObject } from '../patches';
+import type { CSSObject } from 'styled-components';
 export declare const styleProps: (props: Types.StyleProps) => CSSObject;
 export declare const isntStyleProp: (prop: string | React.ReactText) => boolean;

package/lib/primitives/types.d.ts

@@ -1,4 +1,4 @@
-import type { StyledComponent, CSSProperties } from '../patches';
+import type { StyledComponent, CSSProperties } from 'styled-components';
 export interface ColorProps {
     color?: string;
     backgroundColor?: string;

package/lib/styles/typography.d.ts

@@ -1,4 +1,4 @@
-import type { FlattenSimpleInterpolation } from '../patches';
+import type { FlattenSimpleInterpolation } from 'styled-components';
 export declare const FONT_SIZE_HUGE = "3rem";
 export declare const FONT_SIZE_BIG = "1.5rem";
 export declare const FONT_SIZE_HEADER = "1.125rem";

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@opentrons/components",
-  "version": "0.1.6-alpha.16",
+  "version": "0.1.6-alpha.17",
   "description": "React components library for Opentrons' projects",
   "source": "src/index.ts",
   "types": "lib/index.d.ts",
   "style": "src/index.module.css",
-  "main": "lib/index.mjs",
+  "main": "src/index.ts",
   "module": "src/index.ts",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "react-dom": "18.2.0"
   },
   "dependencies": {
-    "@opentrons/shared-data": "0.1.6-alpha.16",
+    "@opentrons/shared-data": "0.1.6-alpha.17",
     "@popperjs/core": "2.1.1",
     "@react-spring/types": "9.6.1",
     "@react-spring/web": "9.6.1",

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/__tests__/utils.test.ts

@@ -0,0 +1,27 @@
+import { describe, it, expect } from 'vitest'
+import { truncateString } from '../utils'
+
+describe('truncateString', () => {
+  it('when an input string less than max length, return the original input', () => {
+    // Note (kj:05/03/2023) the max length and breakPoints are the same as what we use for the Desktop app
+    const str = 'opentrons-dev'
+    const result = truncateString(str, 80, 65)
+    expect(result).toEqual(str)
+  })
+
+  it('when an input string is more than 80 characters, return the truncated string', () => {
+    const str = `Lorem Ipsum Is Simply Dummy Text Of The Printing And Typesetting Industry. Lorem Ipsum Has Been The Industry's Standard Dummy Text Ever Since The 1500s, When An Unknown Printer Took A Galley Of Type And Scrambled It To Make A Type Specimen Book.Py`
+    const result = truncateString(str, 80, 65)
+    const truncatedStr =
+      'Lorem Ipsum Is Simply Dummy Text Of The Printing And Typesetting ...imen Book.Py'
+    expect(result).toEqual(truncatedStr)
+  })
+
+  it('when an input string is more than 80 characters without specifying the break point, return the truncated string', () => {
+    const str = `Lorem Ipsum Is Simply Dummy Text Of The Printing And Typesetting Industry. Lorem Ipsum Has Been The Industry's Standard Dummy Text Ever Since The 1500s, When An Unknown Printer Took A Galley Of Type And Scrambled It To Make A Type Specimen Book.Py`
+    const result = truncateString(str, 80)
+    const truncatedStr =
+      'Lorem Ipsum Is Simply Dummy Text Of The Printing And Typesetting Industry. Lo...'
+    expect(result).toEqual(truncatedStr)
+  })
+})

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/alerts.module.css

@@ -0,0 +1,103 @@
+@import '../index.module.css';
+
+.alert {
+  font-size: var(--fs-body-2);
+  font-weight: var(--fw-regular);
+}
+
+.alert:not(:first-of-type) {
+  border-top: none;
+}
+
+.title_bar {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-between;
+  align-items: center;
+  padding: 0.5rem 1rem;
+  font-weight: var(--fw-semibold);
+}
+
+.title {
+  width: 100%;
+}
+
+.success {
+  border: 1px solid var(--c-success);
+
+  & > .title_bar {
+    background-color: var(--c-bg-success);
+    color: var(--c-success);
+
+    & svg {
+      color: var(--c-success);
+    }
+  }
+}
+
+.info {
+  border: 1px solid var(--c-highlight);
+
+  & > .title_bar {
+    background-color: var(--c-bg-selected);
+    color: var(--c-selected-dark);
+
+    & svg {
+      color: var(--c-highlight);
+    }
+  }
+}
+
+.warning {
+  border: 1px solid var(--c-warning);
+
+  & > .title_bar {
+    background-color: var(--c-warning-light);
+    color: var(--c-warning-dark);
+
+    & svg {
+      fill: var(--c-warning);
+    }
+  }
+}
+
+.error {
+  border: 1px solid var(--c-error);
+
+  & > .title_bar {
+    background-color: var(--c-error-light);
+    color: var(--c-error-dark);
+
+    & svg {
+      fill: var(--c-error);
+    }
+  }
+}
+
+.message {
+  padding: 1rem 3rem;
+  background-color: white;
+
+  & a {
+    text-decoration: underline;
+    color: inherit;
+  }
+
+  &:empty {
+    padding: 0;
+  }
+}
+
+.icon {
+  width: 1.5rem;
+  margin-right: 0.5rem;
+}
+
+.close {
+  width: 2rem;
+  padding: 0.125rem;
+
+  &:hover {
+    background-color: rgba(100, 100, 100, 0.1);
+  }
+}

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/__tests__/Checkbox.test.tsx

@@ -0,0 +1,55 @@
+import type * as React from 'react'
+import { describe, beforeEach, afterEach, vi, expect, it } from 'vitest'
+import { fireEvent, screen } from '@testing-library/react'
+import '@testing-library/jest-dom/vitest'
+import { renderWithProviders } from '../../../testing/utils'
+import { Checkbox } from '..'
+
+const render = (props: React.ComponentProps<typeof Checkbox>) => {
+  return renderWithProviders(<Checkbox {...props} />)[0]
+}
+
+describe('Checkbox', () => {
+  let props: React.ComponentProps<typeof Checkbox>
+
+  beforeEach(() => {
+    props = {
+      onClick: vi.fn(),
+      isChecked: false,
+      labelText: 'fake checkbox label',
+      tabIndex: 1,
+      disabled: false,
+    }
+  })
+
+  afterEach(() => {
+    vi.resetAllMocks()
+  })
+
+  it('renders label with disabled true', () => {
+    props.disabled = true
+    render(props)
+    const checkBoxInput = screen.getByRole('checkbox', {
+      name: 'fake checkbox label',
+    })
+    expect(checkBoxInput).toBeDisabled()
+  })
+
+  it('renders label with correct style - tabIndex 1', () => {
+    props.tabIndex = 1
+    render(props)
+    const checkBoxInput = screen.getByRole('checkbox', {
+      name: 'fake checkbox label',
+    })
+    expect(checkBoxInput).toHaveAttribute('tabindex', '1')
+  })
+
+  it('calls mock function when clicking checkbox', () => {
+    render(props)
+    const checkBoxInput = screen.getByRole('checkbox', {
+      name: 'fake checkbox label',
+    })
+    fireEvent.click(checkBoxInput)
+    expect(props.onClick).toHaveBeenCalled()
+  })
+})

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,
+}