carbon-components-angular/icon/icon.service.d.ts

Next generation components

/*!
 *
 * Neutrino v0.0.0 | icon.service.d.ts
 *
 * Copyright 2014, 2018 IBM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


import { EventEmitter } from "@angular/core";
import { HttpClient } from "@angular/common/http";
import { Observable } from "rxjs";
import { IconSize } from "./icon.types";
/**
 * Service that provides static methods for globally configuring icon requests,
 * and instance methods for requesting sprites and converting sizes to pixel values
 */
export declare class IconService {
    private http;
    static spriteLoaded: EventEmitter<{}>;
    /**
     * Internal variable to track running requests.
     * Used to call spriteLoaded when new sprites are available
     */
    private static runningRequests;
    /**
     * map to use for sprite requests
     *
     * we just cache the whole promise since we can always `.then` out the result
     * */
    private static spriteCache;
    /** how aggressively to cache sprites. defaults to simple */
    private static cacheLevel;
    /** URL to request sprites from */
    private static baseURL;
    /**
     * Sets the baseURL
     *
     * By default we use http://peretz-icons.mybluemix.net/ for sprites - this is sufficient for prototyping,
     * but for development and production it is recommended to build streamlined sprites and host them statically.
     *
     * @param {string} url
     */
    static setBaseURL(url: string): typeof IconService;
    /**
     * sets the caching level for sprites.
     * "none" disables caching (sprites will always be requested again)
     * "simple" uses a static Map as a naive cache
     *
     * @param {"none" | "simple"} level
     */
    static setCacheLevel(level: "none" | "simple"): typeof IconService;
    /** get an instance of the Http service */
    constructor(http: HttpClient);
    /**
     * Responsible for fetching sprites from the `baseURL`
     *
     * @param {string} name name of the sprite to request
     */
    doSpriteRequest(name: string): Observable<string>;
    /**
     * Returns a promise that will resolve to a clone of the requested icon
     *
     * @param name name of the icon
     * @param size size of the icon as an IconSize
     */
    getIcon(name: string, size: IconSize): Promise<HTMLElement>;
    /**
     * Requests and caches the specified sprite
     *
     * @param {string} name name of the sprite to request
     */
    getSprite(name: string): Observable<string>;
}