@opentrons/components 0.1.5-alpha.4 → 0.1.6-alpha.2

package/lib/instrument/InstrumentGroup.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import type { InstrumentInfoProps } from './InstrumentInfo';
-export interface InstrumentGroupProps {
-    showMountLabel?: boolean | null | undefined;
-    left?: InstrumentInfoProps | null | undefined;
-    right?: InstrumentInfoProps | null | undefined;
-}
-/**
- * Renders a left and right pipette diagram & info.
- * Takes child `InstrumentInfo` props in `right` and `left` props.
- */
-export declare function InstrumentGroup(props: InstrumentGroupProps): JSX.Element;

package/lib/instrument/InstrumentInfo.d.ts

@@ -1,24 +0,0 @@
-import * as React from 'react';
-import type { Mount } from '../robot-types';
-import type { InstrumentDiagramProps } from './InstrumentDiagram';
-export interface InstrumentInfoProps {
-    /** 'left' or 'right' */
-    mount: Mount;
-    /** if true, show labels 'LEFT PIPETTE' / 'RIGHT PIPETTE' */
-    showMountLabel?: boolean | null;
-    /** human-readable description, eg 'p300 Single-channel' */
-    description: string;
-    /** paired tiprack model */
-    tiprackModel?: string;
-    /** if disabled, pipette & its info are grayed out */
-    isDisabled: boolean;
-    /** specs of mounted pipette */
-    pipetteSpecs?: InstrumentDiagramProps['pipetteSpecs'] | null;
-    /** classes to apply */
-    className?: string;
-    /** classes to apply to the info group child */
-    infoClassName?: string;
-    /** children to display under the info */
-    children?: React.ReactNode;
-}
-export declare function InstrumentInfo(props: InstrumentInfoProps): JSX.Element;

package/lib/instrument/PipetteSelect.d.ts

@@ -1,20 +0,0 @@
-import type { ActionMeta } from 'react-select';
-import type { SelectOption } from '../forms';
-export interface PipetteSelectProps {
-    /** currently selected value, optional in case selecting triggers immediate action */
-    pipetteName?: string | null;
-    /** react-select change handler */
-    onPipetteChange: (pipetteName: string | null, e: ActionMeta<SelectOption>) => void;
-    /** list of pipette names to omit */
-    nameBlocklist?: string[];
-    /** whether or not "None" shows up as the default option */
-    enableNoneOption?: boolean;
-    /** input tabIndex */
-    tabIndex?: string | number;
-    /** classes to apply to the top-level component */
-    className?: string;
-    /** custom id to be applied. likely to be used as a data test id for e2e testing */
-    id?: string;
-    disabled?: boolean;
-}
-export declare const PipetteSelect: (props: PipetteSelectProps) => JSX.Element;

package/lib/instrument/index.d.ts

@@ -1,5 +0,0 @@
-export * from './InfoItem';
-export * from './InstrumentDiagram';
-export * from './InstrumentGroup';
-export * from './InstrumentInfo';
-export * from './PipetteSelect';

package/lib/interaction-enhancers/ClickOutside.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-interface ClickOutsideChildParams {
-    ref: React.RefCallback<Element>;
-}
-export interface ClickOutsideProps {
-    onClickOutside: ((e: MouseEvent) => void) | undefined | null;
-    children: (params: ClickOutsideChildParams) => JSX.Element;
-}
-export declare class ClickOutside extends React.Component<ClickOutsideProps> {
-    wrapperRef: Element | null;
-    constructor(props: ClickOutsideProps);
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    setWrapperRef: (el: Element | null) => void;
-    handleClickOutside: (event: MouseEvent) => void;
-    render(): JSX.Element;
-}
-export {};

package/lib/interaction-enhancers/HandleKeypress.d.ts

