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

package/dist/index.d.ts

@@ -3,6 +3,9 @@ import { AccountRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { ProductConfigRecord } from '@socotra/ec-react-schemas';
+import { QuoteRequest } from '@socotra/ec-react-schemas';
+import { QuoteResponse } from '@socotra/ec-react-schemas';
 
 /**
  * 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/
@@ -65,9 +68,67 @@ declare type Props = {
     id?: string;
 };
 
+declare type Props_2 = {
+    /**
+     * The resolved data model for quotes retrieved from the data model response
+     */
+    productsModel: ProductConfigRecord;
+    /**
+     * The quote type to use for the form
+     */
+    productType: keyof ProductConfigRecord;
+    /**
+     * The custom data types for the configuration that may be referenced by the DataModel
+     */
+    dataTypes: DataTypeConfigRecord;
+    /**
+     * The function to call when the form is submitted. It will create an QuoteUpdateRequest from the form data.
+     */
+    handleSubmit: (data: QuoteRequest) => 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 quote object to put the form in update mode
+     */
+    quote?: QuoteResponse;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+};
+
 /**
- * QuoteForm is a form for updating a quote. It accepts a resolved data model, custom data types, and a quote object to build on.
+ * QuoteForm is a form for creating or updating an quote. It accepts a resolved data model, custom data types, and an optional quote object to put the form in update mode. References: https://rjsf-team.github.io/react-jsonschema-form/docs/
  */
-export declare const QuoteForm: () => JSX_2.Element;
+export declare const QuoteForm: {
+    ({ productType, productsModel, dataTypes, disabled, handleSubmit, isSubmitting, preventFormResetOnDisabled, hideSubmitButton, validateOnSubmit, quote, submitButtonText, id, }: Props_2): JSX_2.Element;
+    displayName: string;
+};
 
 export { }