@opalkelly/frontpanel-react-components 0.1.0

package/dist/esm/types/components/FrontPanelSelectEntry/FrontPanelSelectEntryRoot.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import React from "react";
+import { SelectEntry } from "../../primitives";
+import FrontPanelSelectEntryRootProps from "./FrontPanelSelectEntryRoot.props";
+interface FrontPanelSelectEntryRootCombinedProps extends React.ComponentPropsWithoutRef<typeof SelectEntry.Root>, FrontPanelSelectEntryRootProps {
+}
+export type { FrontPanelSelectEntryRootCombinedProps };
+/**
+ * `FrontPanelSelectEntryRoot` is a React component that is the root component of a select entry that
+ * allows setting a WireIn endpoint. The children of this component are used to specify the component
+ * parts. The parts include the trigger that can be clicked on to show a list of options to select from,
+ * and the content that is the list of options.
+ *
+ * @component
+ * @param {object} props - Properties passed to component
+ * @param {object} rootProps - Any additional properties to pass to the root component
+ *
+ * @returns {React.Node} The rendered FrontPanelSelectEntryRoot component
+ *
+ * @example
+ * ```jsx
+ * <FrontPanelSelectEntryRoot
+ *     fpEndpoint={{epAddress: 0x00, bitOffset: 1}}
+ *     maximumValue=2 />
+ *     <FrontPanelSelectEntry.Trigger />
+ *     <FrontPanelSelectEntry.Content>
+ *         <FrontPanelSelectEntry.Group>
+ *             <FrontPanelSelectEntry.Label>Options</FrontPanelSelectEntry.Label>
+ *             <FrontPanelSelectEntry.Item value="0">Option 0</FrontPanelSelectEntry.Option>
+ *             <FrontPanelSelectEntry.Item value="1">Option 1</FrontPanelSelectEntry.Option>
+ *             <FrontPanelSelectEntry.Item value="2">Option 2</FrontPanelSelectEntry.Option>
+ *         </FrontPanelSelectEntry.Group>
+ *    </FrontPanelSelectEntry.Content>
+ * </FrontPanelSelectEntryRoot>
+ * ```
+ */
+declare const FrontPanelSelectEntryRoot: React.FC<FrontPanelSelectEntryRootCombinedProps>;
+export default FrontPanelSelectEntryRoot;

package/dist/esm/types/components/FrontPanelSelectEntry/FrontPanelSelectEntryRoot.props.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import { EndpointAddressProps } from "../types";
+/**
+ * Interface for the properties of the `FrontPanelSelectEntryRoot` component.
+ */
+interface FrontPanelSelectEntryRootProps {
+    /**
+     * Address of the frontpanel endpoint
+     */
+    fpEndpoint: EndpointAddressProps;
+    /**
+     * Maximum value that the select entry will allow
+     */
+    maximumValue: bigint;
+}
+export default FrontPanelSelectEntryRootProps;

package/dist/esm/types/components/FrontPanelSelectEntry/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { default as FrontPanelSelectEntry } from "./FrontPanelSelectEntry";
+export { default as FrontPanelSelectEntryRoot } from "./FrontPanelSelectEntryRoot";
+export { default as FrontPanelSelectEntryTrigger } from "../../primitives/SelectEntry/SelectEntryTrigger";
+export { default as FrontPanelSelectEntryContent } from "../../primitives/SelectEntry/SelectEntryContent";
+export { default as FrontPanelSelectEntryItem } from "../../primitives/SelectEntry/SelectEntryItem";
+export { default as FrontPanelSelectEntryGroup } from "../../primitives/SelectEntry/SelectEntryGroup";
+export { default as FrontPanelSelectEntryLabel } from "../../primitives/SelectEntry/SelectEntryLabel";
+export { default as FrontPanelSelectEntrySeparator } from "../../primitives/SelectEntry/SelectEntrySeparator";
+export { default as FrontPanelSelectEntryRootProps } from "./FrontPanelSelectEntryRoot.props";