@@ -1,27 +0,0 @@
-import * as React from 'react';
-export interface KeypressHandler {
-    key: string;
-    shiftKey?: boolean | null | undefined;
-    onPress: () => unknown;
-}
-export interface HandleKeypressProps {
-    /** array of keypress handlers to attach to the window */
-    handlers: KeypressHandler[];
-    /** optionally call event.preventDefault if keypress is handled */
-    preventDefault?: boolean | null | undefined;
-    /** wrapped children */
-    children?: React.ReactNode;
-}
-/**
- * Keypress handler wrapper component. Takes an array of keypress handlers
- * to call when a given key is pressed on the keyboard. Handler is called on
- * `keyup` event. `event.preventDefault` will be called if a key is handled
- * and `props.preventDefault` is true.
- */
-export declare class HandleKeypress extends React.Component<HandleKeypressProps> {
-    handlePressIfKey: (event: KeyboardEvent) => void;
-    preventDefaultIfKey: (event: KeyboardEvent) => void;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    render(): JSX.Element;
-}

package/lib/interaction-enhancers/index.d.ts

@@ -1,4 +0,0 @@
-export * from './ClickOutside';
-export * from './HandleKeypress';
-export * from './useOnClickOutside';
-export * from './useHover';

package/lib/interaction-enhancers/useHover.d.ts

@@ -1,33 +0,0 @@
-export interface UseHoverOptions {
-    enterDelay?: number;
-    leaveDelay?: number;
-}
-export interface HoverHandlers {
-    onPointerEnter: () => unknown;
-    onPointerLeave: () => unknown;
-}
-export type UseHoverResult = [boolean, HoverHandlers];
-/**
- * Hook to track hover state of an element
- *
- * @param {UseHoverOptions} [options={}] (add an `enterDelay` or `leaveDelay` to the hover state change)
- * @returns {UseHoverResult}
- * @example
- * ```js
- * import { useHover } from '@opentrons/components'
- *
- * export function HoverComponent() {
- *   const [hovered, hoverHandlers] = useHover({
- *     enterDelay: 300,
- *     leaveDelay: 100
- *   })
- *
- *   return (
- *     <span {...hoverHandlers}>
- *       {hovered ? 'Hovered!' : 'Not hovered!'}
- *     </span>
- *   )
- * }
- * ```
- */
-export declare function useHover(options?: UseHoverOptions): UseHoverResult;

package/lib/interaction-enhancers/useOnClickOutside.d.ts

@@ -1,5 +0,0 @@
-import type { RefObject } from 'react';
-export interface UseOnClickOutsideOptions {
-    onClickOutside?: (e: MouseEvent) => unknown;
-}
-export declare const useOnClickOutside: <E extends Element>(options: UseOnClickOutsideOptions) => RefObject<E>;

package/lib/legacy-hardware-sim/LabwareNameOverlay.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-export interface LabwareNameOverlayProps {
-    title: string;
-    subtitle?: string | null | undefined;
-    className?: string;
-}
-/** @deprecated use LabwareDisplayName or custom RobotCoordsForeignDiv */
-export declare function LabwareNameOverlay(props: LabwareNameOverlayProps): JSX.Element;

package/lib/legacy-hardware-sim/ModuleItem.d.ts

@@ -1,18 +0,0 @@
-/// <reference types="react" />
-import type { ModuleModel, DeckSlot } from '@opentrons/shared-data';
-export interface ModuleProps {
-    /** module model */
-    model: ModuleModel;
-    /** display mode: 'default', 'present', 'missing', or 'info' */
-    mode: 'default' | 'present' | 'missing' | 'info';
-    /** slot details of the location of this module */
-    slot: DeckSlot;
-    /** USB port detail of the connected module */
-    usbInfoString?: string;
-}
-/**
- * Legacy App-specific Module Rendering. Removable after Protocol Upload Revamp release
- *
- * @deprecated Use {@link Module}
- */
-export declare function ModuleItem(props: ModuleProps): JSX.Element;

package/lib/legacy-hardware-sim/index.d.ts

@@ -1,2 +0,0 @@
-export * from './LabwareNameOverlay';
-export * from './ModuleItem';

package/lib/lists/ListItem.d.ts

