export declare const TreeViewDecorationStyles: { CAPTION_HIGHLIGHT_CLASS: string; CAPTION_PREFIX_CLASS: string; CAPTION_SUFFIX_CLASS: string; ICON_WRAPPER_CLASS: string; DECORATOR_SIZE_CLASS: string; DECORATOR_SIDEBAR_SIZE_CLASS: string; TOP_RIGHT_CLASS: string; BOTTOM_RIGHT_CLASS: string; BOTTOM_RIGHT_SIDEBAR_CLASS: string; BOTTOM_LEFT_CLASS: string; TOP_LEFT_CLASS: string; }; /** * Enumeration for the quadrant to overlay the image on. */ export declare enum IconOverlayPosition { /** * Overlays the top right quarter of the original image. */ TOP_RIGHT = 0, /** * Overlays the bottom right of the original image. */ BOTTOM_RIGHT = 1, /** * Overlays the bottom left segment of the original image. */ BOTTOM_LEFT = 2, /** * Occupies the top left quarter of the original icon. */ TOP_LEFT = 3 } export declare namespace IconOverlayPosition { /** * Returns with the CSS class style for the enum. */ function getStyle(position: IconOverlayPosition, inSideBar?: boolean): string; } export declare namespace CaptionHighlight { /** * A pair of offset and length that has to be highlighted as a range. */ type Range = { /** * Zero based offset of the highlighted region. */ readonly offset: number; /** * The length of the highlighted region. */ readonly length: number; }; namespace Range { /** * `true` if the `arg` is contained in the range. The ranges are closed ranges, hence the check is inclusive. */ function contains(arg: number, range: Range): boolean; } /** * The result of a caption splitting based on the highlighting information. */ type Fragment = { /** * The text data of the fragment. */ readonly data: string; /** * Has to be highlighted if defined. */ readonly highlight?: true; }; /** * Splits the `caption` argument based on the ranges from the `highlight` argument. */ function split(caption: string, highlight: CaptionHighlight): Fragment[]; } /** * The caption highlighting with the highlighted ranges and an optional background color. */ export type CaptionHighlight = { /** * The ranges to highlight in the caption. */ readonly ranges: CaptionHighlight.Range[]; /** * The optional color of the text data that is being highlighted. Falls back to the default `mark` color values defined under a widget segment class. */ readonly color?: TreeViewDecoration.Color; /** * The optional background color of the text data that is being highlighted. */ readonly backgroundColor?: TreeViewDecoration.Color; }; /** * Namespace for the decoration data and the styling refinements for the decorated widgets. */ export declare namespace TreeViewDecoration { /** * For the sake of simplicity, we have merged the `font-style`, `font-weight`, and the `text-decoration` together. */ type FontStyle = 'normal' | 'bold' | 'italic' | 'oblique' | 'underline' | 'line-through'; /** * A string that could be: * * - one of the browser colors, (E.g.: `blue`, `red`, `magenta`), * - the case insensitive hexadecimal color code, (for instance, `#ee82ee`, `#20B2AA`, `#f09` ), or * - either the `rgb()` or the `rgba()` functions. * * For more details, see: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value. * * Note, it is highly recommended to use one of the predefined colors of Mana, so the desired color will * look nice with both the `light` and the `dark` theme too. */ type Color = string; /** * Encapsulates styling information of the font. */ type FontData = { /** * Zero to any font style. */ readonly style?: FontStyle | FontStyle[]; /** * The color of the font. */ readonly color?: Color; }; /** * Arbitrary information that has to be shown either before or after the caption as a prefix or a suffix. */ type CaptionAffix = { /** * The text content of the prefix or the suffix. */ readonly data: string; /** * Font data for customizing the prefix of the suffix. */ readonly fontData?: FontData; }; type BaseTailDecoration = { /** * Optional tooltip for the tail decoration. */ readonly tooltip?: string; }; /** * Unlike caption suffixes, tail decorations appears right-aligned after the caption and the caption suffixes (is any). */ type TailDecoration = { /** * The text content of the tail decoration. */ readonly data: string; /** * Font data for customizing the content. */ readonly fontData?: FontData; } & BaseTailDecoration; type TailDecorationIcon = { /** * This should be the name of the Font Awesome icon with out the `fa fa-` prefix, just the name, for instance `paw`. * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/. */ readonly icon: string; /** * The color of the icon. */ readonly color?: Color; } & BaseTailDecoration; type TailDecorationIconClass = { /** * This should be the entire Font Awesome class array, for instance ['fa', 'fa-paw'] * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/. */ readonly iconClass: string[]; /** * The color of the icon. */ readonly color?: Color; } & BaseTailDecoration; /** * A shape that can be optionally rendered behind the overlay icon. Can be used to further refine colors. */ type IconOverlayBackground = { /** * Either `circle` or `square`. */ readonly shape: 'circle' | 'square'; /** * The color of the background shape. */ readonly color?: Color; }; /** * Has not effect if the widget being decorated has no associated icon. */ type BaseOverlay = { /** * The position where the decoration will be placed on the top of the original icon. */ readonly position: IconOverlayPosition; /** * The color of the overlaying icon. If not specified, then the default icon color will be used. */ readonly color?: Color; /** * The optional background color of the overlay icon. */ readonly background?: IconOverlayBackground; }; type IconOverlay = { /** * This should be the name of the Font Awesome icon with out the `fa fa-` prefix, just the name, for instance `paw`. * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/. */ readonly icon: string; } & BaseOverlay; type IconClassOverlay = { /** * This should be the entire Font Awesome class array, for instance ['fa', 'fa-paw'] * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/. */ readonly iconClass: string[]; } & BaseOverlay; } /** * Encapsulates styling information that has to be applied on the widget which we decorate. */ export type TreeViewDecorationData = { /** * The higher number has higher priority. If not specified, treated as `0`. * When multiple decorators are available for the same item, and decoration data cannot be merged together, * then the higher priority item will be applied on the decorated element and the lower priority will be ignored. */ readonly priority?: number; /** * The font data for the caption. */ readonly fontData?: TreeViewDecoration.FontData; /** * The background color of the entire row. */ readonly backgroundColor?: TreeViewDecoration.Color; /** * Optional, leading prefixes right before the caption. */ readonly captionPrefixes?: TreeViewDecoration.CaptionAffix[]; /** * Suffixes that might come after the caption as an additional information. */ readonly captionSuffixes?: TreeViewDecoration.CaptionAffix[]; /** * Optional right-aligned decorations that appear after the widget caption and after the caption suffixes (is any). */ readonly tailDecorations?: (TreeViewDecoration.TailDecoration | TreeViewDecoration.TailDecorationIcon | TreeViewDecoration.TailDecorationIconClass)[]; /** * Custom tooltip for the decorated item. Tooltip will be appended to the original tooltip, if any. */ readonly tooltip?: string; /** * Sets the color of the icon. Ignored if the decorated item has no icon. */ readonly iconColor?: TreeViewDecoration.Color; /** * Has not effect if given, but the widget does not have an associated image. */ readonly iconOverlay?: TreeViewDecoration.IconOverlay | TreeViewDecoration.IconClassOverlay; /** * An array of ranges to highlight the caption. */ readonly highlight?: CaptionHighlight; /** * A count badge for widgets. */ readonly badge?: number; }; export declare namespace TreeViewDecorationData { /** * Compares the decoration data based on the priority. Lowest priorities come first. */ const comparePriority: (left: TreeViewDecorationData, right: TreeViewDecorationData) => number; } //# sourceMappingURL=tree-view-decoration.d.ts.map