@patreon/studio/module/components/InlineHelpText/index.d.ts

Patreon Studio Design System

import type { ReactNode } from 'react';
import React from 'react';
import type { BaseProps } from '../../types/component';
export interface InlineHelpTextProps extends BaseProps {
    /**
     * If a string, applies error styling and renders an `InlineError` below the
     * input. If true, applies error styling to the input and sets
     * `aria-describedby` to `InlineError.getErrorId(id)`, and should be
     * accompanied by a separate `InlineError`.
     */
    error?: ReactNode;
    /**
     * Supplemental text that appears below the input.
     */
    helpText?: ReactNode;
    /**
     * id of the associated input. The concatenation of this value and `InlineError.IDSuffix` is set as the `id` of the rendered node.
     */
    inputId: string;
    /**
     * Renders a loading spinner with a text label below the input for async validation.
     */
    loading?: string;
    /**
     * If a string, renders an `InlineSuccess` below the input. Should only be used to
     * indicate valid states which are not derived from specific rules (such as
     * to confirm that a vanity is available). If true, sets `aria-describedby`
     * to `InlineSuccess.getSuccessId(id)`, and should be accompanied by a
     * separate `InlineSuccess`.
     */
    success?: ReactNode;
}
export declare function InlineHelpText({ id, inputId, helpText, error, success, loading, 'data-tag': dataTag, }: InlineHelpTextProps): React.JSX.Element | null;