package/dist/esm/types/components/FrontPanelToggleSwitch/FrontPanelToggleSwitch.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import React from "react";
+import { ToggleSwitch } from "../../primitives";
+import FrontPanelToggleSwitchProps from "./FrontPanelToggleSwitch.props";
+interface FrontPanelToggleSwitchCombinedProps extends Omit<React.ComponentPropsWithoutRef<typeof ToggleSwitch>, "state" | "onToggleStateChanged">, FrontPanelToggleSwitchProps {
+}
+export type { FrontPanelToggleSwitchCombinedProps };
+/**
+ * `FrontPanelToggleSwitch` is a React component that renders a toggle switch with an optional label and or tooltip
+ *  to toggle the state of a WireIn endpoint.
+ *
+ * @component
+ * @param {Object} props - The properties that define the `FrontPanelToggleSwitch` component.
+ * @param {React.Ref<FrontPanelToggleSwitchElement>} forwardedRef - A ref that is forwarded to the `FrontPanelToggleSwitch` component.
+ *
+ * @returns {React.ReactElement} The `FrontPanelToggleSwitch` component.
+ *
+ * @example
+ * ```jsx
+ * <FrontPanelToggleSwitch
+ *    label="Toggle"
+ *    fpEndpoint={{epAddress: 0x00, bitOffset: 1}} />
+ * ```
+ */
+declare const FrontPanelToggleSwitch: React.ForwardRefExoticComponent<FrontPanelToggleSwitchCombinedProps & React.RefAttributes<HTMLButtonElement>>;
+export default FrontPanelToggleSwitch;

package/dist/esm/types/components/FrontPanelToggleSwitch/FrontPanelToggleSwitch.props.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import { EndpointAddressProps } from "../types";
+/**
+ * Interface for the properties of the `FrontPanelToggleSwitch` component.
+ */
+interface FrontPanelToggleSwitchProps {
+    /**
+     * Address of the frontpanel endpoint
+     */
+    fpEndpoint: EndpointAddressProps;
+}
+export default FrontPanelToggleSwitchProps;

package/dist/esm/types/components/FrontPanelToggleSwitch/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { default } from "./FrontPanelToggleSwitch";
+export { default as FrontPanelToggleSwitchProps } from "./FrontPanelToggleSwitch.props";

package/dist/esm/types/components/FrontPanelTriggerButton/FrontPanelTriggerButton.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import React from "react";
+import "./FrontPanelTriggerButton.css";
+import FrontPanelTriggerButtonProps from "./FrontPanelTriggerButton.props";
+import Button from "../../primitives/Button";
+interface FrontPanelTriggerButtonCombinedProps extends Omit<React.ComponentPropsWithoutRef<typeof Button>, "asChild" | "onButtonClick" | "onButtonDown" | "onButtonUp">, FrontPanelTriggerButtonProps {
+}
+export type { FrontPanelTriggerButtonCombinedProps };
+/**
+ * `FrontPanelTriggerButton` is a React component that renders a trigger button that asserts a TriggerIn endpoint when
+ * it is pressed.
+ *
+ * @component
+ * @param {Object} props - Properties passed to component
+ * @param {React.Ref<FrontPanelTriggerButtonElement>} forwardedRef - Forwarded ref for the button
+ *
+ * @returns {React.ReactElement} The rendered FrontPanelTriggerButton component
+ *
+ * @example
+ * ```jsx
+ * <FrontPanelTriggerButton
+ *     label="Trigger"
+ *     fpEndpoint={{epAddress: 0x00, bitOffset: 1}} />
+ * ```
+ */
+declare const FrontPanelTriggerButton: React.ForwardRefExoticComponent<FrontPanelTriggerButtonCombinedProps & React.RefAttributes<HTMLButtonElement>>;
+export default FrontPanelTriggerButton;

package/dist/esm/types/components/FrontPanelTriggerButton/FrontPanelTriggerButton.props.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import { EndpointAddressProps } from "../types";
+/**
+ * Interface for the properties of the FrontPanelTriggerButton component.
+ * This interface extends the properties of the TriggerButton component.
+ */
+interface FrontPanelTriggerButtonProps {
+    /**
+     * Address of the frontpanel endpoint
+     */
+    fpEndpoint: EndpointAddressProps;
+}
+export default FrontPanelTriggerButtonProps;

