@qr-platform/qr-code.js/lib/node/types/style-options.d.ts

QRCode.js is a professional JavaScript/TypeScript library for creating customized QR codes, offering a blend of simplicity and sophistication. With versatile styling options—dot shapes, colors, gradients, embedded images, borders, and text—it enables you

import { Gradient } from '../utils/gradient';
import { CornerDotType, CornerSquareType, DotType, ImageMode } from '../utils/options';
/**
 * Simplified options for styling QR codes.
 * These options are mapped to the more detailed QRCodeJs Options structure.
 */
export interface StyleOptions {
    primaryColor?: string;
    secondaryColor?: string;
    thirdColor?: string;
    backgroundColor?: string;
    dotsGradient?: Gradient;
    cornersDotGradient?: Gradient;
    cornersGradient?: Gradient;
    backgroundGradient?: Gradient;
    dotShape?: DotType;
    cornerSquareShape?: CornerSquareType;
    cornerDotShape?: CornerDotType;
    logo?: string | Buffer | Blob;
    logoSize?: number;
    logoMode?: ImageMode;
    logoMargin?: number;
    logoBackgroundColor?: string;
    logoPadding?: number;
    logoRadius?: string | number;
    borderColor?: string;
    borderThickness?: number;
    borderRadius?: string | number;
    borderInnerColor?: string;
    borderInnerThickness?: number;
    borderInnerRadius?: string | number;
    borderOuterColor?: string;
    borderOuterThickness?: number;
    borderTextTop?: string;
    borderTextRight?: string;
    borderTextBottom?: string;
    borderTextLeft?: string;
    borderFontFace?: string;
    borderFontSize?: number;
    borderFontColor?: string;
    borderLetterSpacing?: number;
    borderTextTransform?: 'uppercase' | 'lowercase' | 'capitalize';
    borderFontWeight?: string;
}