sales-frontend-solution 0.0.1

package/readme.md

@@ -0,0 +1,55 @@
+# @nxl-kit/api
+
+## 개요
+
+`@nxl-kit/solution`는 보안키패드, v3 등 외부 리소스를 사용하는 라이브러리입니다.
+---
+
+## 설치 방법
+
+```sh
+pnpm add @nxl-kit/solution
+```
+
+---
+
+## 사용 방법
+
+### React 컴포넌트 사용 (`Keypad`)
+
+```ts
+
+import { Keypad } from "@nxl-kit/solution";
+
+export default function Page() {
+  return <Keypad mode={'qwerty'} maxLength={5} inputElement={<input type="text" />} />;
+}
+
+```
+
+### React 컴포넌트 사용 (`v3`)
+
+```ts
+
+import { useV3, V3Provider } from "@nxl-kit/solution";
+
+export default function Page() {
+  const { launch } = useV3();
+
+  useEffect(() => {
+    launch();
+  }, []);
+
+  return <V3Provider></V3Provider>;
+}
+```
+
+---
+
+## 주요 기능
+
+- React 환경에서 키패드 호출을 위한 컴포넌트 제공
+
+- React 환경에서 v3 사용을 위한 provider, custom hook 제공
+
+---