package/dist/esm/types/components/FrontPanelTriggerButton/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { default } from "./FrontPanelTriggerButton";
+export { default as FrontPanelTriggerButtonProps } from "./FrontPanelTriggerButton.props";

package/dist/esm/types/components/Icons/ChevronIcon.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { IconProps } from "./types";
+export declare enum ChevronDirection {
+    Up = 0,
+    Down = 1
+}
+export interface ChevronIconProps extends IconProps {
+    direction: ChevronDirection;
+}
+declare const ChevronIcon: React.ForwardRefExoticComponent<ChevronIconProps & React.RefAttributes<SVGSVGElement>>;
+export default ChevronIcon;

package/dist/esm/types/components/Icons/IndicatorArrowIcon.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { IconProps } from "./types";
+export declare enum IndicatorArrowDirection {
+    Up = 0,
+    Down = 1
+}
+export interface IndicatorArrowIconProps extends IconProps {
+    direction: IndicatorArrowDirection;
+}
+declare const IndicatorArrowIcon: React.ForwardRefExoticComponent<IndicatorArrowIconProps & React.RefAttributes<SVGSVGElement>>;
+export default IndicatorArrowIcon;

package/dist/esm/types/components/Icons/IndicatorBarIcon.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { IconProps } from "./types";
+declare const IndicatorBarIcon: React.ForwardRefExoticComponent<IconProps & React.RefAttributes<SVGSVGElement>>;
+export default IndicatorBarIcon;

package/dist/esm/types/components/Icons/IndicatorStateIcon.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { StateIconProps } from "./types";
+import { ToggleState } from "../../core";
+export interface IndicatorStateIconProps extends StateIconProps {
+    state: ToggleState;
+}
+declare const IndicatorStateIcon: React.ForwardRefExoticComponent<IndicatorStateIconProps & React.RefAttributes<SVGSVGElement>>;
+export default IndicatorStateIcon;

package/dist/esm/types/components/Icons/RadioToggleStateIcon.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { StateIconProps } from "./types";
+import { ToggleState } from "../../core";
+export interface RadioToggleStateIconProps extends StateIconProps {
+    state: ToggleState;
+}
+declare const RadioToggleStateIcon: React.ForwardRefExoticComponent<RadioToggleStateIconProps & React.RefAttributes<SVGSVGElement>>;
+export default RadioToggleStateIcon;

package/dist/esm/types/components/Icons/SwitchToggleStateIcon.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { StateIconProps } from "./types";
+import { ToggleState } from "../../core";
+export interface SwitchToggleStateIconProps extends StateIconProps {
+    state: ToggleState;
+}
+declare const SwitchToggleStateIcon: React.ForwardRefExoticComponent<SwitchToggleStateIconProps & React.RefAttributes<SVGSVGElement>>;
+export default SwitchToggleStateIcon;

package/dist/esm/types/components/Icons/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { default as ChevronIcon, ChevronDirection } from "./ChevronIcon";
+export { default as IndicatorArrowIcon, IndicatorArrowDirection } from "./IndicatorArrowIcon";
+export { default as IndicatorBarIcon } from "./IndicatorBarIcon";
+export { default as IndicatorStateIcon } from "./IndicatorStateIcon";
+export { default as RadioToggleStateIcon } from "./RadioToggleStateIcon";
+export { default as SwitchToggleStateIcon } from "./SwitchToggleStateIcon";

package/dist/esm/types/components/Icons/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+export interface IconProps extends React.SVGAttributes<SVGElement> {
+    children?: never;
+    color?: string;
+}
+export interface StateIconProps extends React.SVGAttributes<SVGElement> {
+    children?: never;
+    color?: string;
+    colorOnState?: string;
+    colorOffState?: string;
+}