@@ -1,37 +0,0 @@
-import * as React from 'react';
-import type { IconName } from '../icons';
-interface ListItemProps {
-    /** click handler */
-    onClick?: (event: React.SyntheticEvent) => unknown;
-    /** mouse enter handler */
-    onMouseEnter?: (event: React.MouseEvent) => unknown;
-    /** mouse leave handler */
-    onMouseLeave?: (event: React.MouseEvent) => unknown;
-    /** mouse enter handler */
-    onPointerEnter?: (event: React.PointerEvent) => unknown;
-    /** mouse leave handler */
-    onPointerLeave?: (event: React.PointerEvent) => unknown;
-    /** if URL is specified, ListItem is wrapped in a React Router NavLink */
-    url?: string | null;
-    /** if URL is specified NavLink can receive an active class name */
-    activeClassName?: string;
-    /** if URL is specified NavLink can receive an exact property for matching routes */
-    exact?: boolean;
-    /** Additional class name */
-    className?: string;
-    /** if disabled, the onClick handler will be disabled */
-    isDisabled?: boolean;
-    /** name constant of the icon to display */
-    iconName?: IconName;
-    'aria-describedby'?: string;
-    ref?: {
-        current: Element | null;
-    } | ((current: Element | null) => unknown);
-    children?: React.ReactNode;
-}
-/**
- * A styled `<li>` with an optional icon, and an optional url for a React Router `NavLink`
- *
- */
-export declare const ListItem: React.ForwardRefExoticComponent<Pick<ListItemProps, "className" | "exact" | "children" | "aria-describedby" | "onClick" | "onMouseEnter" | "onMouseLeave" | "onPointerEnter" | "onPointerLeave" | "url" | "iconName" | "isDisabled" | "activeClassName"> & React.RefAttributes<HTMLLIElement>>;
-export {};

package/lib/lists/SidePanelGroup.d.ts

@@ -1,18 +0,0 @@
-import * as React from 'react';
-import type { IconName } from '../icons';
-export interface SidePanelGroupProps {
-    /** text of title */
-    title?: string;
-    /** optional icon left of the title */
-    iconName?: IconName;
-    /** children, most likely one or more TitledList */
-    children?: React.ReactNode;
-    /** additional classnames */
-    className?: string;
-    /** disables the whole SidePanelGroup if true */
-    disabled?: boolean;
-}
-/**
- * A component for grouping and titling multiple lists
- */
-export declare function SidePanelGroup(props: SidePanelGroupProps): JSX.Element;

package/lib/lists/TitledList.d.ts

@@ -1,44 +0,0 @@
-import * as React from 'react';
-import type { IconName, IconProps } from '../icons';
-export interface TitledListProps {
-    /** id attribute */
-    id?: string;
-    /** text of title */
-    title: string;
-    /** optional icon left of the title */
-    iconName?: IconName | null | undefined;
-    /** props passed down to icon (`className` and `name` are ignored) */
-    iconProps?: Omit<IconProps, 'name'>;
-    /** optional data test id for the container */
-    'data-test'?: string;
-    /** children must all be `<li>` */
-    children?: React.ReactNode;
-    /** additional classnames */
-    className?: string;
-    /** component with descriptive text about the list */
-    description?: React.ReactNode;
-    /** optional click action (on title div, not children) */
-    onClick?: (event: React.MouseEvent) => unknown;
-    /** optional right click action (on wrapping div) */
-    onContextMenu?: (event: React.MouseEvent) => unknown;
-    /** optional mouseEnter action */
-    onMouseEnter?: (event: React.MouseEvent) => unknown;
-    /** optional mouseLeave action */
-    onMouseLeave?: (event: React.MouseEvent) => unknown;
-    /** caret click action; if defined, list is expandable and carat is visible */
-    onCollapseToggle?: (event: React.MouseEvent) => unknown;
-    /** collapse the list if true (false by default) */
-    collapsed?: boolean;
-    /** set to true when TitledList is selected (eg, user clicked it) */
-    selected?: boolean;
-    /** set to true when TitledList is hovered (but not when its contents are hovered) */
-    hovered?: boolean;
-    /** disables the whole TitledList if true */
-    disabled?: boolean;
-    /** appear disabled, but preserve collapsibility */
-    inert?: boolean;
-}
-/**
- * An ordered list with optional title, icon, and description.
- */
-export declare function TitledList(props: TitledListProps): JSX.Element;

package/lib/lists/index.d.ts

@@ -1,3 +0,0 @@
-export * from './SidePanelGroup';
-export * from './TitledList';
-export * from './ListItem';

package/lib/modals/AlertModal.d.ts

