@octopusdeploy/design-system-components/dist/src/components/Form/Primitives/Legend.d.ts

The design systems component library.

import type * as React from "react";
import type { PopoverBasicHelpProps } from "../../Popover/PopoverBasicHelp";
export type LegendMarginSize = "default" | "small";
export interface LegendProps {
    /**
     * The label text for the legend.
     */
    label?: string;
    /**
     * PopoverBasicHelp component to display additional help information
     * displays the Information icon next to the group label
     */
    popover?: React.ReactElement<PopoverBasicHelpProps>;
    /**
     * If true displays the (optional) text next to the group label
     */
    hasOptionalMarker?: boolean;
    /**
     * If true displays the (required) text next to the group label
     */
    hasRequiredMarker?: boolean;
    /**
     * Controls whether the legend should appear disabled.
     */
    disabled?: boolean;
    /**
     * Hides the label visually but keeps it accessible to screen readers.
     */
    hideLabel?: boolean;
    /**
     * Controls the bottom margin below the label block.
     * `default` applies 16px (`space[16]`); `small` applies 8px (`space[8]`).
     */
    marginSize?: LegendMarginSize;
}
/**
 *
 * Legend renders accessible labels for form field groups with support for
 * required/optional markers, help popovers, and disabled states.
 *
 * @internal
 */
export declare function Legend({ label, hasOptionalMarker, hasRequiredMarker, popover, disabled, hideLabel, marginSize }: LegendProps): import("react/jsx-runtime").JSX.Element | null;