package/dist/esm/types/components/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { EndpointAddressProps } from "./types";
+export { default as FrontPanel } from "./FrontPanel";
+export { default as FrontPanelNumberEntry } from "./FrontPanelNumberEntry";
+export { default as FrontPanelNumberDisplay } from "./FrontPanelNumberDisplay";
+export { default as FrontPanelIndicator } from "./FrontPanelIndicator";
+export { default as FrontPanelPushButton } from "./FrontPanelPushButton";
+export { default as FrontPanelToggleSwitch } from "./FrontPanelToggleSwitch";
+export { default as FrontPanelTriggerButton } from "./FrontPanelTriggerButton";
+export { default as FrontPanelRangeSlider } from "./FrontPanelRangeSlider";
+export { FrontPanelSelectEntry, FrontPanelSelectEntryRoot } from "./FrontPanelSelectEntry";

package/dist/esm/types/components/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import { BitCount } from "@opalkelly/frontpanel-alloy-core";
+export interface EndpointAddressProps {
+    epAddress: number;
+    bitOffset: BitCount;
+}

package/dist/esm/types/contexts/FrontPanelContext.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import React from "react";
+import { IFrontPanel, IFrontPanelEventSource, WorkQueue } from "@opalkelly/frontpanel-alloy-core";
+export type FrontPanelContextValue = {
+    device: IFrontPanel;
+    workQueue: WorkQueue;
+    eventSource?: IFrontPanelEventSource;
+};
+declare const FrontPanelContext: React.Context<FrontPanelContextValue>;
+export default FrontPanelContext;

package/dist/esm/types/contexts/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export { default as FrontPanelContext } from "./FrontPanelContext";
+export { FrontPanelContextValue } from "./FrontPanelContext";

package/dist/esm/types/core/Binary.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export declare function CalculateBitLength(value: bigint): number;

package/dist/esm/types/core/Numeric.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import { NumeralSystem } from "./Types";
+/**
+ * Class representing numeric digits in various numeral systems.
+ */
+export declare class NumericDigits {
+    /**
+     * Maximum number of digits.
+     */
+    static readonly MAX_DIGITS: number;
+    /**
+     * Binary digit values.
+     */
+    static readonly BINARY_DIGITVALUES: string[];
+    /**
+     * Octal digit values.
+     */
+    static readonly OCTAL_DIGITVALUES: string[];
+    /**
+     * Decimal digit values.
+     */
+    static readonly DECIMAL_DIGITVALUES: string[];
+    /**
+     * Hexadecimal digit values.
+     */
+    static readonly HEXADECIMAL_DIGITVALUES: string[];
+    private readonly _DigitCount;
+    private readonly _NumeralSystem;
+    private readonly _DigitChars;
+    /**
+     * Gets the count of digits.
+     */
+    get DigitCount(): bigint;
+    /**
+     * Gets the numeral system.
+     */
+    get NumeralSystem(): NumeralSystem;
+    /**
+     * Gets the digit characters.
+     */
+    get DigitChars(): string[];
+    /**
+     * Creates a new instance of NumericDigits.
+     * @param digitCount - The count of digits.
+     * @param numeralSystem - The numeral system.
+     */
+    constructor(digitCount: bigint, numeralSystem: NumeralSystem);
+    /**
+     * Gets the character representation of the digit corresponding
+     * to the value specified.
+     * @param value - The value.
+     * @returns {string} - The digit as represented in the numeral system.
+     */
+    GetDigitFromValue(value: number): string;
+    /**
+     * Gets the digit characters from the numeral.
+     * @param numeral - The numeral system.
+     * @returns {string[]} - The digit characters.
+     */
+    static GetDigitChars(numeral: NumeralSystem): string[];
+    /**
+     * Computes the digit count from the bits.
+     * @param bitcount - The bit count.
+     * @param numeral - The numeral.
+     * @returns {bigint} - The digit count.
+     */
+    static ComputeDigitCountFromBits(bitcount: number, numeral: NumeralSystem): bigint;
+    /**
+     * Computes the digit count from the value.
+     * @param value - The value.
+     * @param numeral - The numeral.
+     * @returns {bigint} - The digit count.
+     */
+    static ComputeDigitCountFromValue(value: bigint, numeral: NumeralSystem): bigint;
+}

