diff --git a/docs/docs/help/New-Document/widgets.md b/docs/docs/help/New-Document/widgets.md index 33da99b56..3194e1ca9 100644 --- a/docs/docs/help/New-Document/widgets.md +++ b/docs/docs/help/New-Document/widgets.md @@ -9,42 +9,44 @@ Widgets in **OpenSign** are interactive fields that you can place on your docume They make your documents dynamic — allowing signers to fill in details like names, dates, numbers, checkboxes, or digital signatures directly within the document. -Widgets help you: +**Widgets help you:** - Create fillable and interactive documents - Control the type of input signers can provide (text, date, number, etc.) - Ensure data consistency and validation - Streamline form completion and signing workflows -OpenSign offers various widget types such as **Signature**, **Initial**, **Text**, **Date**, **Checkbox**, **Stamp**, and now the newly added **Number Widget** — each designed for specific use cases. +OpenSign offers various widget types such as **Signature**, **Initial**, **Text**, **Date**, **Checkbox**, **Stamp**, and the newly added **Number Widget** — each designed for specific use cases. -# 🧮 Number Widget – Help Guide +--- -The **Number Widget** in **OpenSign** allows you to collect numeric input from signers within your document — such as phone numbers, invoice totals, employee IDs, or any other numerical values. +# 🧮 Number Widget -This widget ensures that only **numbers** can be entered, helping maintain data accuracy and consistency in your signed documents. +The **Number Widget** in **OpenSign** lets you collect numeric input from signers within your document. +It can also perform **dynamic calculations** using values from other number widgets. + +This widget ensures that only **numbers** are entered, helping maintain data accuracy and consistency across signed documents. --- ## 🔹 Purpose -Use the **Number Widget** when you need signers to input strictly numerical data during the signing process. +Use the **Number Widget** when you need signers to input strictly numeric data during the signing process. It’s ideal for: -- Numeric IDs (e.g., Employee ID, Order Number) -- Contact numbers -- Amounts or values -- Zip/Postal codes -- Quantity or count fields +- Numeric IDs (e.g., Employee ID, Order Number) +- Amounts or currency values +- Quantity or item counts +- Zip/Postal codes --- -## 🧭 How to Add the Number Widget +## 🧭 How to Add a Number Widget -1. Open a document in the **OpenSign editor**. +1. Upload the document and open the Create Document panel. 2. From the **Widget Toolbar**, select **“Number”**. 3. Click anywhere on the document where you want the number field to appear. -4. Adjust the size and position as needed. -5. Assign the widget to a **signer** (if the document has multiple signers). +4. Adjust its size and position as needed. +5. Assign the widget to a **signer** (if the document has multiple signers). --- @@ -54,12 +56,13 @@ You can configure the following options for the **Number Widget**: | **Property** | **Description** | |---------------|-----------------| -| **Label** | Adds a name or description for the field (e.g., *Enter Invoice Number*). | -| **Placeholder** | Displays a hint or example inside the field before the signer types (e.g., *12345*). | -| **Default Value** | Pre-fills the field with a number (optional). | -| **Required** | Makes the field mandatory for the signer to complete before submission. | -| **Read-Only** | Displays the number but prevents editing by the signer. | -| **Validation** | Ensures only numbers are entered — no alphabets or special characters are allowed. | +| **Name** | A unique identifier for this number widget.
• Example: `number-1`, `number-2`
• Must be unique within the document.
• Used in formulas as `{{number-1}}`.
🔸 *If you include a number widget in a formula, its name must be unique, since formulas rely on these identifiers.* | +| **Default Value** | (Optional) Sets an initial numeric value for the widget. This value appears automatically unless changed by the signer or overridden by a formula. | +| **Formula** | Defines a calculation using other number widgets.| +| **Required / Optional** | Specifies whether the signer must complete the field before submission. | +| **Placeholder** | Displays hint text before input (e.g., *12345*). | +| **Font Size** | Controls the font size of the number displayed on the document. | +| **Color** | Sets the font color for the number field. | --- @@ -67,34 +70,62 @@ You can configure the following options for the **Number Widget**: When the document is opened for signing: -- The signer will see a numeric input box where the Number Widget is placed. -- Only **digits (0–9)** can be entered in the field. -- If the field is marked **Required**, the signer cannot complete signing without entering a number. -- The entered number will appear in the final signed PDF. +- The signer will see a **numeric input box** at the widget’s location. +- Only **digits (0–9)** can be entered. +- If marked as **Required**, the signer cannot finish signing without entering a number. +- The entered value appears in the final signed PDF. --- -## 📄 Example Use Case +## 🔢 Using Formulas in the Number Field -**Scenario:** -You’re sending a purchase order form where the vendor needs to enter a **quotation amount**. -Add a **Number Widget** labeled “Quotation Amount” and mark it as **Required**. -This ensures the vendor provides a valid numeric value before submitting the signed document. +You can use number widgets to perform **arithmetic and algebraic calculations** inside the **Formula** field. +Assume you have four number widgets named: +`number-1`, `number-2`, `number-3`, and `number-4`. --- -## 💡 Tips +### 🧩 Basic Formulas -- Use the **Number Widget** for fields where accuracy is critical — such as payment amounts or IDs. -- Combine with **Text** or **Date Widgets** to create comprehensive forms. -- Avoid using the **Number Widget** for formatted data (e.g., currency symbols, percentages). For such cases, predefine formatting in the document. +| **Formula** | **Description** | **Example Result** | +|--------------|-----------------|--------------------| +| `{{number-1}} + {{number-2}}` | Adds two numbers | 10 + 5 = **15** | +| `{{number-1}} - {{number-3}}` | Subtracts one number from another | 20 - 4 = **16** | +| `{{number-1}} * {{number-2}}` | Multiplies two numbers | 6 * 3 = **18** | +| `{{number-1}} / {{number-2}}` | Divides one number by another | 25 / 5 = **5** | +| `({{number-1}} + {{number-2}}) * {{number-3}}` | Groups values using parentheses | (4 + 6) * 2 = **20** | +| `{{number-1}} + {{number-2}} - ({{number-3}} * {{number-4}})` | Combines multiple operations | 10 + 8 - (2 * 3) = **12** | --- -## 🔐 Output in Final Document +### 🧮 Advanced Formulas -Once signed, the numeric input appears exactly as entered in the signed PDF, maintaining consistent alignment and formatting. +| **Formula** | **Description** | **Example Result** | +|--------------|-----------------|--------------------| +| `({{number-1}} + {{number-2}} + {{number-3}}) / 3` | Calculates the average of three widgets | (10 + 20 + 30) / 3 = **20** | +| `({{number-1}} * {{number-2}}) + ({{number-3}} / {{number-4}})` | Combines multiplication and division | (5 * 6) + (8 / 4) = 30 + 2 = **32** | +| `({{number-1}} + {{number-2}}) * ({{number-3}} - {{number-4}})` | Multiplies a sum by a difference | (10 + 5) * (6 - 2) = 15 * 4 = **60** | +| `({{number-1}} * {{number-2}} * {{number-3}}) / {{number-4}}` | Calculates a scaled ratio | (2 * 3 * 4) / 2 = 24 / 2 = **12** | +| `({{number-1}} + {{number-2}} + {{number-3}} + {{number-4}}) / 4` | Finds the average of four widgets | (8 + 10 + 12 + 14) / 4 = **11** | +| `{{number-1}} * ({{number-2}} + {{number-3}} - {{number-4}})` | Weighted total | 5 * (10 + 4 - 2) = 5 * 12 = **60** | +| `({{number-1}} + {{number-2}})^2 / {{number-3}}` | Squares the sum and divides by another widget | (4 + 6)^2 / 5 = 100 / 5 = **20** | +| `({{number-1}} * {{number-2}} + {{number-3}}) * {{number-4}}` | Compound operation using addition and multiplication | (3 * 4 + 2) * 5 = (12 + 2) * 5 = **70** | +| `({{number-1}}^2 + {{number-2}}^2) / ({{number-3}} + {{number-4}})` | Sum of squares divided by total | (3² + 4²) / (2 + 1) = (9 + 16) / 3 = **8.33** | --- -> 📝 *Tip: You can include screenshots here for better visual guidance (e.g., toolbar selection, widget placement, and signer view).* +## 🧠 Tips + +- Use **parentheses `( )`** to control calculation order. +- Formulas follow **standard arithmetic precedence** (multiplication/division before addition/subtraction). +- Only **number widgets (`{{number-x}}`)** can be used in formulas. +- Non-numeric fields (like text or date) are **not supported** in formula expressions. +- Ensure all widget names used in formulas exist in the same document. + +--- + +## 📩 Need Help? + +If you need further assistance, contact our support team at **support@opensignlabs.com**. + +Happy Signing with **OpenSign™**!