import type { Percent } from "./Percent";
import type { IPointerEvent } from "../render/backend/Renderer";
import type { Sprite } from "../render/Sprite";
import * as $type from "./Type";
import type { IBounds } from "./IBounds";
import { DisposerClass, IDisposer } from "./Disposer";
/**
 * ============================================================================
 * DOM FUNCTIONS
 * ============================================================================
 * @hidden
 */
/**
 * Calls `f` when the DOM is ready, or right away if it already is.
 *
 * @since 5.0.2
 * @param  f  Callback
 */
export declare function ready(f: () => void): void;
/**
 * Removes a DOM element.
 * @param  el  Target element
 */
export declare function removeElement(el: HTMLElement): void;
/**
 * Function that adds a disposable event listener directly to a DOM element.
 *
 * @ignore Exclude from docs
 * @param dom       A DOM element to add event to
 * @param type      Event type
 * @param listener  Event listener
 * @returns Disposable event
 */
export declare function addEventListener<E extends Event>(dom: EventTarget, type: string, listener: (event: E) => void, options?: any): IDisposer;
/**
 * Calls `listener` when the window is resized, which also happens when the
 * browser's zoom changes.
 *
 * @param listener  Event listener
 * @returns Disposable event
 */
export declare function onZoom(listener: () => void): IDisposer;
/**
 * @ignore
 */
export declare function supports(cap: "touchevents" | "pointerevents" | "mouseevents" | "wheelevents" | "keyboardevents"): boolean;
/**
 * @ignore
 */
export declare function getPointerId(event: IPointerEvent): any;
/**
 * Removes focus from any element by shifting focus to body.
 *
 * @ignore
 */
export declare function blur(): void;
/**
 * Focuses element.
 *
 * @ignore
 */
export declare function focus(el: HTMLElement): void;
/**
 * @ignore
 */
export declare function getRendererEvent(key: string): string;
/**
 * Returns `true` if the event came from touch or a pen, `false` if from a
 * mouse.
 *
 * @param ev  Original event
 * @return Touch pointer?
 */
export declare function isTouchEvent(ev: MouseEvent | Touch): boolean;
/**
 * Sets style property on DOM element.
 *
 * @ignore Exclude from docs
 */
export declare function setStyle(dom: HTMLElement, property: string, value: string | undefined): void;
/**
 * Gets style property value on a DOM element.
 *
 * @ignore Exclude from docs
 */
export declare function getStyle(dom: HTMLElement, property: string): string | undefined;
/**
 * Gets the target of the event, works for shadow DOM too.
 */
export declare function getEventTarget(event: Event | Touch): Node | null;
/**
 * Checks if element `a` contains element `b`, or is `b`. Looks across shadow
 * DOM boundaries too.
 *
 * @param a  Alleged ancestor
 * @param b  Alleged descendant
 * @return Contains?
 */
export declare function contains(a: Element, b: Element): boolean;
/**
 * Returns `true` if pointer event originated on an element within Root.
 *
 * @since 5.2.8
 * @param  event   Event
 * @param  target  Any element of the [[Root]] to check
 */
export declare function isLocalEvent(event: IPointerEvent, target: Sprite): boolean | null;
/**
 * Disables or enables interactivity of a DOM element.
 *
 * @param  target       Target element
 * @param  interactive  Interactive?
 */
export declare function setInteractive(target: HTMLElement, interactive: boolean): void;
/**
 * Returns a normalized key name from a keyboard event.
 *
 * @ignore
 */
export declare function getEventKey(event: KeyboardEvent): string;
/**
 * Returns the shadow root the node is in, or `null` if it is not in one.
 *
 * @param a  Node
 * @return Root
 */
export declare function getShadowRoot(a: Node): ShadowRoot | null;
/**
 * Defines a class for a CSS rule.
 *
 * Can be used to dynamically add CSS to the document.
 */
export declare class StyleRule extends DisposerClass {
    private _root;
    /**
     * CSS rule.
     */
    private _rule;
    /**
     * A CSS selector text.
     *
     * E.g.: `.myClass p`
     *
     * @param selector  CSS selector
     */
    set selector(selector: string);
    /**
     * @return CSS selector
     */
    get selector(): string;
    /**
     * Constructor.
     *
     * @param element   Shadow root to add the rule to, or `null` for the document
     * @param selector  CSS selector
     * @param styles    An object of style attribute - value pairs
     * @param nonce     Nonce for the `<style>` element, for a Content Security Policy
     */
    constructor(element: ShadowRoot | null, selector: string, styles: {
        [name: string]: string;
    }, nonce?: string);
    protected _dispose(): void;
    /**
     * Sets the same style properties with browser-specific prefixes.
     *
     * @param name   Attribute name
     * @param value  Attribute value
     */
    private _setVendorPrefixName;
    /**
     * Sets a value for specific style attribute.
     *
     * @param name   Attribute
     * @param value  Value
     */
    setStyle(name: string, value: string): void;
}
/**
 * Defines a class for an entire CSS style sheet.
 *
 * Can be used to dynamically add CSS to the document.
 */
export declare class StyleSheet extends DisposerClass {
    private _element;
    /**
     * Constructor.
     *
     * @param element  Shadow root to add the style sheet to, or `null` for the document
     * @param text     CSS stylesheet
     * @param nonce    Nonce for the `<style>` element, for a Content Security Policy
     */
    constructor(element: ShadowRoot | null, text: string, nonce?: string);
    protected _dispose(): void;
}
/**
 * Adds a class name to an HTML or SVG element.
 *
 * @ignore Exclude from docs
 * @param element    Element
 * @param className  Class name to add
 */
export declare function addClass(element: HTMLElement | SVGElement, className: string): void;
/**
 * Removes a class name from an HTML or SVG element.
 *
 * @ignore Exclude from docs
 * @param element    Element
 * @param className  Class name to remove
 */
export declare function removeClass(element: HTMLElement, className: string): void;
/**
 * Returns `true` if the current device is running iOS.
 *
 * @return Is iOS?
 */
export declare function iOS(): boolean;
/**
 * Returns a safe canvas resolution for the current device.
 * Returns `1` on iOS to avoid memory issues, `undefined` otherwise.
 *
 * @return Resolution or undefined
 */
export declare function getSafeResolution(): number | undefined;
/**
 * Converts a value that can be a number or [[Percent]] to an absolute number
 * relative to the given full value.
 *
 * @param percent  Input value (number or Percent)
 * @param full     Full reference value
 * @return Absolute value
 */
export declare function relativeToValue(percent: number | Percent | undefined | null, full: number): number;
/**
 * Returns number of decimals
 *
 * @ignore Exclude from docs
 * @param number  Input number
 * @return Number of decimals
 */
export declare function decimalPlaces(number: number): number;
/**
 * ============================================================================
 * STRING FORMATTING FUNCTIONS
 * ============================================================================
 * @hidden
 */
/**
 * Pads a string with additional characters to certain length.
 *
 * @param value  A numeric value
 * @param len    Result string length in characters
 * @param char   A character to use for padding
 * @return Padded value as string
 */
export declare function padString(value: any, len?: number, char?: string): string;
/**
 * Removes whitespace from the beginning of a string.
 *
 * @param text  Source string
 * @return Trimmed string
 */
export declare function trimLeft(text: string): string;
/**
 * Removes whitespace from the end of a string.
 *
 * @param text  Source string
 * @return Trimmed string
 */
export declare function trimRight(text: string): string;
/**
 * Removes whitespace from both ends of a string.
 *
 * @param text  Source string
 * @return Trimmed string
 */
export declare function trim(text: string): string;
/**
 * Truncates a string to a maximum length, appending an ellipsis.
 *
 * @param text        Source string
 * @param maxLength   Maximum character length
 * @param breakWords  Allow breaking mid-word?
 * @param ellipsis    Ellipsis string to append
 * @return Truncated string
 */
export declare function truncateTextWithEllipsis(text: string, maxLength: number, breakWords?: boolean, ellipsis?: string): string;
/**
 * Tries to determine format type.
 *
 * @ignore Exclude from docs
 * @param format  Format string
 * @return Format type ("string" | "number" | "date" | "duration")
 */
export declare function getFormat(format: string): string;
/**
 * Cleans up format:
 * * Strips out formatter hints
 *
 * @ignore Exclude from docs
 * @param format  Format
 * @return Cleaned format
 */
export declare function cleanFormat(format: string): string;
/**
 * Strips all tags from the string.
 *
 * @param text  Source string
 * @return String without tags
 */
export declare function stripTags(text: string): string;
/**
 * Returns the text of an HTML string: tags removed, entities such as `&amp;`
 * turned into characters. For attributes like `title` that do not parse HTML.
 *
 * @ignore
 * @param html  Source string
 * @return Plain text
 */
export declare function htmlToText(html: string): string;
/**
 * Strips inline formatting tags (square brackets) from the string.
 *
 * @param text  Source string
 * @return String without tags
 */
