1.25.1 • Published 6 months ago
@kofile/react-order-receipt v1.25.1
React Order Receipt
A reusable, configurable React component
Cosmos - Developer Sandbox
Usage:
- Run
cosmos - Visit
http://localhost:8989/ - Experiment with different input props by creating or modifying the
__fixtures__. - Make changes to
src/?yarn buildto see your changes. - Cosmos docs for more details.
Props
Root Level
| Name | Type | Required | Description |
|---|---|---|---|
| county | County | ⭕️ | County info |
| refundInfo | RefundInfo | ⭕️ | For display above receipt table |
| purchasedBy | string | ✅ | Full name of user who requested refund |
| orderDate | Date | ✅ | Date order was placed |
| orderId | string | ✅ | ID of order |
| lineItems | LineItem | ✅ | description |
| subtotal | number | ✅ | Sum price of each line item |
| convenienceFee | number | ✅ | Convenience fee amount |
| totalPrice | number | ✅ | Grand total = subtotal + fees |
| subtotalRefunded | number | ⭕️ | Sum price of each refunded item (without fees) |
| feesRefunded | number | ⭕️ | Sum of all refunded fees |
| totalRefundAmount | number | ✅ | Total amount refunded = subtotalRefunded + feesRefunded |
| nonInteractive | boolean | ✅ | Are checkboxes and actions available? |
| convenienceFeeType | ConvenienceFeeTypes | ✅ | Are fees calculated "per-order" or "per-document" |
| showRefundDescription | boolean | ✅ | Should refund description be shown in each line item? |
| showSimpleRefundStatus | boolean | ✅ | Should "completed-" prefix be omitted? |
| showRefundStatus | boolean | ✅ | Should refund status column be displayed? |
| zipLink | ILink | ⭕️ | Download link for zip file |
County
| Name | Type | Required | Description |
|---|---|---|---|
| name?: | string | ⭕️ | County name, e.g. "Grayson" |
| sealUrl?: | string | ⭕️ | URL for county seal image |
| clerkName?: | string | ⭕️ | Full name of clerk |
| addressLine1?: | string | ⭕️ | Street Address |
| addressLine2?: | string | ⭕️ | City, State |
RefundInfo
| Name | Type | Required | Description |
|---|---|---|---|
| requestedBy | string | ✅ | Full name of user who requested refund |
| amount | number | ✅ | Total amount being refunded |
| numItems | number | ✅ | Documents being refunded |
| description | string | ✅ | Reason for refund |
ILink
| Name | Type | Required | Description |
|---|---|---|---|
| error | string | ✅ | description of error |
| link | string | ✅ | URI for download |
| isLoading | boolean | ✅ | Is this component waiting for data? |
LineItem
| Name | Type | Required | Description |
|---|---|---|---|
| id | number | ✅ | Item ID |
| instrumentNumber | string | ✅ | Instrument number |
| documentType | string | ✅ | Document type, e.g. "FORECLOSURE NOTICE" |
| type | string | ✅ | Item type, e.g. "docimage" |
| pagesPurchased | string | ✅ | Page range, e.g. "all" or "1-2, 4" |
| totalPagesInDocument | number | ✅ | Total number of pages in document |
| downloadLink | ILink | ⭕️ | Link to download document |
| priceCents | number | ✅ | Price in cents |
| refundStatus | RefundStatuses | ⭕️ | The refund status for this item |
| refundDescription | string | ⭕️ | Reason refund was requested |
| refundRequestedBy | string | ⭕️ | Full name of person requesting refund |
ConvenienceFeeTypes
| Enum | Type |
|---|---|
| "per-order" | string |
| "per-document" | string |
RefundStatuses
| Enum | Type |
|---|---|
| "approved" | string |
| "rejected" | string |
| "submitted" | string |
| "completed-approved" | string |
| "completed-rejected" | string |
| "none" | string |
1.25.0
7 months ago
1.25.1
6 months ago
1.24.1
7 months ago
1.23.3
2 years ago
1.23.2
3 years ago
1.23.0
3 years ago
1.23.1
3 years ago
1.22.0
3 years ago
1.21.0
3 years ago
1.21.1
3 years ago
1.21.2
3 years ago
1.19.0
3 years ago
1.20.0
3 years ago
1.18.0
3 years ago
1.17.3
4 years ago
0.0.0-development
4 years ago
1.17.2
5 years ago
1.17.1
5 years ago
1.17.0
5 years ago
1.16.2
5 years ago
1.16.1
5 years ago
1.16.0
5 years ago
1.15.3
5 years ago
1.15.2
5 years ago
1.15.1
5 years ago
1.15.0
5 years ago
1.14.0
5 years ago
1.13.0
5 years ago
1.12.2
5 years ago
1.12.1
5 years ago
1.12.0
5 years ago
1.11.1
5 years ago
1.11.0
5 years ago
1.10.0
5 years ago
1.9.2
5 years ago
1.9.1
5 years ago
1.9.0
5 years ago
1.8.1
5 years ago
1.8.0
5 years ago
1.7.0
5 years ago
1.6.0
5 years ago
1.5.0
5 years ago
1.4.1
5 years ago
1.4.0
5 years ago
1.3.2
5 years ago
1.3.1
6 years ago
1.3.0
6 years ago
1.2.0
6 years ago
1.1.0
6 years ago
1.0.3
6 years ago
1.0.2
6 years ago
1.0.1
6 years ago
1.0.0
6 years ago