React Icons Compat.Api - Fluentui

API Report File for "@fluentui/react-icons-compat"

Do not edit this file. It is a report generated by API Extractor.

import type { JSXElement } from '@fluentui/react-utilities';

// @public
export function getIcon(name?: string): IconRecord | undefined;

// @public (undocumented)
export interface IconOptions {
    disableWarnings: boolean;
    // @deprecated (undocumented)
    warnOnMissingIcons?: boolean;
}

// @public (undocumented)
export interface IconRecord {
    // (undocumented)
    code: string | undefined;
    // (undocumented)
    subset: IconSubsetRecord;
}

// @public (undocumented)
export interface IconRecords {
    // (undocumented)
    [key: string]: IconRecord | {};
    // (undocumented)
    __options: IconOptions;
    // (undocumented)
    __remapped: {
        [key: string]: string;
    };
}

// @public (undocumented)
export interface IconSubset {
    // (undocumented)
    icons: {
        [key: string]: string | JSXElement;
    };
    mergeImageProps?: boolean;
}

// @public (undocumented)
export interface IconSubsetRecord extends IconSubset {
    // (undocumented)
    className?: string;
    // (undocumented)
    isRegistered?: boolean;
}

// @public
export function registerIconAlias(iconName: string, mappedToName: string): void;

// @public
export function registerIcons(iconSubset: IconSubset, options?: Partial<IconOptions>): void;

// @public
export function setIconOptions(options: Partial<IconOptions>): void;

// @public
export function unregisterIcons(iconNames: string[]): void;

// (No @packageDocumentation comment for this package)