export declare function stripFormatTags(text: string): string;
/**
 * Replaces line breaks in a string with `". "` and removes HTML tags.
 *
 * @param text  String to convert
 * @return Converted string
 */
export declare function plainText(text: string): string;
/**
 * Removes the parts of an HTML string that are practically only used for
 * cross-site scripting (XSS), leaving legitimate markup intact:
 *
 * * `<script>`, `<iframe>`, `<object>`, `<embed>` and similar dangerous tags;
 * * inline event handler attributes (`onerror`, `onload`, `onclick`, ...);
 * * `javascript:` / `vbscript:` (and similar) protocol URLs in attributes;
 * * inline styles that smuggle in scripts via `expression()`,
 *   `url(javascript:...)`, `behavior`, or `-moz-binding`.
 *
 * [[Root]] applies it to the HTML it puts on the page (`html` and `labelHTML`
 * settings, HTML tooltips, modals, export menu labels), unless its
 * `sanitizeHTML` setting is `false`.
 *
 * @since 5.19.0
 * @param   html  Source HTML
 * @return        Sanitized HTML
 */
export declare function sanitizeHTML(html: string): string;
/**
 * Escapes string so it can safely be used in a Regex.
 *
 * @param value  Unescaped string
 * @return Escaped string
 */
export declare function escapeForRgex(value: string): string;
/**
 * Adds a space before each uppercase letter, except the first character.
 * Characters without case, such as digits and spaces, count as uppercase.
 *
 * @param   str Input string
 * @return      Output string
 */
export declare function addSpacing(str: string): string;
/**
 * Splits the string into separate characters. Keeps RTL words non-split.
 *
 * @param   source  Input
 * @return          Split text
 */
export declare function splitString(source: string): string[];
/**
 * ============================================================================
 * DATE-RELATED FUNCTIONS
 * ============================================================================
 * @hidden
 */
/**
 * Returns the day of the year, `1` being January 1.
 *
 * @param date  Date
 * @param utc   Read the date's UTC fields
 * @return Year day
 */
export declare function getYearDay(date: Date, utc?: boolean): number;
/**
 * Returns the ISO 8601 week number of a date: weeks start on Monday, and
 * week 1 is the one with the year's first Thursday.
 *
 * @param date  Date
 * @param utc   Read the date's UTC fields
 * @return Week number
 */
export declare function getWeek(date: Date, utc?: boolean): number;
/**
 * Returns the year that the ISO 8601 week of the date belongs to. Around
 * January 1 it can differ from the calendar year.
 *
 * @param date  Date
 * @param utc   Read the date's UTC fields
 * @return Year of week
 * @since 5.3.0
 */
export declare function getWeekYear(date: Date, utc?: boolean): number;
/**
 * Returns a week number in the month.
 *
 * @param date  Source Date
 * @param utc   Assume UTC dates?
 * @return Week number in month
 */
export declare function getMonthWeek(date: Date, utc?: boolean): number;
/**
 * Returns a year day out of the given week number.
 *
 * @param week     Week
 * @param year     Year
 * @param weekday  Weekday
 * @param utc      Assume UTC dates
 * @return Day in a year
 */
export declare function getDayFromWeek(week: number, year: number, weekday?: number, utc?: boolean): number;
/**
 * Returns 12-hour representation out of the 24-hour hours.
 *
 * @param hours  24-hour number
 * @param base   Number the hours start from: `1` (default) gives 1-12, `0` gives 0-11
 * @return 12-hour number
 */
export declare function get12Hours(hours: number, base?: number): number;
/**
 * Returns a string name of the time zone.
 *
 * @param date      Date object
 * @param long      Should return long ("Pacific Standard Time") or short abbreviation ("PST")
 * @param savings   Include information if it's in daylight savings mode
 * @param utc       Assume UTC dates
 * @param timezone  IANA time zone name to use instead of the browser's
 * @return Time zone name
 */
export declare function getTimeZone(date: Date, long?: boolean, savings?: boolean, utc?: boolean, timezone?: string): string;
/**
 * Returns the UTC offset in minutes for a given timezone, positive west of
 * UTC, as with `Date.getTimezoneOffset()`.
 *
 * @param timezone    IANA timezone identifier
 * @param targetDate  Date to check offset for; January 1, 2012 if not set
 * @return Offset in minutes
 */
export declare function getTimezoneOffset(timezone: string, targetDate?: Date): number;
/**
 * Capitalizes the first letter of a string.
 *
 * @param text  Source string
 * @return Capitalized string
 */
export declare function capitalizeFirst(text: string): string;
/**
 * ============================================================================
 * COLOR UTILS
 * ============================================================================
 */
