Skip to content
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.

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

What is level and image src? #187

Open
mdodge-ecgrow opened this issue Apr 16, 2022 · 2 comments
Open

What is level and image src? #187

mdodge-ecgrow opened this issue Apr 16, 2022 · 2 comments

Comments

@mdodge-ecgrow
Copy link

I am brand new to using this library. And I was looking through the documentation on the home page. Most of the properties are pretty self explanatory. But two that I can not figure out are level and the src in the image object. It'd be nice if you at least included a sentence about these properties in the docs.

@mdodge-ecgrow
Copy link
Author

Oh and also excavate. What does that one mean as well?

@zpao
Copy link
Owner

zpao commented Apr 16, 2022

That's a good idea, not sure why I haven't done a better job documenting. Playing with https://zpao.github.io/qrcode.react/ hopefully helps to see the effect of the settings.

Level is error correction level: https://www.qrcode.com/en/about/error_correction.html
Src would be equivalent to src for an <img> tag - URL where the image can be loaded from.
And excavate determines if we clear space around that loaded image, so it's not visible overlapping with the foreground squares.

Hope that helps. I'll leave this open though to remind me to write some better docs.

@zpao zpao added this to the 3.1.0 milestone Apr 28, 2022
@zpao zpao removed this from the 3.1.0 milestone May 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants