qrcode-alipay 1.0.0

package/LEGAL.md

@@ -0,0 +1,7 @@
+Legal Disclaimer
+
+Within this source code, the comments in Chinese shall be the original, governing version. Any comment in other languages are for reference only. In the event of any conflict between the Chinese language version comments and other language version comments, the Chinese language version shall prevail.
+
+法律免责声明
+
+关于代码注释部分，中文注释为官方版本，其它语言注释仅做参考。中文注释可能与其它语言注释存在不一致，当中文注释与其它语言注释存在不一致时，请以中文注释为准。

package/LICENSE

@@ -0,0 +1,30 @@
+Proprietary Limited Use License
+
+Copyright (c) Ant Group and/or its affiliates.
+All rights reserved.
+
+Permission is hereby granted to install, run, and integrate the packaged
+qrcode-alipay npm artifact solely for generating and displaying
+Alipay-branded QR codes in products or services that are authorized to use
+Alipay payment or checkout capabilities.
+
+This license does not grant permission to:
+
+1. copy, publish, redistribute, sublicense, sell, or otherwise make the package
+   or any substantial portion of it available as a standalone library;
+2. modify, reverse engineer, decompile, or create derivative works from the
+   package, except to the extent such restriction is prohibited by applicable
+   law;
+3. remove, obscure, or alter any proprietary notice, trademark notice, or
+   attribution included in the package;
+4. use Alipay names, logos, icons, or brand assets except as permitted by the
+   applicable Alipay brand, payment, checkout, or integration agreements.
+
+The package 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
+copyright holders or their affiliates be liable for any claim, damages, or
+other liability arising from or in connection with the package or its use.
+
+If you have a separate written agreement governing use of this package or
+Alipay brand assets, that agreement controls to the extent of any conflict.

package/README.md

@@ -0,0 +1,82 @@
+# qrcode-alipay
+
+支付宝品牌二维码生成器。默认输出符合支付场景视觉的 SVG 二维码：三个定位点使用支付宝蓝，中间带支付宝「支」logo，核心 API 不依赖 React、Vue 或浏览器 DOM。
+
+## 安装
+
+```bash
+pnpm add qrcode-alipay
+```
+
+## 快速使用
+
+```ts
+import { toSvg, toDataURL, createAlipayQRCode } from 'qrcode-alipay';
+
+const svg = toSvg('https://qr.alipay.com/example', {
+  size: 240,
+  title: '支付宝支付二维码',
+});
+
+const dataUrl = toDataURL('https://qr.alipay.com/example', {
+  size: 240,
+});
+
+const descriptor = createAlipayQRCode('https://qr.alipay.com/example');
+```
+
+## React
+
+```tsx
+import { AlipayQRCode } from 'qrcode-alipay/react';
+
+export function PaymentQRCode({ value }: { value: string }) {
+  return <AlipayQRCode value={value} size={240} ariaLabel="支付宝支付二维码" />;
+}
+```
+
+## Vue 3
+
+```vue
+<script setup lang="ts">
+import { AlipayQRCode } from 'qrcode-alipay/vue';
+</script>
+
+<template>
+  <AlipayQRCode :value="value" :size="240" aria-label="支付宝支付二维码" />
+</template>
+```
+
+## 配置项
+
+公开配置只覆盖通用渲染能力：
+
+| 参数 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| `size` | `number \| string` | `240` | SVG 的宽高。不传时是固定 `240`，不会自动变成 `100%`。 |
+| `margin` | `number` | `0` | 二维码 quiet zone，单位为二维码模块。 |
+| `title` | `string` | - | 写入 SVG 内部的 `<title>`。 |
+| `ariaLabel` | `string` | `Alipay QR code` | SVG 根节点的可访问性描述。 |
+| `className` | `string` | - | SVG 根节点 class。 |
+
+品牌色、中心 logo 和纠错等级默认固定，避免不同业务接入后出现不一致的支付宝支付二维码。
+
+扫码安全建议：如果二维码外层没有白色 padding 或白色卡片容器，建议传 `margin: 1` 或更高；如果外层已经有足够白色留白，保持默认 `margin: 0` 更符合组件布局习惯。
+
+响应式建议：`size` 不传默认是 `240`。如需自适应父容器，请显式传 `size: '100%'`，并确保父容器有稳定的宽高或 `aspect-ratio: 1`。
+
+## 文档
+
+公开使用说明见 [publicDocs/usage.md](./publicDocs/usage.md)。
+
+## 本地开发
+
+```bash
+pnpm install
+pnpm typecheck
+pnpm test
+pnpm build
+pnpm demo
+```
+
+`docs/` 是内部设计与实现文档，不会随 npm 包发布。