@qr-platform/qr-code.js 0.11.1 → 0.11.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @qr-platform/qr-code-js
 
+## 0.11.2
+
+### Patch Changes
+
+- 1cdc614: Extended the append method to accept options and clear the container when clearContainer is true
+
 ## 0.11.1
 
 ### Patch Changes

package/README.md

@@ -78,7 +78,8 @@ const qrCode = new QRCodeJs(options);
 // 3. Append to a container element (in browser)
 const container = document.getElementById('qr-container');
 if (container) {
-  qrCode.append(container);
+  // Remove any existing content before appending the QR code
+  qrCode.append(container, { clearContainer: true });
 }
 
 // Or get SVG string (Browser or Node.js)

package/docs/api-reference-guide.md

@@ -82,7 +82,7 @@ qrCode.append(document.getElementById('qr-container'));
 
 | Method              | Parameters                                                                 | Description                                                                 |
 | :------------------ | :------------------------------------------------------------------------- | :-------------------------------------------------------------------------- |
-| `append`            | `container: HTMLElement`                                                   | Appends the QR code to a container element. Returns `QRCodeJs \| undefined`. |
+| `append`            | `container: HTMLElement, options?: { clearContainer?: boolean }`                                                   | Appends the QR code to a container element. Returns `QRCodeJs \| undefined`. |
 | `serialize`         | `inverted?: boolean`                                                       | Converts the QR code to an SVG string. Returns `Promise<string \| undefined>`. |
 | `download`          | `downloadOptions?: { name?: string; extension: 'svg' \| 'png' \| 'jpeg' \| 'webp' }, canvasOptions?: CanvasOptions` | Downloads the QR code as a file. Returns `Promise<void>`.                   |
 | `update`            | `options?: RecursivePartial<Options>`                                      | Updates the QR code with new options. Returns `void`.                       |

package/docs/documentation.md

@@ -1656,7 +1656,10 @@ new QRCodeJs(options: QRCodeJsOptions)
 Appends the QR code to a container element.
 
 ```typescript
-qrCode.append(container: HTMLElement): QRCodeJs | undefined
+qrCode.append(
+  container: HTMLElement,
+  options?: { clearContainer?: boolean }
+): QRCodeJs | undefined
 ```
 
 #### `serialize()`

package/docs/usage-guide.md

@@ -486,8 +486,9 @@ if (validationResult.isValid) {
 
 #### Methods
 
-- **`append(container: HTMLElement): void`**
+- **`append(container: HTMLElement, options?: { clearContainer?: boolean }): void`**
   Appends the QR code to a specified container element.
+  If `clearContainer` is `true`, the container's existing contents are removed before appending.
 
 - **`serialize(): Promise<string | undefined>`**
   Converts the QR code to an SVG string.

package/lib/core/qr-code-js.d.ts

@@ -1,5 +1,5 @@
 import { CanvasOptions } from '~/utils/canvas-options';
-import { MethodOverrideOptions, RecursivePartial } from '../types/helper';
+import { AppendOptions, MethodOverrideOptions, RecursivePartial } from '../types/helper';
 import { SettingsOptions } from '../types/settings-options';
 import { StyleOptions } from '../types/style-options';
 import { QRTextTemplateDefinition, TextOptions } from '../types/text-options';
@@ -140,7 +140,7 @@ export declare class QRCodeJs {
     setDescription(description?: string): this;
     setMetadata(metadata?: Record<string, any>): this;
     update(options?: RecursivePartial<Options>): Promise<void>;
-    append(container?: HTMLElement): this;
+    append(container?: HTMLElement, options?: AppendOptions): this;
     applyExtension(extension: ExtensionFunction): Promise<void>;
     deleteExtension(): Promise<void>;
     serialize(inverted?: boolean): Promise<string | undefined>;