@opentrons/components 0.1.6-alpha.6 → 0.1.6-alpha.8

package/lib/hardware-sim/BaseDeck/SingleSlotFixture.d.ts

@@ -0,0 +1,12 @@
+import type * as React from 'react';
+import type { CutoutId, DeckDefinition, ModuleType } from '@opentrons/shared-data';
+interface SingleSlotFixtureProps extends React.SVGProps<SVGGElement> {
+    cutoutId: CutoutId;
+    deckDefinition: DeckDefinition;
+    moduleType?: ModuleType;
+    fixtureBaseColor?: React.SVGProps<SVGPathElement>['fill'];
+    slotClipColor?: React.SVGProps<SVGPathElement>['stroke'];
+    showExpansion?: boolean;
+}
+export declare function SingleSlotFixture(props: SingleSlotFixtureProps): JSX.Element | null;
+export {};

package/lib/hardware-sim/BaseDeck/SlotBase.d.ts

@@ -0,0 +1,2 @@
+import type * as React from 'react';
+export declare function SlotBase(props: React.SVGProps<SVGPathElement>): JSX.Element;

package/lib/hardware-sim/BaseDeck/SlotClip.d.ts

@@ -0,0 +1,2 @@
+import type * as React from 'react';
+export declare function SlotClip(props: React.SVGProps<SVGPathElement>): JSX.Element;

package/lib/hardware-sim/BaseDeck/StagingAreaFixture.d.ts

@@ -0,0 +1,13 @@
+import type * as React from 'react';
+import type { DeckDefinition, ModuleType } from '@opentrons/shared-data';
+export type StagingAreaLocation = 'cutoutA3' | 'cutoutB3' | 'cutoutC3' | 'cutoutD3';
+interface StagingAreaFixtureProps extends React.SVGProps<SVGGElement> {
+    cutoutId: StagingAreaLocation;
+    deckDefinition: DeckDefinition;
+    moduleType?: ModuleType;
+    fixtureBaseColor?: React.SVGProps<SVGPathElement>['fill'];
+    slotClipColor?: React.SVGProps<SVGPathElement>['stroke'];
+    showExtensions?: boolean;
+}
+export declare function StagingAreaFixture(props: StagingAreaFixtureProps): JSX.Element | null;
+export {};

package/lib/hardware-sim/BaseDeck/WasteChuteFixture.d.ts

@@ -0,0 +1,20 @@
+import type * as React from 'react';
+import type { WASTE_CHUTE_CUTOUT, DeckDefinition, ModuleType } from '@opentrons/shared-data';
+interface WasteChuteFixtureProps extends React.SVGProps<SVGGElement> {
+    cutoutId: typeof WASTE_CHUTE_CUTOUT;
+    deckDefinition: DeckDefinition;
+    moduleType?: ModuleType;
+    fixtureBaseColor?: React.SVGProps<SVGPathElement>['fill'];
+    wasteChuteColor?: string;
+    showExtensions?: boolean;
+}
+export declare function WasteChuteFixture(props: WasteChuteFixtureProps): JSX.Element | null;
+interface WasteChuteProps {
+    wasteIconColor: string;
+    backgroundColor: string;
+}
+/**
+ * a deck map foreign object representing the physical location of the waste chute connected to the deck
+ */
+export declare function WasteChute(props: WasteChuteProps): JSX.Element;
+export {};

package/lib/hardware-sim/BaseDeck/WasteChuteStagingAreaFixture.d.ts

@@ -0,0 +1,14 @@
+import type * as React from 'react';
+import { WASTE_CHUTE_CUTOUT } from '@opentrons/shared-data';
+import type { DeckDefinition, ModuleType } from '@opentrons/shared-data';
+interface WasteChuteStagingAreaFixtureProps extends React.SVGProps<SVGGElement> {
+    cutoutId: typeof WASTE_CHUTE_CUTOUT;
+    deckDefinition: DeckDefinition;
+    moduleType?: ModuleType;
+    fixtureBaseColor?: React.SVGProps<SVGPathElement>['fill'];
+    slotClipColor?: React.SVGProps<SVGPathElement>['stroke'];
+    wasteChuteColor?: string;
+    showExtensions?: boolean;
+}
+export declare function WasteChuteStagingAreaFixture(props: WasteChuteStagingAreaFixtureProps): JSX.Element | null;
+export {};

