Skip to content

feat: add generatePath prop #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qkiroc wants to merge 1 commit into
base: trunk
Choose a base branch
from
+31 −3
Open

feat: add generatePath prop #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,13 @@ type QRProps = {
* @defaultValue true
*/
boostLevel?: boolean;
/**
* Custom function to generate the QR Code path.
* @param modules The modules of the QR Code.
* @param margin The margin size.
* @returns The generated path as a string.
*/
generatePath?: (modules: boolean[][], margin?: number) => string;
/**
* The settings for the embedded image.
*/
Expand Down Expand Up @@ -247,6 +254,10 @@ If enabled, the Error Correction Level of the result may be higher than the spec
| --------- | ------------- |
| `boolean` | `true` |

### `generatePath`

To support more styles, users can pass this callback function to generate a custom QR code path using the QR code matrix and margin.

### `imageSettings`

Used to specify the details for an embedded image, often used to embed a logo.
Expand Down
23 changes: 20 additions & 3 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,14 @@ type QRProps = {
* The settings for the embedded image.
*/
imageSettings?: ImageSettings;

/**
* Custom function to generate the QR Code path.
* @param modules The modules of the QR Code.
* @param margin The margin size.
* @returns The generated path as a string.
*/
generatePath?: typeof generatePathDefault;
};
type QRPropsCanvas = QRProps & React.CanvasHTMLAttributes<HTMLCanvasElement>;
type QRPropsSVG = QRProps & React.SVGAttributes<SVGSVGElement>;
Expand All @@ -154,7 +162,7 @@ const DEFAULT_MARGIN_SIZE = 0;
// get an explicit height or width, I'd rather default to something than throw.
const DEFAULT_IMG_SCALE = 0.1;

function generatePath(modules: Modules, margin: number = 0): string {
function generatePathDefault(modules: Modules, margin: number = 0): string {
const ops: Array<string> = [];
modules.forEach(function (row, y) {
let start: number | null = null;
Expand Down Expand Up @@ -358,6 +366,7 @@ const QRCodeCanvas = React.forwardRef<HTMLCanvasElement, QRPropsCanvas>(
boostLevel,
marginSize,
imageSettings,
generatePath,
...extraProps
} = props;
const {style, ...otherProps} = extraProps;
Expand Down Expand Up @@ -440,7 +449,12 @@ const QRCodeCanvas = React.forwardRef<HTMLCanvasElement, QRPropsCanvas>(
ctx.fillStyle = fgColor;
if (SUPPORTS_PATH2D) {
// $FlowFixMe: Path2D c'tor doesn't support args yet.
ctx.fill(new Path2D(generatePath(cellsToDraw, margin)));
ctx.fill(
new Path2D(
generatePath?.(cellsToDraw, margin) ||
generatePathDefault(cellsToDraw, margin)
)
);
} else {
cells.forEach(function (row, rdx) {
row.forEach(function (cell, cdx) {
Expand Down Expand Up @@ -520,6 +534,7 @@ const QRCodeSVG = React.forwardRef<SVGSVGElement, QRPropsSVG>(
title,
marginSize,
imageSettings,
generatePath,
...otherProps
} = props;

Expand Down Expand Up @@ -565,7 +580,9 @@ const QRCodeSVG = React.forwardRef<SVGSVGElement, QRPropsSVG>(
// way faster than DOM ops.
// For level 1, 441 nodes -> 2
// For level 40, 31329 -> 2
const fgPath = generatePath(cellsToDraw, margin);
const fgPath =
generatePath?.(cellsToDraw, margin) ||
generatePathDefault(cellsToDraw, margin);

return (
<svg
Expand Down
Loading