@ohos-ports/html2canvas-pro 0.0.0-stage → 2.3.2-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present yorickshan and html2canvas-pro contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+<p align="center">
+<img src="https://raw.githubusercontent.com/yorickshan/html2canvas-pro/main/docs/public/logo.png" height="150">
+</p>
+<h1 align="center">
+html2canvas-pro
+</h1>
+<p align="center">
+Next generation JavaScript screenshot tool.
+</p>
+<p align="center">
+  <a href="https://github.com/yorickshan/html2canvas-pro/actions/workflows/ci.yml"><img src="https://github.com/yorickshan/html2canvas-pro/actions/workflows/ci.yml/badge.svg?branch=main" alt="build status"></a>
+	  <a href="https://npm.im/html2canvas-pro"><img src="https://badgen.net/npm/v/html2canvas-pro" alt="npm version"></a>
+	  <a href="http://npm.im/html2canvas-pro"><img src="https://badgen.net/npm/dm/html2canvas-pro" alt="npm downloads"></a>
+  <a href="https://www.jsdelivr.com/package/npm/html2canvas-pro"><img src="https://data.jsdelivr.com/v1/package/npm/html2canvas-pro/badge" /></a>
+  <a href="https://deepwiki.com/yorickshan/html2canvas-pro"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+</p>
+<p align="center">
+  <a href="https://yorickshan.github.io/html2canvas-pro/getting-started.html">Getting Started</a>
+</p>
+<br>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## Why html2canvas-pro?
+
+html2canvas-pro is a fork of [niklasvh/html2canvas](https://github.com/niklasvh/html2canvas) that includes various fixes and new features. It offers several advantages over the original html2canvas:
+- Color function `color()` (including relative colors)
+- Color functions `lab()` / `lch()` / `oklab()` / `oklch()`
+- `object-fit` support for `<img/>`
+- CSS `clip-path` support (inset, circle, ellipse, polygon, path)
+- CSS `writing-mode` support (horizontal-tb, vertical-rl, vertical-lr)
+- **Image smoothing control** — CSS `image-rendering` property and `imageSmoothing`/`imageSmoothingQuality` options
+- **Security validation** — Built-in input validation (XSS/SSRF protection)
+- **Performance monitoring** — Built-in performance measurement API
+- Various bug fixes from the [changelog](./CHANGELOG.md)
+
+If you found this helpful, don't forget to
+leave a star 🌟.
+
+## Installation
+
+```sh
+npm install html2canvas-pro
+pnpm add html2canvas-pro
+yarn add html2canvas-pro
+```
+
+## Usage
+```javascript
+import html2canvas from 'html2canvas-pro';
+```
+
+To render an `element` with html2canvas-pro with some (optional) [options](/docs/configuration.md), simply call `html2canvas(element, options);`
+
+### Basic Example
+
+```javascript
+html2canvas(document.body).then(function(canvas) {
+    document.body.appendChild(canvas);
+});
+```
+
+### Controlling Output Dimensions
+
+⚠️ **Important**: By default, the output canvas dimensions are affected by `devicePixelRatio`. 
+
+```javascript
+// If you need exact pixel dimensions (e.g., for a specific file size):
+html2canvas(element, {
+    width: 1920,
+    height: 1080,
+    scale: 1  // Set scale to 1 for exact dimensions
+}).then(canvas => {
+    // Canvas will be exactly 1920×1080 pixels
+    const dataURL = canvas.toDataURL('image/png');
+});
+```
+
+See the [Configuration Guide](/docs/configuration.md#canvas-dimensions) for more details.
+
+## Contribution
+
+If you'd like to add a feature, feel free to submit a PR.
+
+Interested in becoming a maintainer? Open an [issue](https://github.com/yorickshan/html2canvas-pro/issues) or reach out to [@yorickshan](https://github.com/yorickshan).
+
+## License
+
+[MIT](LICENSE)