import { ICellRendererComp, ICellRendererParams } from '@ag-grid-community/core'; import { FoundationElement } from '@microsoft/fast-foundation'; /** * The AG Icon Renderer Styles. * @public */ export declare const agIconRendererStyles: import("@microsoft/fast-element").ElementStyles; type IconByNameParams = { /** * The name of the icon to display. * @remarks a string for the icon. Valid values are from the free set of font awesome icons which can be found here https://fontawesome.com/search?ic=free */ iconName: string; /** * The size of the icon. * @remarks Size values depend on the design system (e.g., 'xs', 'sm', 'md', 'lg'). */ iconSize: string; }; type IconBySrcParams = { /** * The source URL of an image icon to display. * @remarks Used when rendering an image instead of an icon element. */ iconSrc: string; /** * The height of an image icon. * @remarks Used when iconSrc is provided. Defaults to '14px'. */ iconHeight: string; }; /** * Parameters for the {@link @genesislcap/grid-pro#GridPro} icon renderer. * @public */ export type IconRendererParams = ICellRendererParams & (IconByNameParams | IconBySrcParams) & { /** * The color of the icon. * @remarks Can be a CSS color value (e.g., '#FF0000', 'red', 'var(--accent-foreground)'). */ iconColor?: string; /** * The variant of the icon. * @remarks Variant values depend on the design system (e.g., 'solid', 'regular', 'outline'). */ variant?: string; /** * Callback function triggered when the icon is clicked. * @param event - The click event. * @param rowData - The data associated with the row. */ clickHandler?: (event: Event, rowData: any) => void; /** * Whether to show hover effects on the icon. * @remarks When true, adds padding, border-radius, and hover background color. */ showHover?: boolean; /** * The name of a secondary icon to display. * @remarks Rendered as a small icon positioned at the bottom-right of the primary icon. */ secondaryIcon?: string; /** * The color of the secondary icon. * @remarks Can be a CSS color value. */ secondaryIconColor?: string; /** * Function to determine whether the icon should be disabled for a specific row. * @param rowData - The data associated with the row. * @returns A boolean indicating whether the icon should be disabled. */ disabled?: boolean; }; /** * Get a Design System prefixed Icon template. * @param designSystem - The design system prefix to use. Defaults to 'foundation'. * @returns An Icon component template prefixed with the correct design system. * @public */ export declare const getIconRendererTemplate: (designSystem?: string) => import("@microsoft/fast-element").ViewTemplate; /** * Plain ag-Grid cell renderer for icons. * This renderer creates the FAST custom element using document.createElement. * * @public */ export declare class IconRenderer extends FoundationElement implements ICellRendererComp { params: IconRendererParams; init(params: IconRendererParams & ICellRendererParams): void; getGui(): HTMLElement; refresh(params: any): boolean; destroy(): void; } /** * A function that returns a Foundation Icon Renderer registration for configuring the component with a DesignSystem. * * @public * @remarks * HTML Element: \ */ export declare const foundationIconRenderer: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate; styles: import("@microsoft/fast-element").ElementStyles; }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{ baseName: string; template: import("@microsoft/fast-element").ViewTemplate; styles: import("@microsoft/fast-element").ElementStyles; }, typeof IconRenderer>; export {}; //# sourceMappingURL=icon.renderer.d.ts.map