beta-parity-react/ui/InlineLink/index.d.ts

Beta Parity React Components

import React from 'react';
import './index.css';
import './variables.css';
declare const colorMap: Record<'neutral' | 'standard', string>;
declare const sizeMap: Record<'sm' | 'md' | 'lg', string>;
/**
 * Props for the InlineLink component.
 *
 * Extends properties from the `a` element.
 */
export interface InlineLinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
    /**
     * Defines the color of the link. It should correspond to a key in the `colorMap` object.
     *
     * @default 'standard'
     * @memberof InlineLink
     */
    color?: keyof typeof colorMap;
    /**
     * Defines the size of the link. It should correspond to a key in the `sizeMap` object.
     *
     * @default 'md'
     * @memberof InlineLink
     */
    size?: keyof typeof sizeMap;
    /**
     * Specifies the underline behavior for the link.
     * - `always`: The link is always underlined.
     * - `hover`: The underline is displayed only on hover.
     * - `none`: No underline is displayed.
     *
     * @default 'hover'
     * @memberof InlineLink
     */
    underline?: 'always' | 'hover' | 'none';
    /**
     * If true, the link will display an icon without accompanying text.
     *
     * @default false
     * @memberof InlineLink
     */
    iconOnly?: boolean;
    /**
     * If true, the link will be disabled and non-interactive.
     *
     * @default false
     * @memberof InlineLink
     */
    disabled?: boolean;
    /**
     * If true, the component will render as its child element, inheriting the behavior and appearance of the child element.
     *
     * Useful for customizing the rendered element while preserving the intended features.
     *
     * @default false
     * @memberof InlineLink
     */
    asChild?: boolean;
}
/**
 * **Parity Inline Link**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/inline-link Parity Inline Link}
 */
export declare const InlineLink: React.ForwardRefExoticComponent<InlineLinkProps & React.RefAttributes<HTMLAnchorElement>>;
export {};
//# sourceMappingURL=index.d.ts.map