@@ -1,27 +0,0 @@
-import * as React from 'react';
-import type { ButtonProps } from '../buttons';
-import type { IconName } from '../icons';
-export interface AlertModalProps {
-    /** optional handler for overlay click */
-    onCloseClick?: () => unknown;
-    /** optional modal heading */
-    heading?: React.ReactNode;
-    /** optional array of `ButtonProps` for `OutlineButton`s at bottom of modal */
-    buttons?: Array<ButtonProps | null | undefined>;
-    /** modal contents */
-    children: React.ReactNode;
-    /** optional classes to apply */
-    className?: string;
-    /** optional classes to apply */
-    contentsClassName?: string;
-    /** lightens overlay (alert modal over existing modal) */
-    alertOverlay?: boolean;
-    /** override default alert icon */
-    iconName?: IconName | null | undefined;
-    /** restricts scroll outside of Modal when open, true by default */
-    restrictOuterScroll?: boolean;
-}
-/**
- * Generic alert modal with a heading and a set of buttons at the bottom
- */
-export declare function AlertModal(props: AlertModalProps): JSX.Element;

package/lib/modals/BaseModal.d.ts

@@ -1,26 +0,0 @@
-import * as React from 'react';
-import type { StyleProps } from '../primitives';
-export interface BaseModalProps extends StyleProps {
-    /** Overlay color, defaults to `OVERLAY_GRAY_90` */
-    overlayColor?: string;
-    /** Optional close on outside click **/
-    onOutsideClick?: React.MouseEventHandler;
-    /** Optional sticky header */
-    header?: React.ReactNode;
-    /** Option to turn off headerStyles */
-    noHeaderStyles?: boolean;
-    /** Optional sticky footer */
-    footer?: React.ReactNode;
-    /** Modal content */
-    children?: React.ReactNode;
-}
-/**
- * A BaseModal is a layout component for building more specific modals.
- *
- * It includes:
- * - An overlay, customizable with the `overlayColor` prop
- * - A content area, with `overflow-y: auto` and customizable with style props
- * - An optional sticky header
- * - An optional sticky footer
- */
-export declare function BaseModal(props: BaseModalProps): JSX.Element;

package/lib/modals/ContinueModal.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-import type { AlertModalProps } from './AlertModal';
-export interface ContinueModalProps extends Omit<AlertModalProps, 'buttons'> {
-    onCancelClick: () => unknown;
-    onContinueClick: () => unknown;
-}
-/**
- * AlertModal variant to prompt user to "Cancel" or "Continue" a given action
- */
-export declare function ContinueModal(props: ContinueModalProps): JSX.Element;

package/lib/modals/Modal.d.ts

@@ -1,23 +0,0 @@
-import * as React from 'react';
-export interface ModalProps {
-    /** handler to close the modal (attached to `Overlay` onClick) */
-    onCloseClick?: React.MouseEventHandler;
-    /** Optional styled heading **/
-    heading?: string;
-    /** modal contents */
-    children: React.ReactNode;
-    /** classes to apply */
-    className?: string;
-    /** classes to apply to the contents box */
-    contentsClassName?: string;
-    /** lightens overlay (alert modal over existing modal) */
-    alertOverlay?: boolean;
-    /** restricts scroll outside of Modal when open, true by default */
-    restrictOuterScroll?: boolean;
-    innerRef?: React.Ref<HTMLDivElement>;
-}
-/**
- * Base modal component that fills its nearest `display:relative` ancestor
- * with a dark overlay and displays `children` as its contents in a white box
- */
-export declare function Modal(props: ModalProps): JSX.Element;

package/lib/modals/ModalPage.d.ts

@@ -1,16 +0,0 @@
-import * as React from 'react';
-import { Box } from '../primitives';
-import type { TitleBarProps } from '../structure';
-export interface ModalPageProps {
-    /** Props for title bar at top of modal page */
-    titleBar: TitleBarProps;
-    contentsClassName?: string;
-    heading?: React.ReactNode;
-    children?: React.ReactNode;
-    innerProps?: React.ComponentProps<typeof Box>;
-    outerProps?: React.ComponentProps<typeof Box>;
-}
-/**
- * @deprecated Use `Interstitial` instead
- */
-export declare function ModalPage(props: ModalPageProps): JSX.Element;

package/lib/modals/ModalShell.d.ts

