@liquid-js/qr-code-styling
    Preparing search index...

    Interface Plugin

    interface Plugin {
        configure?: (options: Options) => void | Options | undefined;
        applyMask?: (
            count: number,
            padding: number,
        ) => void | GeneratorMask | undefined;
        drawDot?: (args: DrawArgs) => void | SVGElement | undefined;
        drawCornerDot?: (args: DrawArgs) => void | SVGElement | undefined;
        drawCornerSquare?: (
            args: DrawArgs,
        ) => void | readonly [SVGElement, SVGElement] | undefined;
        postProcess?: (
            svg: SVGSVGElement,
            options: Options,
            colors: { dots?: ColorElementValue; background?: ColorElementValue },
        ) => void | Promise<void>;
    }

    Implemented by

    Index
    configure? applyMask? drawDot? drawCornerDot? drawCornerSquare? postProcess?
    configure?: (options: Options) => void | Options | undefined

    Modify the options before rendering

    applyMask?: (count: number, padding: number) => void | GeneratorMask | undefined

    Add (or hide) QR code segments, e.g. to fit a QR code into a custom shape, the same way ShapeType.circle fits it inside a circle

    Type Declaration

      • (count: number, padding: number): void | GeneratorMask | undefined

      • Parameters

        • count: number

          QR code size in segments

        • padding: number

          Mask rows and columns required on each side of the QR code (1 in ImageMode.background)

        Returns void | GeneratorMask | undefined

        Segment mask; if undefined, try the next plugin or draw without a mask

    drawDot?: (args: DrawArgs) => void | SVGElement | undefined

    Draw a single dot

    Type Declaration

      • (args: DrawArgs): void | SVGElement | undefined

      • Parameters

        Returns void | SVGElement | undefined

        Dot element; if undefined, try to use the next plugin or the default function

    drawCornerDot?: (args: DrawArgs) => void | SVGElement | undefined

    Draw corner dot

    Type Declaration

      • (args: DrawArgs): void | SVGElement | undefined

      • Parameters

        Returns void | SVGElement | undefined

        Corner dot element; if undefined, try to use the next plugin or the default function

    drawCornerSquare?: (
        args: DrawArgs,
    ) => void | readonly [SVGElement, SVGElement] | undefined

    Draw corner square

    Type Declaration

      • (args: DrawArgs): void | readonly [SVGElement, SVGElement] | undefined

      • Parameters

        Returns void | readonly [SVGElement, SVGElement] | undefined

        Corner square element and corner mask (used with ImageMode.background); if undefined, try to use the next plugin or the default function

    postProcess?: (
        svg: SVGSVGElement,
        options: Options,
        colors: { dots?: ColorElementValue; background?: ColorElementValue },
    ) => void | Promise<void>

    Alter the generated SVG, e.g. add borders

    Settings
    Member Visibility

    On This Page
    Properties