Skip to content

Commit

Permalink
Merge pull request #190 from vtex-apps/add/guest-email-message
Browse files Browse the repository at this point in the history
Add a guest confirmation message
  • Loading branch information
beatrizmaselli authored Aug 27, 2024
2 parents 2355238 + 0ff8301 commit faadc87
Show file tree
Hide file tree
Showing 31 changed files with 155 additions and 67 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Added

- `store/header.guest-email` confirmation message for guests.

## [2.17.2] - 2023-12-12

### Fixed

- Unmask data for pickup point address.

## [2.17.1] - 2023-10-11
Expand Down
84 changes: 45 additions & 39 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
📢 Use this project, [contribute](https://github.com/vtex-apps/order-placed) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

# Order Placed
Expand Down Expand Up @@ -253,8 +255,8 @@ Renders the confirmation icon.
| ------------------------- | ------------ |
| `confirmationIconWrapper` | Icon wrapper |

| Default appearance |
| ---------------------------------------------------------- |
| Default appearance |
| ----------------------------------------------------------------------------------------------------------------------------- |
| ![op-confirmation-icon](https://user-images.githubusercontent.com/17712401/89224372-c38c5080-d5ae-11ea-8112-9870c854e5a2.png) |

### `op-confirmation-title`
Expand All @@ -271,8 +273,8 @@ Renders the confirmation title.
| ------------------- | ------------------------------- |
| `confirmationTitle` | Confirmation title `h4` element |

| Default appearance |
| ------------------------------------------------------------ |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------------ |
| ![op-confirmation-title](https://user-images.githubusercontent.com/17712401/89224442-df8ff200-d5ae-11ea-824a-25d7530249dd.png) |

### `op-confirmation-message`
Expand All @@ -281,16 +283,20 @@ Renders the confirmation message, containing the clients email.

**Composition:** none.

**Props:** none.
**Props:**

| Prop name | Type | Description | Default value |
| -------------------- | --------- | --------------------------------------------------------------------------------------------- | ------------- |
| `enableGuestMessage` | `boolean` | Flag that enables a different confirmation message (store/header.guest-email) for guest users | `false` |

**CSS Handles:**

| CSS Handle | Description |
| --------------------- | -------------------------------- |
| `confirmationMessage` | Confirmation message `p` element |

| Default appearance |
| ---------------------------------------------------------------- |
| Default appearance |
| -------------------------------------------------------------------------------------------------------------------------------- |
| ![op-confirmation-message](https://user-images.githubusercontent.com/17712401/89224480-f0406800-d5ae-11ea-8602-0cb9541b0459.png) |

### `op-print-button`
Expand All @@ -303,8 +309,8 @@ Renders a button that triggers a full page print.

**CSS Handles:**: none.

| Default appearance |
| ---------------------------------- |
| Default appearance |
| ----------------------------------------------------------------------------------------------------------------- |
| ![op-print](https://user-images.githubusercontent.com/17712401/89224547-0817ec00-d5af-11ea-9b6a-9ae33a89daef.png) |

### `op-notices`
Expand All @@ -322,8 +328,8 @@ Renders a list of important informations relevant to the currently placed order.
| `noticesList` | List `ul` element |
| `noticeListItem` | Each list `li` item element |

| Default appearance |
| -------------------------------------- |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------- |
| ![op-notices](https://user-images.githubusercontent.com/17712401/89224594-16fe9e80-d5af-11ea-9c3e-4cfddcf76a4c.png) |

### `op-summary-section`
Expand All @@ -350,8 +356,8 @@ If a placed order is split between delivery and pickup, renders a summary of all
| `summaryShippingSLA` | Wrapper of the shipping SLA information |
| `summaryTitle` | Box `h5` title element |

| Default appearance |
| ------------------------------------------------------ |
| Default appearance |
| --------------------------------------------------------------------------------------------------------------------------- |
| ![op-summary-section](https://user-images.githubusercontent.com/17712401/89224626-267de780-d5af-11ea-80c1-7771c6dae670.png) |

### `op-bank-invoice-section`
Expand All @@ -374,8 +380,8 @@ Renders the bank invoice section if payment method chosen was bank invoice.
| `bankInvoiceEmbedBackground` | Background of the bank invoice iframe |
| `bankInvoiceEmbed` | Embed of the bank invoice PDF |

| Default appearance |
| ---------------------------------------------------------------- |
| Default appearance |
| -------------------------------------------------------------------------------------------------------------------------------- |
| ![op-bank-invoice-section](https://user-images.githubusercontent.com/17712401/89224654-3695c700-d5af-11ea-9b17-98c68450370d.png) |

### `op-order`
Expand Down Expand Up @@ -407,8 +413,8 @@ Renders the order id number. Must be placed inside an [`op-order`](#op-order) bl
| ------------- | ------------------------- |
| `orderNumber` | Order number `h3` element |

| Default appearance |
| ------------------------------------------------ |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------ |
| ![op-order-number](https://user-images.githubusercontent.com/17712401/89224695-4c0af100-d5af-11ea-866e-bea733073346.png) |

### `op-order-datetime`
Expand All @@ -425,8 +431,8 @@ Renders the date and time an order was placed. Must be placed inside an [`op-ord
| --------------- | ----------------------------------- |
| `orderDatetime` | Order date and time `small` element |

| Default appearance |
| ---------------------------------------------------- |
| Default appearance |
| -------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-datetime](https://user-images.githubusercontent.com/17712401/89224728-5a590d00-d5af-11ea-8901-7654c543d9e9.png) |

### `op-order-seller`
Expand All @@ -444,8 +450,8 @@ Renders the seller of an order. Must be placed inside an [`op-order`](#op-order)
| `orderSoldBy` | Seller phrase `small` element |
| `orderSeller` | Seller name `span` element |

| Default appearance |
| ------------------------------------------------ |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------ |
| ![op-order-seller](https://user-images.githubusercontent.com/17712401/89224779-765cae80-d5af-11ea-9320-29902e7f47dd.png) |

### `op-order-split-notice`
Expand All @@ -462,8 +468,8 @@ Renders a message with the number of packages of an order if the order was split
| ------------- | ------------------------------ |
| `splitNotice` | Wrapper of the message element |

| Default appearance |
| ------------------------------------------------------------ |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------------ |
| ![op-order-split-notice](https://user-images.githubusercontent.com/17712401/89224825-88d6e800-d5af-11ea-8801-7f2d5267da5b.png) |

### `op-order-customer`
Expand All @@ -476,8 +482,8 @@ Renders the customer information. Must be placed inside an [`op-order`](#op-orde

**CSS Handles:** none.

| Default appearance |
| ---------------------------------------------------- |
| Default appearance |
| -------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-customer](https://user-images.githubusercontent.com/17712401/89224880-a015d580-d5af-11ea-8314-bc223b3da0aa.png) |

### `op-order-options`
Expand All @@ -488,19 +494,19 @@ Renders the customer information. Must be placed inside an [`op-order`](#op-orde

**Props:**

| Prop name | Type | Description | Default value |
| ----------- | --------- | --------------------------------------------------- | ------------- |
| `fullWidth` | `boolean` | Make the options wrapper take full horizontal space | `false` |
| `myAccountPath` | `string` | The path to redirect a user to their profile page (rendered by the `vtex.my-account` app). | `/account` |
| Prop name | Type | Description | Default value |
| --------------- | --------- | ------------------------------------------------------------------------------------------ | ------------- |
| `fullWidth` | `boolean` | Make the options wrapper take full horizontal space | `false` |
| `myAccountPath` | `string` | The path to redirect a user to their profile page (rendered by the `vtex.my-account` app). | `/account` |

**CSS Handles:**

| CSS Handles | Description |
| --------------------- | ----------------------------- |
| `orderOptionsWrapper` | Wrapper of the option buttons |

| Default appearance |
| -------------------------------------------------- |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-options](https://user-images.githubusercontent.com/17712401/89224923-b754c300-d5af-11ea-8b28-0efa82329e96.png) |

### `op-order-payment`
Expand All @@ -516,8 +522,8 @@ Renders the customer information. Must be placed inside an [`op-order`](#op-orde
| `orderPaymentWrapper` | Wrapper of the payment methods list |
| `orderPaymentItem` | Wrapper of each payment method item |

| Default appearance |
| -------------------------------------------------- |
| Default appearance |
| ------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-payment](https://user-images.githubusercontent.com/17712401/89225037-eec36f80-d5af-11ea-82af-267cb69c7d7b.png) |

### `op-order-delivery-packages`
Expand Down Expand Up @@ -558,8 +564,8 @@ Renders an order delivery packages information and product list. Must be placed
| `attachmentContent` | Attachment's content wrapper |
| `attachmentContentItem` | Each attachment's content paragraph |

| Default appearance |
| ---------------------------------------------------------------------- |
| Default appearance |
| ----------------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-delivery-packages](https://user-images.githubusercontent.com/17712401/89225054-f8e56e00-d5af-11ea-9c0a-b2cc37fe34f4.png) |

### `op-order-pickup-packages`
Expand All @@ -581,8 +587,8 @@ _Note: Include the same CSS handles as [`op-order-delivery-packages`](#op-order-
| `packageReceiverName` | Name of the package's **pickup** receiver |
| `packageAdditionalInfo` | Wrapper of additional information about a **pickup** package |

| Default appearance |
| ------------------------------------------------------------------ |
| Default appearance |
| --------------------------------------------------------------------------------------------------------------------------------- |
| ![op-order-pickup-packages](https://user-images.githubusercontent.com/17712401/89225074-03076c80-d5b0-11ea-840e-69998a41ec9d.png) |

### `op-order-total`
Expand All @@ -601,8 +607,8 @@ Renders an order delivery packages information and product list. Must be placed
| `totalListItemLabel` | Label of a price item |
| `totalListItemValue` | Value of a price item |

| Default appearance |
| ---------------------------------------------- |
| Default appearance |
| ----------------------------------------------------------------------------------------------------------------------- |
| ![op-order-total](https://user-images.githubusercontent.com/17712401/89225092-0b5fa780-d5b0-11ea-976e-da3c64453eff.png) |

## API
Expand Down
3 changes: 2 additions & 1 deletion messages/ar.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"store/header.bankinvoice.help": "هل تجد صعوبة في مشاهد {paymentSystemName} الخاص بك؟",
"store/header.bankinvoice.tooltip": "{paymentSystemName} الخاص بك يعمل بشكل طبيعي. انقر فوق {message} أو انسخ الرمز الشريطي الخاص بها لمتابعة الدفع.",
"store/header.email": "في غضون 5 دقائق، ستتلقى رسالة بريد إلكتروني على {userEmail} تحتوي على جميع تفاصيل الشراء. {lineBreak} تذكر أن تتحقق من البريد العشوائي أو صندوق الوارد الخاص بالعروض الترويجية",
"store/header.guest-email": "في غضون 5 دقائق، ستتلقى رسالة بريد إلكتروني على {userEmail} تحتوي على جميع تفاصيل الشراء. {lineBreak} تذكر أن تتحقق من البريد العشوائي أو صندوق الوارد الخاص بالعروض الترويجية",
"store/header.newpurchase.button": "بدء طلب جديد",
"store/header.print.button": "طباعة",
"store/header.thanks": "شكرًا لك على شرائك!",
Expand Down Expand Up @@ -71,4 +72,4 @@
"store/go-to-home": "انتقل للصفحة الرئيسية",
"store/paymentData.connectorResponse.mb.entity": "المؤسسة",
"store/paymentData.connectorResponse.mb.reference": "المرجع"
}
}
3 changes: 2 additions & 1 deletion messages/bg.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"store/header.bankinvoice.help": "Не виждате вашата {paymentSystemName}?",
"store/header.bankinvoice.tooltip": "Вашата {paymentSystemName} работи нормално. Щракнете върху {message} или копирайте баркода му, за да продължите с плащането.",
"store/header.email": "В рамките на 5 минути ще получите имейл на {userEmail} с всички подробности за поръчката ви.{lineBreak}Не забравяйте да проверите вашия спам",
"store/header.guest-email": "В рамките на 5 минути ще получите имейл на {userEmail} с всички подробности за поръчката ви.{lineBreak}Не забравяйте да проверите вашия спам",
"store/header.newpurchase.button": "Начало на нова поръчка",
"store/header.print.button": "Печат",
"store/header.thanks": "Благодарим ви за покупката!",
Expand Down Expand Up @@ -71,4 +72,4 @@
"store/go-to-home": "Преминете към началната страница",
"store/paymentData.connectorResponse.mb.entity": "Лице",
"store/paymentData.connectorResponse.mb.reference": "Препратка"
}
}
3 changes: 2 additions & 1 deletion messages/ca.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"store/header.bankinvoice.help": "No podeu veure el vostre {paymentSystemName}?",
"store/header.bankinvoice.tooltip": "El vostre {paymentSystemName} funciona amb normalitat. Feu clic a {message} o copieu-ne el codi de barres per procedir al pagament.",
"store/header.email": "Dins d'un termini de 5 minuts, rebreu un correu electrònic a {userEmail} amb tota la informació sobre la vostra compra.{lineBreak}Recordeu revisar la safata de correu brossa o la pestanya Promocions",
"store/header.guest-email": "Dins d'un termini de 5 minuts, rebreu un correu electrònic a {userEmail} amb tota la informació sobre la vostra compra.{lineBreak}Recordeu revisar la safata de correu brossa o la pestanya Promocions",
"store/header.newpurchase.button": "Inicia una comanda nova",
"store/header.print.button": "Imprimeix",
"store/header.thanks": "Gràcies per la vostra compra!",
Expand Down Expand Up @@ -71,4 +72,4 @@
"store/go-to-home": "Ves a la pàgina d'inici",
"store/paymentData.connectorResponse.mb.entity": "Entitat",
"store/paymentData.connectorResponse.mb.reference": "Referència"
}
}
1 change: 1 addition & 0 deletions messages/cs.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"store/header.bankinvoice.help": "Nevidíte {paymentSystemName}?",
"store/header.bankinvoice.tooltip": "{paymentSystemName} funguje normálně. Pro zaplacení klikněte na {message} nebo zkopírujte čárový kód.",
"store/header.email": "Během 5 minut dostanete na adresu {userEmail} e-mail obsahující podrobnosti o vašem nákupu.{lineBreak}Nezapomeňte zkontrolovat složku pro spam nebo obchodní nabídky",
"store/header.guest-email": "Během 5 minut dostanete na adresu {userEmail} e-mail obsahující podrobnosti o vašem nákupu.{lineBreak}Nezapomeňte zkontrolovat složku pro spam nebo obchodní nabídky",
"store/header.newpurchase.button": "Založit novou objednávku",
"store/header.print.button": "Vytisknout",
"store/header.thanks": "Děkujeme za váš nákup!",
Expand Down
Loading

0 comments on commit faadc87

Please sign in to comment.