@component-hook/pdf-canvas 0.1.1 → 0.1.3-alpha.0

package/README.md

@@ -1,6 +1,6 @@
 # @component-hook/pdf-canvas
 
-Rendering PDF documents onto a canvas with vue3 component ([DEMO](https://tzuyi0817.github.io/component-hook/#/pdf-canvas))  
+Rendering PDF documents onto a canvas with vue3 component ([DEMO](https://tzuyi0817.github.io/component-hook/#/component/pdf-canvas))  
 Implementation depository: [PDF-signature](https://github.com/tzuyi0817/PDF-signature)
 
 <p>
@@ -23,13 +23,13 @@ Implementation depository: [PDF-signature](https://github.com/tzuyi0817/PDF-sign
 ## Installation
 
 ```bash
-npm install @component-hook/pdf-canvas
+$ npm install @component-hook/pdf-canvas
 
 # or use yarn
-yarn add @component-hook/pdf-canvas
+$ yarn add @component-hook/pdf-canvas
 
 # or use pnpm
-pnpm install @component-hook/pdf-canvas
+$ pnpm install @component-hook/pdf-canvas
 ```
 
 ## Basic Usage
@@ -93,7 +93,7 @@ async function uploadFile(event: Event) {
 | fileScale        | false    | `number`  | The actual size of the canvas will affect the display clarity          | 1                                                                                                             |
 | canvasClass      | false    | `string`  | Canvas dom class selector                                              | —                                                                                                             |
 | isDrop           | false    | `boolean` | Control whether to drag and drop images and text onto the canvas       | false                                                                                                         |
-| password         | false    | `string`  | Open password for encrypted PDF files                                  | -                                                                                                             |
+| password         | false    | `string`  | Open password for encrypted PDF files                                  | —                                                                                                             |
 | dropTextOptions  | false    | `object`  | [fabric.js FabricText options](https://github.com/fabricjs/fabric.js)  | [text options](https://github.com/tzuyi0817/component-hook/blob/master/packages/pdf-canvas/configs/index.ts)  |
 | dropImageOptions | false    | `object`  | [fabric.js FabricImage options](https://github.com/fabricjs/fabric.js) | [image options](https://github.com/tzuyi0817/component-hook/blob/master/packages/pdf-canvas/configs/index.ts) |
 | closeSvgOptions  | false    | `object`  | Setup close svg options                                                | [close options](https://github.com/tzuyi0817/component-hook/blob/master/packages/pdf-canvas/configs/index.ts) |

package/dist/index.d.ts

@@ -21,7 +21,7 @@ declare type __VLS_Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 
-declare type __VLS_TypePropsToRuntimeProps<T> = {
+declare type __VLS_TypePropsToOption<T> = {
     [K in keyof T]-?: {} extends Pick<T, K> ? {
         type: PropType<__VLS_NonUndefinedable<T[K]>>;
     } : {
@@ -53,7 +53,7 @@ export declare interface CreateCloseFabricArgs {
     uuid?: number;
 }
 
-declare const _default: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+declare const _default: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
 canvasId: string;
 class: string;
 canvasClass: string;
@@ -67,8 +67,8 @@ addImage: typeof addImage;
 addText: typeof addText;
 clearActive: () => void;
 deleteCanvas: () => void;
-canvasRef: Ref<HTMLCanvasElement | null>;
-}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+canvasRef: Ref<HTMLCanvasElement | null, HTMLCanvasElement | null>;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
 canvasId: string;
 class: string;
 canvasClass: string;