@adaptabletools/adaptable/src/AdaptableState/Common/AdaptableIcon.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import * as React from 'react';
import { TypeHint } from './Types';
/**
 * Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)
 */
export type AdaptableIcon = AdaptableSystemIcon | AdaptableCustomIcon | AdaptableElementIcon;
/**
 * Defines an icon from the System AdapTable icon set
 */
export interface AdaptableSystemIcon extends AdaptableBaseIcon {
    /**
     * The name of the icon to use (referencing the AdapTable Icon Library)
     *
     * The icon can be a adaptable icon or a custom one defined in `interfaceOptions.customIcons`
     */
    name: TypeHint<string, AdaptableSystemIconName>;
    /**
     * The size (in pixels) of the SVG icon (defaults to `17px`)
     *
     */
    size?: number;
}
/**
 * Defines an icon from an external source
 */
export interface AdaptableCustomIcon extends AdaptableBaseIcon {
    /**
     * The URL of the icon to use
     */
    src: string;
}
/**
 * Defines an icon as a provided DOM element or HTML string
 */
export interface AdaptableElementIcon {
    /**
     * The icon to display, either a DOM element or HTML string
     */
    element: HTMLElement | string;
}
/**
 * Base interface for AdaptableIcon
 */
export interface AdaptableBaseIcon {
    /**
     * The class name of the icon
     */
    className?: string;
    /**
     * CSS Properties
     */
    style?: React.CSSProperties;
}
/**
 * All AdapTable System Icon names
 */
export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'calculated-column' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'copy' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'json' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'excel' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'filter-off' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'select-all' | 'select-off' | 'select-fwd' | 'styled-grid' | 'sync' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter' | 'grid-info' | 'csv' | 'rows' | 'expand-all' | 'collapse-all' | 'column-outline';