@lglab/react-qr-code 1.0.1 → 1.1.0

package/README.md

@@ -0,0 +1,6 @@
+# @lglab/react-qr-code
+
+A highly customizable and lightweight QR code generator for React applications.
+
+🚀 **Live Demo:** [reactqrcode.com/demo](https://reactqrcode.com/demo)  
+📖 **Documentation:** [reactqrcode.com](https://reactqrcode.com/)

package/dist/index.d.ts

@@ -14,6 +14,14 @@ export declare interface DataModulesSettings {
  */
 export declare type DataModulesStyle = 'square' | 'square-sm' | 'rounded' | 'leaf' | 'vertical-line' | 'horizontal-line' | 'circle' | 'diamond' | 'star' | 'heart';
 
+export declare type DownloadFileFormat = 'svg' | 'png' | 'jpeg';
+
+export declare interface DownloadOptions {
+    name?: string;
+    format?: DownloadFileFormat;
+    size?: number;
+}
+
 export declare type ERROR_LEVEL_MAPPED_TYPE = {
     [index in ErrorCorrectionLevel]: qrcodegen.QrCode.Ecc;
 };
@@ -202,7 +210,7 @@ export declare const ReactQRCode: {
 };
 
 export declare interface ReactQRCodeProps {
-    ref?: Ref<SVGSVGElement>;
+    ref?: Ref<ReactQRCodeRef>;
     /**
      * The value to encode into the QR Code. An array of strings can be passed in
      * to represent multiple segments to further optimize the QR Code.
@@ -226,10 +234,6 @@ export declare interface ReactQRCodeProps {
      * @defaultValue 0
      */
     marginSize?: number;
-    /**
-     * The title to assign to the QR Code. Used for accessibility reasons.
-     */
-    title?: string;
     /**
      * The minimum version used when encoding the QR Code. Valid values are 1-40
      * with higher values resulting in more complex QR Codes. The optimal
@@ -273,4 +277,9 @@ export declare interface ReactQRCodeProps {
     svgProps?: React.SVGProps<SVGSVGElement>;
 }
 
+export declare interface ReactQRCodeRef {
+    svg: SVGSVGElement | null;
+    download: (options: DownloadOptions) => void;
+}
+
 export { }