@@ -1,25 +0,0 @@
-import * as React from 'react';
-import { StyleProps } from '../primitives';
-export interface ModalShellProps extends StyleProps {
-    /** Modal content */
-    children: React.ReactNode;
-    /** Optional close on outside click **/
-    onOutsideClick?: React.MouseEventHandler;
-    /** Optional sticky header */
-    header?: React.ReactNode;
-    /** Optional sticky footer */
-    footer?: React.ReactNode;
-    /** Optional full page takeover */
-    fullPage?: boolean;
-}
-/**
- * A ModalShell is a layout component for building more specific modals.
- *
- * It includes:
- * - An overlay
- * - A content area, with `overflow-y: auto` and customizable with style props
- * - An optional sticky header
- * - An optional sticky footer
- * - An optional onOutsideClick function
- */
-export declare function ModalShell(props: ModalShellProps): JSX.Element;

package/lib/modals/Overlay.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-import { Flex } from '..';
-export interface OverlayProps extends React.ComponentProps<typeof Flex> {
-    /** optional onClick handler */
-    onClick?: React.MouseEventHandler;
-    alertOverlay?: boolean | null;
-    backgroundColor?: string;
-}
-export declare function Overlay(props: OverlayProps): JSX.Element;

package/lib/modals/SpinnerModal.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-export interface SpinnerModalProps {
-    /** Additional/Override style */
-    contentsClassName?: string;
-    /** Optional message to display as italic text below spinner */
-    message?: string;
-    /** lightens overlay (alert modal over existing modal) */
-    alertOverlay?: boolean;
-}
-/**
- * Spinner Modal with no background and optional message
- */
-export declare function SpinnerModal(props: SpinnerModalProps): JSX.Element;

package/lib/modals/SpinnerModalPage.d.ts

@@ -1,11 +0,0 @@
-import * as React from 'react';
-import { SpinnerModal } from './SpinnerModal';
-import type { TitleBarProps } from '../structure';
-export interface SpinnerModalPageProps extends React.ComponentProps<typeof SpinnerModal> {
-    /** Props for title bar at top of modal page */
-    titleBar: TitleBarProps;
-}
-/**
- * Spinner Modal variant with TitleBar
- */
-export declare function SpinnerModalPage(props: SpinnerModalPageProps): JSX.Element;

package/lib/modals/index.d.ts

@@ -1,9 +0,0 @@
-export * from './Modal';
-export * from './AlertModal';
-export * from './ContinueModal';
-export * from './SpinnerModal';
-export * from './ModalPage';
-export * from './ModalShell';
-export * from './SpinnerModalPage';
-export * from './BaseModal';
-export * from './Overlay';

package/lib/molecules/LocationIcon/__tests__/LocationIcon.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/molecules/LocationIcon/index.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="react" />
-import type { IconName } from '../../icons';
-import type { StyleProps } from '../../primitives';
-interface SlotLocationProps extends StyleProps {
-    /** name constant of the slot to display */
-    slotName: string;
-    iconName?: undefined;
-}
-interface HardwareIconProps extends StyleProps {
-    /** hardware icon name */
-    iconName: IconName;
-    slotName?: undefined;
-}
-type LocationIconProps = SlotLocationProps | HardwareIconProps;
-export declare function LocationIcon({ slotName, iconName, color, ...styleProps }: LocationIconProps): JSX.Element;
-export {};

package/lib/molecules/RoundTab.d.ts

@@ -1,8 +0,0 @@
-import * as React from 'react';
-import { Btn } from '../primitives';
-interface RoundTabProps extends React.ComponentProps<typeof Btn> {
-    isCurrent: boolean;
-    disabled?: boolean;
-}
-export declare function RoundTab({ isCurrent, children, disabled, ...restProps }: RoundTabProps): JSX.Element;
-export {};

package/lib/molecules/index.d.ts

@@ -1,2 +0,0 @@
-export * from './LocationIcon';
-export * from './RoundTab';

package/lib/nav/SidePanel.d.ts

@@ -1,6 +0,0 @@
-import * as React from 'react';
-export interface SidePanelProps {
-    title?: string;
-    children?: React.ReactNode;
-}
-export declare function SidePanel(props: SidePanelProps): JSX.Element;

package/lib/nav/index.d.ts

@@ -1 +0,0 @@
-export * from './SidePanel';