/**
 * Represents an interface for an object that represents an RGB color.
 */
export interface iRGB {
    r: number;
    g: number;
    b: number;
    a?: number;
}
/**
 * Represents an interface for an object that represents an HSL color.
 */
export interface iHSL {
    h: number;
    s: number;
    l: number;
    a?: number;
}
/**
 * Represents an interface for an object that represents an HSV color.
 */
export interface iHSV {
    h: number;
    s: number;
    v: number;
    a?: number;
}
/**
 * The functions below are taken and adapted from Garry Tan's blog post:
 * http://axonflux.com/handy-rgb-to-hsl-and-rgb-to-hsv-color-model-c
 *
 * The further attributions go mjijackson.com, which now seems to be defunct.
 */
/**
 * Converts an HSL color to RGB: `h`, `s` and `l` from `0` to `1` in, `r`, `g`
 * and `b` from `0` to `255` out. Alpha is not carried over.
 *
 * Function adapted from:
 * http://axonflux.com/handy-rgb-to-hsl-and-rgb-to-hsv-color-model-c
 *
 * @param color  HSL color
 * @return The RGB representation
 */
export declare function hslToRgb(color: iHSL): iRGB;
/**
 * Converts an RGB color to HSL: `r`, `g` and `b` from `0` to `255` in, `h`,
 * `s` and `l` from `0` to `1` out. Alpha is not carried over.
 *
 * Function adapted from:
 * http://axonflux.com/handy-rgb-to-hsl-and-rgb-to-hsv-color-model-c
 *
 * @param color  RGB color
 * @return The HSL representation
 */
export declare function rgbToHsl(color: iRGB): iHSL;
/**
 * Converts HSV to HSL.
 *
 * https://en.wikipedia.org/wiki/HSL_and_HSV#HSV_to_HSL
 */
export declare function hsvToHsl(hsv: iHSV): iHSL;
/**
 * Converts HSL to HSV.
 *
 * https://en.wikipedia.org/wiki/HSL_and_HSV#HSL_to_HSV
 */
export declare function hslToHsv(hsl: iHSL): iHSV;
/**
 * Returns a color lightened by `percent`, from `-1` to `1`: `0.2` moves each
 * channel 20% of the way to `255`. A negative value darkens it toward `0`.
 *
 * @param rgb      Reference color
 * @param percent  Amount, from `-1` to `1`
 * @return New color
 */
export declare function lighten(rgb: $type.Optional<iRGB>, percent: number): $type.Optional<iRGB>;
/**
 * Gets lightness step.
 *
 * @param value    Value
 * @param percent  Percent
 * @return Step
 */
export declare function getLightnessStep(value: number, percent: number): number;
/**
 * Returns a color brightened by `percent`, from `-1` to `1`. Unlike
 * `lighten()`, it adds the same amount to every channel.
 *
 * @param rgb      Source color
 * @param percent  Amount, from `-1` to `1`
 * @return New color
 */
export declare function brighten(rgb: $type.Optional<iRGB>, percent: number): $type.Optional<iRGB>;
/**
 * Returns brightness step.
 *
 * @ignore Exclude from docs
 * @param value    Value
 * @param percent  Percent
 * @return Step
 */
export declare function getBrightnessStep(_value: number, percent: number): number;
/**
 * Returns `true` if color is "light", for example to pick dark text to go on
 * it.
 *
 * @param color  Source color
 * @return Light?
 */
export declare function isLight(color: iRGB): boolean;
/**
 * Returns `rgb` with its saturation set to `saturation`, from `0` (grey) to
 * `1`. The value replaces the color's saturation; `1` returns `rgb`
 * unchanged.
 *
 * @param rgb         Base color
 * @param saturation  Saturation (0-1)
 * @return New color
 */
export declare function saturate(rgb: $type.Optional<iRGB>, saturation: number): $type.Optional<iRGB>;
/**
 * Returns `lightAlternative` or `darkAlternative`, whichever contrasts more
 * with `color`.
 *
 * @param  color             Base color
 * @param  lightAlternative  Light option
 * @param  darkAlternative   Dark option
 * @return New color
 */
export declare function alternativeColor(color: iRGB, lightAlternative?: iRGB, darkAlternative?: iRGB): iRGB;
/**
 * @ignore
 */
export declare function mergeTags(tags1: string[] | undefined, tags2: string[]): string[];
/**
 * @ignore
 */
export declare function sameBounds(a: IBounds, b?: IBounds): boolean;
//# sourceMappingURL=Utils.d.ts.map