@socotra/ec-react-components 2.0.0 → 2.0.1-alpha.0

package/README.md

@@ -8,7 +8,7 @@ This library is styled via [tailwindcss](https://tailwindcss.com/) and [shadcn/u
 - **Repo Path**: `packages/components`
 - **Install**:
   ```sh
-  npm i @socotra/ec-react-components
+  npm i @socotra/ec-react-components @tailwindcss/container-queries
   ```
 - **Usage**:
 
@@ -19,13 +19,32 @@ This library is styled via [tailwindcss](https://tailwindcss.com/) and [shadcn/u
   import { MyComponent } from '@socotra/ec-react-components';
   ```
 
-### Customization
+- Add the plugin to your `tailwind.config.js` file along with the content path:
+
+  ```js
+  // tailwind.config.js
+  module.exports = {
+    content: [
+      // ...
+      './node_modules/@socotra/ec-react-components/dist/**/*.js',
+    ]
+    theme: {
+      // ...
+    },
+    plugins: [
+      require('@tailwindcss/container-queries'),
+      // ...
+    ],
+  };
+  ```
+
+## Customization
 
 As this library is styled via shadcn components and tailwind, customization can be achieved by installing shadcn in your project. Follow the installation guide from [shadcn](https://ui.shadcn.com/docs/installation) and adjust your theme using the [theme creator](https://ui.shadcn.com/themes).
 
 Once you install shadcn, or if you are using it already, **delete the style.css import** to avoid style collisions
 
-### Running the Project
+### Running the Project Locally
 
 To build the package:
 

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
  * AccountForm is a form for creating or updating an account. It accepts a resolved data model, custom data types, and an optional account object to put the form in update mode. References: https://rjsf-team.github.io/react-jsonschema-form/docs/
  */
 export declare const AccountForm: {
-    ({ accountsModel, accountType, dataTypes, handleSubmit, hideSubmitButton, account, submitButtonText, id, }: Props): JSX_2.Element;
+    ({ accountsModel, accountType, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, account, submitButtonText, id, }: Props): JSX_2.Element;
     displayName: string;
 };
 
@@ -34,6 +34,19 @@ declare type Props = {
      * The function to call when the form is submitted. It will create an AccountCreateRequest or AccountUpdateRequest based on the form data
      */
     handleSubmit: (data: AccountRequest) => void;
+    /**
+     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     */
+    isSubmitting?: boolean;
+    /**
+     * Disables the form
+     */
+    disabled?: boolean;
+    /**
+     * Prevents the form from resetting when disabled
+     * default is false
+     */
+    preventFormResetOnDisabled?: boolean;
     /**
      * The account object to put the form in update mode
      */