package/dist/esm/types/core/Types.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+/**
+ * Enumeration representing numeral systems.
+ */
+export declare enum NumeralSystem {
+    /**
+     * Binary numeral system (base 2).
+     */
+    Binary = 2,
+    /**
+     * Octal numeral system (base 8).
+     */
+    Octal = 8,
+    /**
+     * Decimal numeral system (base 10).
+     */
+    Decimal = 10,
+    /**
+     * Hexadecimal numeral system (base 16).
+     */
+    Hexadecimal = 16
+}
+/**
+ * Enumeration representing toggle states.
+ */
+export declare enum ToggleState {
+    Off = 0,
+    On = 1
+}

package/dist/esm/types/core/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export * from "./Types";
+export * from "./Numeric";
+export * from "./Binary";

package/dist/esm/types/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export * from "./core";
+export * from "./components";
+export * from "./contexts";
+export * from "./primitives";

package/dist/esm/types/primitives/Application/Application.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import * as React from "react";
+import { ApplicationProps } from "./Application.props";
+declare const Application: React.ForwardRefExoticComponent<ApplicationProps & React.RefAttributes<HTMLDivElement>>;
+export default Application;

package/dist/esm/types/primitives/Application/Application.props.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+/// <reference types="react" />
+interface ApplicationProps extends React.PropsWithChildren<NonNullable<unknown>> {
+}
+export { ApplicationProps };

package/dist/esm/types/primitives/Application/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./Application";

package/dist/esm/types/primitives/Button/Button.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+import React from "react";
+import ButtonProps from "./Button.props";
+import "../../index.css";
+import "./Button.css";
+interface ButtonCombinedProps extends React.ComponentPropsWithoutRef<"button">, ButtonProps {
+}
+export type { ButtonCombinedProps };
+/**
+ * `Button` is a React component that renders a button with an optional label and optional tooltip.
+ * The button event handlers provide notification when the button is clicked, pressed, or released
+ * and can be used to perform actions in response to these events.
+ *
+ * @component
+ * @param {object} props - Properties passed to component
+ * @param {React.Ref} forwardedRef - Forwarded ref for the button
+ *
+ * @returns {React.Node} The rendered Button component
+ *
+ * @example
+ * ```jsx
+ * <Button
+ *     label="Button"
+ *     onButtonClick={() => console.log("Button clicked")} />
+ * ```
+ */
+declare const Button: React.ForwardRefExoticComponent<ButtonCombinedProps & React.RefAttributes<HTMLButtonElement>>;
+export default Button;

package/dist/esm/types/primitives/Button/Button.props.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2024 Opal Kelly Incorporated
+ *
+ * This source code is licensed under the FrontPanel license.
+ * See the LICENSE file found in the root directory of this project.
+ */
+export type ButtonSize = 1 | 2 | 3;
+export type ButtonStateChangeEventHandler = () => void;
+export type ButtonClickEventHandler = () => void;
+/**
+ * Interface for the properties of the `Button` component.
+ */
+interface ButtonProps {
+    /**
+     * Label text to be displayed in the button
+     */
+    label: string;
+    /**
+     * Optional CSS class to apply to the button
+     */
+    className?: string;
+    /**
+     * Optional size of the button
+     * @default 1
+     */
+    size?: ButtonSize;
+    /**
+     * Optional tooltip text to be displayed on hover
+     */
+    tooltip?: string;
+    /**
+     * Optional event handler for the button down event
+     */
+    onButtonDown?: ButtonStateChangeEventHandler;
+    /**
+     * Optional event handler for the button up event
+     */
+    onButtonUp?: ButtonStateChangeEventHandler;
+    /**
+     * Optional event handler for the button click event
+     */
+    onButtonClick?: ButtonClickEventHandler;
+}
+export default ButtonProps;

package/dist/esm/types/primitives/Button/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./Button";
+export { default as ButtonProps } from "./Button.props";
+export { ButtonSize, ButtonStateChangeEventHandler, ButtonClickEventHandler } from "./Button.props";