@kmeltzer127/react-pelcro-js 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Pelcro Inc.
+
+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

@@ -0,0 +1,135 @@
+
+
+<p align="center">
+  <img src="https://docs-react-elements.pelcro.com/img/logo.png" width="100px" alt="Pelcro logo"/>
+</p>
+
+<h1 align="center" style="border-bottom: none;">Pelcro React Elements</h1>
+
+<p align="center">
+  Tailor your <a href="https://www.pelcro.com/">Pelcro</a> experience to the needs of your clients using our React components
+</p>
+
+<p align="center">
+    <img src="https://github.com/pelcro-inc/react-pelcro-js/actions/workflows/release.yml/badge.svg">
+    <img src="https://github.com/pelcro-inc/react-pelcro-js/actions/workflows/tests.yml/badge.svg">
+    <img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+    </br>
+    <img src="https://img.shields.io/npm/v/@pelcro/react-pelcro-js/latest">
+    <img src="https://img.shields.io/npm/v/@pelcro/react-pelcro-js/beta">
+</p>
+
+
+## Features
+
+- Integrates with our JS SDK out-of-the-box 
+- Supports different levels of customization, need modal-level control? use [Modals](https://docs-react-elements.pelcro.com/Modals/introduction), want fine-grained control? use [Containers](https://docs-react-elements.pelcro.com/Containers/introduction)
+- Provides [`usePelcro` hook](https://docs-react-elements.pelcro.com/usePelcro) which provides a global store for all Pelcro related data and actions
+- Consistent UX across different browsers
+- Easy styling customization using `className` prop and regular CSS
+- First-class Localization support using [react-i18next](https://react.i18next.com/)
+## Documentation
+
+For a complete reference with live examples, check the
+[React Pelcro elements docs](https://docs-react-elements.pelcro.com/)
+
+  
+## Installation 
+
+To use Pelcro components, all you need to do is install the `@pelcro/react-pelcro-js` package
+
+```bash 
+  yarn add @pelcro/react-pelcro-js
+
+  or
+
+  npm install @pelcro/react-pelcro-js
+```
+    
+## Minimal example
+
+```javascript
+import React from "react";
+import {
+  usePelcro,
+  PelcroModalController,
+  Dashboard,
+  DashboardOpenButton,
+  SelectModal,
+  LoginModal,
+  RegisterModal,
+  PaymentMethodUpdateModal,
+  PaymentMethodSelectModal,
+  SubscriptionCreateModal,
+  SubscriptionRenewModal,
+  NewsLetter,
+  PaymentSuccessModal,
+  MeterModal,
+  UserUpdateModal,
+  AddressCreateModal,
+  AddressUpdateModal,
+  PasswordResetModal,
+  PasswordForgotModal,
+  CartModal,
+  ShopView,
+  OrderConfirmModal,
+  OrderCreateModal,
+  GiftCreateModal,
+  GiftRedeemModal,
+  PasswordChangeModal,
+  AddressSelectModal,
+  ProfilePicChangeModal,
+  Notification
+} from "@pelcro/react-pelcro-js";
+import "@pelcro/react-pelcro-js/dist/pelcro.css";
+
+export default function Main() {
+  const { switchView } = usePelcro();
+
+  return (
+    <>
+      <button onClick={() => switchView("login")}>Login</button>
+      <button onClick={() => switchView("dashboard")}>My dashboard</button>
+      <button onClick={() => switchView("plan-select")}>Subscribe</button>
+
+      <PelcroModalController>
+        <MeterModal />
+        <LoginModal />
+        <RegisterModal />
+        <UserUpdateModal />
+        <Dashboard />
+        <DashboardOpenButton />
+        <ProfilePicChangeModal />
+        <PasswordForgotModal />
+        <PasswordChangeModal />
+        <PasswordResetModal />
+        <PaymentMethodUpdateModal />
+        <PaymentMethodSelectModal />
+        <SelectModal />
+        <NewsLetter />
+        <AddressCreateModal />
+        <AddressSelectModal />
+        <AddressUpdateModal />
+        <SubscriptionCreateModal />
+        <SubscriptionRenewModal />
+        <PaymentSuccessModal />
+        <GiftCreateModal />
+        <GiftRedeemModal />
+        <ShopView />
+        <CartModal />
+        <OrderCreateModal />
+        <OrderConfirmModal />
+        <Notification />
+      </PelcroModalController>
+    </>
+  );
+}
+
+```
+
+  
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+