iso-3166-1-flags-sprite-generator/dist/cjs/index.d.ts

iso-3166-1 country flags css sprite generator

export interface FlagSpriteOptions {
    /**
     * Whether to center the flag horizontally
     */
    center?: boolean;
    /**
     * Prefix for css classes
     */
    classPrefix?: string;
    /**
     * Name for the generated css file
     */
    cssFileName?: string;
    /**
     * Whether to create a demo file
     */
    demo?: boolean;
    /**
     * Destination for the demo html file. Will have no affect if demo is set to false
     */
    demoDestination?: string;
    /**
     * Whether to add dimensions classes
     */
    dimensionsClasses?: boolean;
    /**
     * Suffix for dimensions classes
     */
    dimensionsSuffix?: string;
    /**
     * Whether to set the alpha2 code in the css classnames to lowercase
     */
    lowecaseAlpha2?: boolean;
    /**
     * Name for the generated sprite png file
     */
    spriteFileName?: string;
    /**
     * Background url for the sprite (excluding the file name)
     */
    spriteUrl?: string;
    /**
     * Maximum width of the flags. Note, all flags will be the same height but not necessarily the same width
     */
    width?: number;
    /**
     * Whether to suppress logging
     */
    silent?: boolean;
}
export default function createFlagSprite(spriteDestination: string, cssDestination: string, options?: FlagSpriteOptions): Promise<void>;