@progress/kendo-react-common
Version:
React Common package delivers common utilities that can be used with the KendoReact UI components. KendoReact Common Utilities package
40 lines (39 loc) • 1.25 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2023 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------*/
import * as React from 'react';
import { BaseIconProps } from './BaseIconProps';
import { KendoMouse } from '../models/mouse';
/**
* @hidden
*/
export interface IconHandle {
/**
* The IconHandle element.
*/
element: HTMLSpanElement | null;
}
/**
* Represents the props of the [KendoReact Icon component]({% slug overview_icon %}).
*/
export interface IconProps extends BaseIconProps, KendoMouse<IconHandle, HTMLSpanElement> {
/**
* Represents the name of the icon.
*/
name?: string;
}
/**
* Represents the [KendoReact Icon component]({% slug overview_icon %}).
*
* @example
* ```jsx
* const App = () => {
* return (
* <Icon name="home"/>
* );
* };
* ReactDOM.render(<App />, document.querySelector('my-app'));
* ```
*/
export declare const Icon: React.ForwardRefExoticComponent<IconProps & React.RefAttributes<IconHandle | null>>;