package/lib/hardware-sim/BaseDeck/__fixtures__/index.d.ts

@@ -0,0 +1,4 @@
+import type { DeckConfiguration } from '@opentrons/shared-data';
+export declare const STANDARD_SLOT_DECK_CONFIG_FIXTURE: DeckConfiguration;
+export declare const EXTENDED_DECK_CONFIG_FIXTURE: DeckConfiguration;
+export declare const WASTE_CHUTE_DECK_CONFIG_FIXTURE: DeckConfiguration;

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

@@ -0,0 +1,5 @@
+export * from './BaseDeck';
+export * from './SingleSlotFixture';
+export * from './StagingAreaFixture';
+export * from './WasteChuteFixture';
+export * from './WasteChuteStagingAreaFixture';

package/lib/hardware-sim/Deck/DeckFromLayers.d.ts

@@ -0,0 +1,10 @@
+import type { RobotType } from '@opentrons/shared-data';
+export interface DeckFromLayersProps {
+    robotType: RobotType;
+    layerBlocklist: string[];
+}
+/**
+ * a component that renders an OT-2 deck from the V3 deck definition layers property
+ * takes a robot type prop to protect against an attempted Flex render
+ */
+export declare function DeckFromLayers(props: DeckFromLayersProps): JSX.Element | null;

package/lib/hardware-sim/Deck/FlexTrash.d.ts

@@ -0,0 +1,14 @@
+import type { RobotType } from '@opentrons/shared-data';
+export type TrashCutoutId = 'cutoutA1' | 'cutoutB1' | 'cutoutC1' | 'cutoutD1' | 'cutoutA3' | 'cutoutB3' | 'cutoutC3' | 'cutoutD3';
+interface FlexTrashProps {
+    robotType: RobotType;
+    trashIconColor: string;
+    backgroundColor: string;
+    trashCutoutId?: TrashCutoutId;
+}
+/**
+ * Component to render Opentrons Flex trash
+ * For use as a RobotWorkspace child component
+ */
+export declare const FlexTrash: ({ robotType, trashIconColor, backgroundColor, trashCutoutId, }: FlexTrashProps) => JSX.Element | null;
+export {};

package/lib/hardware-sim/Deck/MoveLabwareOnDeck.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import type { LoadedLabware, LoadedModule, LabwareDefinition2, LabwareLocation, RobotType, DeckConfiguration } from '@opentrons/shared-data';
+import type { StyleProps } from '../../primitives';
+interface MoveLabwareOnDeckProps extends StyleProps {
+    robotType: RobotType;
+    movedLabwareDef: LabwareDefinition2;
+    initialLabwareLocation: LabwareLocation;
+    finalLabwareLocation: LabwareLocation;
+    loadedModules: LoadedModule[];
+    loadedLabware: LoadedLabware[];
+    deckConfig: DeckConfiguration;
+    backgroundItems?: React.ReactNode;
+    deckFill?: string;
+}
+export declare function MoveLabwareOnDeck(props: MoveLabwareOnDeckProps): JSX.Element | null;
+export {};

package/lib/hardware-sim/Deck/OT2Layers.d.ts

@@ -0,0 +1,10 @@
+export declare function FixedBase(): JSX.Element;
+export declare function FixedTrash(): JSX.Element;
+export declare function DoorStops(): JSX.Element;
+export declare function MetalFrame(): JSX.Element;
+export declare function RemovableDeckOutline(): JSX.Element;
+export declare function SlotRidges(): JSX.Element;
+export declare function SlotNumbers(): JSX.Element;
+export declare function CalibrationMarkings(): JSX.Element;
+export declare function RemovalHandle(): JSX.Element;
+export declare function ScrewHoles(): JSX.Element;

package/lib/hardware-sim/Deck/RobotCoordsForeignDiv.d.ts

