@opalkelly/frontpanel-react-components/src/components/FrontPanelNumberEntry/FrontPanelNumberEntry.props.ts

React Component Library for OpalKelly FrontPanel application development

/**
 * 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 `FrontPanelNumberEntry` component.
 *
 * @interface
 */
interface FrontPanelNumberEntryProps {
    /**
     * Address of the frontpanel endpoint
     */
    fpEndpoint: EndpointAddressProps;

    /**
     * Maximum value that the number entry will allow.
     */
    maximumValue: bigint;

    /**
     * Optional minimum value that the number entry will allow.
     */
    minimumValue?: bigint;
}

export default FrontPanelNumberEntryProps;