@visa/nova-react/icon/index.d.ts

Visa Product Design System Nova React library

/**
 *              Copyright (c) 2025 Visa, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **/
import { SVGAttributes } from 'react';
declare const RESOLUTION: {
    high: string;
    low: string;
    tiny: string;
};
export type IconProperties = {
    /** Aria Base ID */
    ariaBaseId?: number | string;
    /** Icon Branding */
    brand?: 'generic' | 'visa';
    /** @ignore */
    children?: never;
    /** @ignore */
    className?: string;
    description?: string;
    /** Name of Icon */
    iconName?: string;
    /** Resolution of Icon */
    resolution?: keyof typeof RESOLUTION;
    /** Flips icon horizontally when document direction is set to right to left */
    rtl?: boolean;
    /** Title for Standalone SVG's */
    title?: string;
} & SVGAttributes<SVGSVGElement>;
/**
 * Meant for use with sprites only. Uses dom href linking of sprite elements expected to already be in the DOM to render the icon.
 * @docs {@link https://design.visa.com/react/components/icon | See Docs}
 * @vgar TODO
 * @wcag TODO
 */
declare const Icon: import("react").ForwardRefExoticComponent<{
    /** Aria Base ID */
    ariaBaseId?: number | string;
    /** Icon Branding */
    brand?: "generic" | "visa";
    /** @ignore */
    children?: never;
    /** @ignore */
    className?: string;
    description?: string;
    /** Name of Icon */
    iconName?: string;
    /** Resolution of Icon */
    resolution?: keyof typeof RESOLUTION;
    /** Flips icon horizontally when document direction is set to right to left */
    rtl?: boolean;
    /** Title for Standalone SVG's */
    title?: string;
} & SVGAttributes<SVGSVGElement> & import("react").RefAttributes<SVGSVGElement>>;
export default Icon;