zigap-utils 0.0.1 → 0.0.2

package/README.md

@@ -1,30 +1,63 @@
-# React + TypeScript + Vite
+# zigap-utils
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+It is a library that collects utils that help communicate between dapp and zigap.
 
-Currently, two official plugins are available:
+## Installation
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+```
+npm i zigap-utils --save -D
+```
 
-## Expanding the ESLint configuration
+## Usage
+
+```ts
+import { LoginQR } from 'zigap-utils';
+
+const App = () => {
+  ...
+
+  return (
+    <div>
+      <LoginQR
+        validTime={10}
+        sigMessage="hello world"
+        onReceive={({ isSuccess, address })=>{
+          if(isSuccess) {
+            // something to do after login
+          }
+        }}
+      />
+    </div>
+  );
+}
+```
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+<br />
 
-- Configure the top-level `parserOptions` property like this:
+---
 
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
-```
+### `LoginQR` props
+
+| prop         | required | type            | default value | description                                        |
+| ------------ | :------: | --------------- | ------------- | -------------------------------------------------- |
+| `sigMessage` |   true   | string          |               | Messages signed to verify the identity of the user |
+| `validTime`  |   true   | number          |               | QR code valid time(minutes)                        |
+| `onReceive`  |   true   | (value) => void |               | Function called after login request                |
+| `size`       |  false   | number          | 128           | canvas width                                       |
+| `bgColor`    |  false   | string          | #fff          | background color                                   |
+| `fgColor`    |  false   | string          | #000          | foreground color                                   |
+| `style`      |  false   | CSSProperties   |               | custom css style                                   |
+
+<br>
+
+### `AddressProvideQR` props
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+| prop         | required | type            | default value | description                                        |
+| ------------ | :------: | --------------- | ------------- | -------------------------------------------------- |
+| `sigMessage` |   true   | string          |               | Messages signed to verify the identity of the user |
+| `validTime`  |   true   | number          |               | QR code valid time(minutes)                        |
+| `onReceive`  |   true   | (value) => void |               | Function called after login request                |
+| `size`       |  false   | number          | 128           | canvas width                                       |
+| `bgColor`    |  false   | string          | #fff          | background color                                   |
+| `fgColor`    |  false   | string          | #000          | foreground color                                   |
+| `style`      |  false   | CSSProperties   |               | custom css style                                   |

package/dist/components/AddressProvideQR/AddressProvideQR.types.d.ts

@@ -8,9 +8,7 @@ export type AddressProvideQRProps = {
     validTime: number;
     onReceive: (result: AddressProvideResultType) => void;
     size?: number;
-    level?: string;
     bgColor?: string;
     fgColor?: string;
     style?: CSSProperties;
-    includeMargin?: boolean;
 };

package/dist/components/LoginQR/LoginQR.types.d.ts

@@ -9,9 +9,7 @@ export type LoginQRProps = {
     validTime: number;
     onReceive: (result: LoginResultType) => void;
     size?: number;
-    level?: string;
     bgColor?: string;
     fgColor?: string;
     style?: CSSProperties;
-    includeMargin?: boolean;
 };

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "zigap-utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "dist/index.es.js",
   "types": "dist/index.d.ts",
   "author": "Seoullabs",
   "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Seoullabs-official/zigap-utils"
+  },
   "files": [
     "dist"
   ],