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

The design systems component library.

import { type DescriptionContent } from "../utils/descriptionWithLinks";
export interface FormDescriptionProps {
    /**
     * The description text to display. Can be a string or DescriptionContent for rich content.
     */
    description: string | DescriptionContent;
    /**
     * The ID of the description element.
     * This is important for accessiblituy and ensures that the input is correctly associated with the description.
     */
    id?: string;
    /**
     * Controls whether the description should appear disabled.
     */
    isDisabled?: boolean;
    /**
     * Controls whether the description should be styled for radio or checkbox fields.
     */
    isRadioOrCheckbox?: boolean;
    /**
     * Applies special styling for labels inside a legend.
     */
    isGroupLabel?: boolean;
    /**
     * Controls whether the description should be visually hidden.
     */
    hideDescription?: boolean;
}
/**
 *
 * FormDescription renders descriptive text for form fields, providing additional context
 * or instructions to users. This primitive handles various styling states including
 * disabled appearance, radio/checkbox positioning, and accessibility requirements.
 *
 * @internal
 */
export declare function FormDescription({ id, description, isDisabled, isRadioOrCheckbox, isGroupLabel, hideDescription }: FormDescriptionProps): import("react/jsx-runtime").JSX.Element;