@vkontakte/vk-qr 2.1.1 → 3.1.0

package/src/types.ts

@@ -3,59 +3,77 @@ export type QrOptions = {
    * Size of QR code
    * @default 128
    */
-  qrSize?: number;
+  qrSize?: number | undefined;
 
   /**
    * Class name of root SVG element
    */
-  className?: string;
+  className?: string | undefined;
 
   /**
    * Show VK logo in center of QR code
    * @default false
    */
-  isShowLogo?: boolean;
+  isShowLogo?: boolean | undefined;
 
   /**
    * Show QR background
    * @default false
    */
-  isShowBackground?: boolean;
+  isShowBackground?: boolean | undefined;
 
   /**
    * QR code background HEX color. Works if `isShowBackground` is enabled.
    * @default "#ffffff"
    */
-  backgroundColor?: string;
+  backgroundColor?: string | undefined;
+
+  /**
+   * Background frame thickness in output pixels. Works if `isShowBackground` is enabled.
+   * Must be finite and non-negative. Clamped to half of `qrSize`.
+   * @default 20
+   */
+  backgroundPadding?: number | undefined;
+
+  /**
+   * Background corner radius in output pixels. Works if `isShowBackground` is enabled.
+   * Must be finite and non-negative. Clamped to half of `qrSize`.
+   * @default 36
+   */
+  backgroundRadius?: number | undefined;
 
   /**
    * QR code HEX color
    */
-  foregroundColor?: string;
+  foregroundColor?: string | undefined;
 
   /**
    * Color of logo
    * @default "#000000"
    */
-  logoColor?: string;
+  logoColor?: string | undefined;
 
   /**
    * Reference to logo as a reference IRI
    */
-  logoData?: string | null;
+  logoData?: string | null | undefined;
 
   /**
    * SVG elements id postfix
    */
-  suffix?: string;
+  suffix?: string | undefined;
 
   /**
    * ECC Level
    */
-  ecc?: number
+  ecc?: number | undefined;
 
   /**
-   * Custom INC_TILE_SIZE
+   * @deprecated Ignored. QR module size is fixed internally.
    */
-  incTileSize?: number
+  incTileSize?: number | undefined;
 };
+
+type NotUndefined<T> = { [k in keyof T]-?: Exclude<T[k], undefined> };
+
+export type RequiredQrOptions = NotUndefined<QrOptions>;