@@ -0,0 +1,14 @@
+import type * as React from 'react';
+import { Box } from '../../primitives';
+export interface RobotCoordsForeignDivProps {
+    width?: string | number;
+    height?: string | number;
+    x?: string | number;
+    y?: string | number;
+    children?: React.ReactNode;
+    outerProps?: any;
+    innerDivProps?: React.ComponentProps<typeof Box>;
+    transformWithSVG?: boolean;
+    extraTransform?: string;
+}
+export declare const RobotCoordsForeignDiv: (props: RobotCoordsForeignDivProps) => JSX.Element;

package/lib/hardware-sim/Deck/RobotCoordsForeignObject.d.ts

@@ -0,0 +1,12 @@
+import type * as React from 'react';
+import { Flex, ForeignObject } from '../../primitives';
+export interface RobotCoordsForeignObjectProps {
+    width: string | number;
+    height: string | number;
+    x: string | number;
+    y: string | number;
+    children?: React.ReactNode;
+    foreignObjectProps?: React.ComponentProps<typeof ForeignObject>;
+    flexProps?: React.ComponentProps<typeof Flex>;
+}
+export declare const RobotCoordsForeignObject: (props: RobotCoordsForeignObjectProps) => JSX.Element;

package/lib/hardware-sim/Deck/RobotCoordsText.d.ts

@@ -0,0 +1,8 @@
+import type * as React from 'react';
+export interface RobotCoordsTextProps extends React.ComponentProps<'text'> {
+    x: number;
+    y: number;
+    children?: React.ReactNode;
+}
+/** SVG text reflected to use take robot coordinates as props */
+export declare function RobotCoordsText(props: RobotCoordsTextProps): JSX.Element;

package/lib/hardware-sim/Deck/RobotWorkSpace.d.ts

@@ -0,0 +1,21 @@
+import * as React from 'react';
+import type { StyleProps } from '../../primitives';
+import type { DeckDefinition, DeckSlot } from '@opentrons/shared-data';
+export interface RobotWorkSpaceRenderProps {
+    deckSlotsById: {
+        [slotId: string]: DeckSlot;
+    };
+    getRobotCoordsFromDOMCoords: (domX: number, domY: number) => {
+        x: number;
+        y: number;
+    };
+}
+export interface RobotWorkSpaceProps extends StyleProps {
+    deckDef?: DeckDefinition;
+    viewBox?: string | null;
+    children?: (props: RobotWorkSpaceRenderProps) => React.ReactNode;
+    deckLayerBlocklist?: string[];
+    showDeckLayers?: boolean;
+    id?: string;
+}
+export declare function RobotWorkSpace(props: RobotWorkSpaceProps): JSX.Element | null;

package/lib/hardware-sim/Deck/SlotLabels.d.ts

@@ -0,0 +1,12 @@
+import type { RobotType } from '@opentrons/shared-data';
+interface SlotLabelsProps {
+    robotType: RobotType;
+    color?: string;
+    show4thColumn?: boolean;
+}
+/**
+ * Component to render Opentrons Flex slot labels
+ * For use as a RobotWorkspace child component
+ */
+export declare const SlotLabels: ({ robotType, color, show4thColumn, }: SlotLabelsProps) => JSX.Element | null;
+export {};

package/lib/hardware-sim/Deck/__mocks__/getDeckDefinitions.d.ts

@@ -0,0 +1 @@
+export declare const getDeckDefinitions: import("@vitest/spy").Mock<[], {}>;

package/lib/hardware-sim/Deck/constants.d.ts

@@ -0,0 +1 @@
+export declare const ALL_OT2_DECK_LAYERS: readonly ["fixedBase", "fixedTrash", "doorStops", "metalFrame", "removableDeckOutline", "slotRidges", "slotNumbers", "calibrationMarkings", "removalHandle", "screwHoles"];

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

@@ -0,0 +1,8 @@
+export * from './DeckFromLayers';
+export * from './FlexTrash';
+export * from './MoveLabwareOnDeck';
+export * from './RobotCoordsForeignDiv';
+export * from './RobotCoordsForeignObject';
+export * from './RobotCoordsText';
+export * from './RobotWorkSpace';
+export * from './SlotLabels';

package/lib/hardware-sim/DeckConfigurator/AbsorbanceReaderFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface AbsorbanceReaderFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function AbsorbanceReaderFixture(props: AbsorbanceReaderFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/EmptyConfigFixture.d.ts

@@ -0,0 +1,8 @@
+import type { CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface EmptyConfigFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    handleClickAdd: (fixtureLocation: CutoutId) => void;
+}
+export declare function EmptyConfigFixture(props: EmptyConfigFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/HeaterShakerFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface HeaterShakerFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function HeaterShakerFixture(props: HeaterShakerFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/MagneticBlockFixture.d.ts

@@ -0,0 +1,11 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface MagneticBlockFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    hasStagingArea?: boolean;
+    selected?: boolean;
+}
+export declare function MagneticBlockFixture(props: MagneticBlockFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/StagingAreaConfigFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface StagingAreaConfigFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function StagingAreaConfigFixture(props: StagingAreaConfigFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/StaticFixture.d.ts

@@ -0,0 +1,12 @@
+import type { CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface StaticFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    label: string;
+}
+/**
+ * this component allows us to add static labeled fixtures to the center column of a deck
+ * config map
+ */
+export declare function StaticFixture(props: StaticFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/TemperatureModuleFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface TemperatureModuleFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function TemperatureModuleFixture(props: TemperatureModuleFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/ThermocyclerFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface ThermocyclerFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function ThermocyclerFixture(props: ThermocyclerFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/TrashBinConfigFixture.d.ts

@@ -0,0 +1,10 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface TrashBinConfigFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    selected?: boolean;
+}
+export declare function TrashBinConfigFixture(props: TrashBinConfigFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/WasteChuteConfigFixture.d.ts

@@ -0,0 +1,11 @@
+import type { CutoutFixtureId, CutoutId, DeckDefinition } from '@opentrons/shared-data';
+interface WasteChuteConfigFixtureProps {
+    deckDefinition: DeckDefinition;
+    fixtureLocation: CutoutId;
+    cutoutFixtureId: CutoutFixtureId;
+    handleClickRemove?: (fixtureLocation: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    hasStagingAreas?: boolean;
+    selected?: boolean;
+}
+export declare function WasteChuteConfigFixture(props: WasteChuteConfigFixtureProps): JSX.Element;
+export {};

package/lib/hardware-sim/DeckConfigurator/constants.d.ts

@@ -0,0 +1,20 @@
+/**
+ * These are Flex deck configurator-only values to position a foreign object
+ * Position is relative to deck definition slot positions and a custom stroke applied to the single slot fixture SVG
+ */
+export declare const FIXTURE_HEIGHT = 102;
+export declare const THERMOCYCLER_FIXTURE_HEIGHT = 290;
+export declare const COLUMN_1_SINGLE_SLOT_FIXTURE_WIDTH = 243.5;
+export declare const COLUMN_2_SINGLE_SLOT_FIXTURE_WIDTH = 159;
+export declare const COLUMN_3_SINGLE_SLOT_FIXTURE_WIDTH = 243.5;
+export declare const STAGING_AREA_FIXTURE_WIDTH = 314.5;
+export declare const COLUMN_1_X_ADJUSTMENT = -100;
+export declare const COLUMN_2_X_ADJUSTMENT = -15.5;
+export declare const COLUMN_3_X_ADJUSTMENT = -15.5;
+export declare const Y_ADJUSTMENT = -8;
+export declare const STAGING_AREA_DISPLAY_NAME = "Staging area";
+export declare const TRASH_BIN_DISPLAY_NAME = "Trash bin";
+export declare const WASTE_CHUTE_DISPLAY_NAME = "Waste chute";
+export declare const CONFIG_STYLE_READ_ONLY: import("styled-components").FlattenSimpleInterpolation;
+export declare const CONFIG_STYLE_EDITABLE: import("styled-components").FlattenSimpleInterpolation;
+export declare const CONFIG_STYLE_SELECTED: import("styled-components").FlattenSimpleInterpolation;

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

@@ -0,0 +1,20 @@
+import type * as React from 'react';
+import type { CutoutFixtureId, CutoutId, DeckConfiguration } from '@opentrons/shared-data';
+interface DeckConfiguratorProps {
+    deckConfig: DeckConfiguration;
+    handleClickAdd: (cutoutId: CutoutId) => void;
+    handleClickRemove: (cutoutId: CutoutId, cutoutFixtureId: CutoutFixtureId) => void;
+    lightFill?: string;
+    darkFill?: string;
+    editableCutoutIds?: CutoutId[];
+    showExpansion?: boolean;
+    children?: React.ReactNode;
+    additionalStaticFixtures?: Array<{
+        location: CutoutId;
+        label: string;
+    }>;
+    height?: string;
+    selectedCutoutId?: CutoutId;
+}
+export declare function DeckConfigurator(props: DeckConfiguratorProps): JSX.Element;
+export {};

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

@@ -0,0 +1,15 @@
+import type * as React from 'react';
+import type { DeckSlot, RobotType } from '@opentrons/shared-data';
+interface LegacyDeckSlotLocationProps extends React.SVGProps<SVGGElement> {
+    robotType: RobotType;
+    slotName: DeckSlot['id'];
+    slotBaseColor?: React.SVGProps<SVGPathElement>['fill'];
+    slotClipColor?: React.SVGProps<SVGPathElement>['stroke'];
+}
+export declare const OT2_FIXED_TRASH_X_DIMENSION = 172.86;
+export declare const OT2_FIXED_TRASH_Y_DIMENSION = 165.86;
+/**
+ * This is a legacy component for rendering an OT-2 deck slot by reference to the V4 deck definition
+ */
+export declare function LegacyDeckSlotLocation(props: LegacyDeckSlotLocationProps): JSX.Element | null;
+export {};

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

@@ -0,0 +1,39 @@
+import * as React from 'react';
+import type { LabwareDefinition2 } from '@opentrons/shared-data';
+import type { HighlightedWellLabels, WellMouseEvent, WellFill, WellStroke } from './labwareInternals/types';
+export interface LabwareProps {
+    /** Labware definition to render */
+    definition: LabwareDefinition2;
+    /** Opional Prop for labware on heater shakers sitting on right side of the deck */
+    shouldRotateAdapterOrientation?: boolean;
+    /** boolean to show well labels */
+    showLabels?: boolean;
+    /** color to render well labels */
+    wellLabelColor?: string;
+    /** option to highlight well labels with specified color */
+    highlightedWellLabels?: HighlightedWellLabels;
+    /** CSS color to fill specified wells */
+    wellFill?: WellFill;
+    /** CSS color to stroke specified wells */
+    wellStroke?: WellStroke;
+    /** adds thicker blue border with blur to labware */
+    highlight?: boolean;
+    /** Optional callback, called with WellMouseEvent args onMouseEnter */
+    onMouseEnterWell?: (e: WellMouseEvent) => unknown;
+    /** Optional callback, called with WellMouseEvent args onMouseLeave */
+    onMouseLeaveWell?: (e: WellMouseEvent) => unknown;
+    gRef?: React.RefObject<SVGGElement>;
+    onLabwareClick?: () => void;
+    /** Hide labware outline */
+    hideOutline?: boolean;
+    /** Provides well data attribute */
+    isInteractive?: boolean;
+}
+/**
+ * a refactor of the legacy LabwareRender component intended to provide predictable styling
+ * initial use in ODD well selection component with ODD-specific well label styling
+ * consider adding additional styled wells props if used elsewhere
+ * @param props
+ * @returns
+ */
+export declare const Labware: (props: LabwareProps) => JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/Opentrons96DeepWellAdapter.d.ts

@@ -0,0 +1 @@
+export declare function Opentrons96DeepWellAdapter(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/Opentrons96FlatBottomAdapter.d.ts

@@ -0,0 +1 @@
+export declare function Opentrons96FlatBottomAdapter(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/OpentronsAluminumFlatBottomPlate.d.ts

@@ -0,0 +1 @@
+export declare function OpentronsAluminumFlatBottomPlate(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/OpentronsAutoclavableDeckRiser.d.ts

@@ -0,0 +1 @@
+export declare function OpentronsAutoclavableDeckRiser(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/OpentronsFlex96TiprackAdapter.d.ts

@@ -0,0 +1 @@
+export declare function OpentronsFlex96TiprackAdapter(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/OpentronsToughPCRAutoSealingLid.d.ts

@@ -0,0 +1 @@
+export declare function OpentronsToughPCRAutoSealingLid(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/OpentronsUniversalFlatAdapter.d.ts

@@ -0,0 +1 @@
+export declare function OpentronsUniversalFlatAdapter(): JSX.Element;

package/lib/hardware-sim/Labware/LabwareAdapter/index.d.ts

@@ -0,0 +1,27 @@
+import { Opentrons96DeepWellAdapter } from './Opentrons96DeepWellAdapter';
+import { Opentrons96FlatBottomAdapter } from './Opentrons96FlatBottomAdapter';
+import { OpentronsUniversalFlatAdapter } from './OpentronsUniversalFlatAdapter';
+import { OpentronsAluminumFlatBottomPlate } from './OpentronsAluminumFlatBottomPlate';
+import { OpentronsFlex96TiprackAdapter } from './OpentronsFlex96TiprackAdapter';
+import { OpentronsToughPCRAutoSealingLid } from './OpentronsToughPCRAutoSealingLid';
+import { OpentronsAutoclavableDeckRiser } from './OpentronsAutoclavableDeckRiser';
+import type { LabwareDefinition2 } from '@opentrons/shared-data';
+declare const LABWARE_ADAPTER_LOADNAME_PATHS: {
+    opentrons_96_deep_well_adapter: typeof Opentrons96DeepWellAdapter;
+    opentrons_96_flat_bottom_adapter: typeof Opentrons96FlatBottomAdapter;
+    opentrons_aluminum_flat_bottom_plate: typeof OpentronsAluminumFlatBottomPlate;
+    opentrons_flex_96_tiprack_adapter: typeof OpentronsFlex96TiprackAdapter;
+    opentrons_universal_flat_adapter: typeof OpentronsUniversalFlatAdapter;
+    opentrons_tough_pcr_auto_sealing_lid: typeof OpentronsToughPCRAutoSealingLid;
+    opentrons_flex_deck_riser: typeof OpentronsAutoclavableDeckRiser;
+};
+export type LabwareAdapterLoadName = keyof typeof LABWARE_ADAPTER_LOADNAME_PATHS;
+export declare const labwareAdapterLoadNames: string[];
+export interface LabwareAdapterProps {
+    labwareLoadName: LabwareAdapterLoadName;
+    definition?: LabwareDefinition2;
+    highlight?: boolean;
+    highlightShadow?: boolean;
+}
+export declare const LabwareAdapter: (props: LabwareAdapterProps) => JSX.Element | null;
+export {};

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

@@ -0,0 +1,46 @@
+import type * as React from 'react';
+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: {
+    readonly SHOW_LABEL_INSIDE: "SHOW_LABEL_INSIDE";
+    readonly SHOW_LABEL_OUTSIDE: "SHOW_LABEL_OUTSIDE";
+};
+export type WellLabelOption = keyof typeof WELL_LABEL_OPTIONS;
+export interface LabwareRenderProps {
+    /** Labware definition to render */
+    definition: LabwareDefinition2;
+    /** Opional Prop for labware on heater shakers sitting on right side of the deck */
+    shouldRotateAdapterOrientation?: boolean;
+    /** option to show well labels inside or outside of labware outline */
+    wellLabelOption?: WellLabelOption;
+    /** wells to highlight */
+    highlightedWells?: WellGroup | null;
+    /** option for none highlighted wells to be disabled */
+    disabledWells?: WellGroup[];
+    missingTips?: WellGroup | null;
+    /** color to render well labels */
+    wellLabelColor?: string;
+    /** option to highlight well labels with specified color */
+    highlightedWellLabels?: HighlightedWellLabels;
+    selectedWells?: WellGroup | null;
+    /** CSS color to fill specified wells */
+    wellFill?: WellFill;
+    /** CSS color to stroke specified wells */
+    wellStroke?: WellStroke;
+    /** CSS color to stroke the labware outline */
+    labwareStroke?: CSSProperties['stroke'];
+    /** adds thicker blue border with blur to labware */
+    highlight?: boolean;
+    /** adds a drop shadow to the highlight border */
+    highlightShadow?: boolean;
+    /** Optional callback, called with WellMouseEvent args onMouseEnter */
+    onMouseEnterWell?: (e: WellMouseEvent) => unknown;
+    /** Optional callback, called with WellMouseEvent args onMouseLeave */
+    onMouseLeaveWell?: (e: WellMouseEvent) => unknown;
+    gRef?: React.RefObject<SVGGElement>;
+    onLabwareClick?: () => void;
+    showBorder?: boolean;
+    strokeColor?: string;
+}
+export declare const LabwareRender: (props: LabwareRenderProps) => JSX.Element;

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

@@ -0,0 +1,20 @@
+import type * as React from 'react';
+import type { LabwareDefinition2 } from '@opentrons/shared-data';
+import type { HighlightedWellLabels } from './labwareInternals/types';
+import type { WellLabelOption } from '../..';
+export interface LabwareStackRenderProps {
+    /** Labware definitions in stack to render */
+    definitionTop: LabwareDefinition2;
+    /** option to highlight well labels with specified color */
+    highlightedWellLabels?: HighlightedWellLabels;
+    /** highlight top labware */
+    highlightTop: boolean;
+    /** highlight bottom labware if it exists */
+    highlightBottom: boolean;
+    gRef?: React.RefObject<SVGGElement>;
+    definitionBottom?: LabwareDefinition2 | null;
+    shouldRotateAdapterOrientation?: boolean;
+    /** option to show well labels inside or outside of labware outline */
+    wellLabelOption?: WellLabelOption;
+}
+export declare const LabwareStackRender: (props: LabwareStackRenderProps) => JSX.Element;

package/lib/hardware-sim/Labware/__tests__/Labware.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/vitest';

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

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/vitest';

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

@@ -0,0 +1,5 @@
+export * from './labwareInternals/index';
+export * from './LabwareRender';
+export * from './LabwareStackRender';
+export * from './Labware';
+export * from './labwareInternals/types';

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

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import type { LabwareDefinition2 } from '@opentrons/shared-data';
+import type { CSSProperties } from 'styled-components';
+export interface FilledWellsProps {
+    definition: LabwareDefinition2;
+    fillByWell: Record<string, CSSProperties['fill']>;
+    strokeColor?: string;
+}
+declare function FilledWellsComponent(props: FilledWellsProps): JSX.Element;
+export declare const FilledWells: React.MemoExoticComponent<typeof FilledWellsComponent>;
+export {};

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

@@ -0,0 +1,21 @@
+import type { CSSProperties } from 'styled-components';
+import type { LabwareDefinition2 } from '@opentrons/shared-data';
+export interface LabwareOutlineProps {
+    /** Labware definition to outline */
+    definition?: LabwareDefinition2;
+    /** x dimension in mm of this labware, used if definition doesn't supply dimensions, defaults to 127.76 */
+    width?: number;
+    /** y dimension in mm of this labware, used if definition doesn't supply dimensions, defaults to 85.48 */
+    height?: number;
+    /** if this labware is a tip rack, darken background and lighten borderx dimension in mm of this labware, used if definition doesn't supply dimensions, defaults to false */
+    isTiprack?: boolean;
+    /** adds thicker blue border with blur to labware, defaults to false */
+    highlight?: boolean;
+    /** adds a drop shadow to the highlight border */
+    highlightShadow?: boolean;
+    /** [legacy] override the border color */
+    stroke?: CSSProperties['stroke'];
+    fill?: CSSProperties['fill'];
+    showRadius?: boolean;
+}
+export declare function LabwareOutline(props: LabwareOutlineProps): JSX.Element;