Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ibrahim-mamdouh-ft
ibrahim-mamdouh-ft committed Oct 30, 2024
1 parent bf63df4 commit 5ba7980
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions components/x-gift-article/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,14 @@ All `x-` components are designed to be compatible with a variety of runtimes, no

### Properties

| Property | Type | Required | Note |
| ---------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `isFreeArticle` | Boolean | yes | Only non gift form is displayed when this value is `true`. |
| `article` | Object | yes | Must contain `id`, `title` and `url` properties |
| `nativeShare` | Boolean | no | This is a property for App to display Native Sharing. |
| `apiProtocol` | String | no | The protocol to use when making requests to the gift article and URL shortening services. Ignored if `apiDomain` is not set. |
| `apiDomain` | String | no | The domain to use when making requests to the gift article and URL shortening services. |
| `enterpriseApiBaseUrl` | String | no | The base URL to use when making requests to the enterprise sharing service. |
| Property | Type | Required | Note |
| -------------------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `isFreeArticle` | Boolean | yes | Only non gift form is displayed when this value is `true`. |
| `article` | Object | yes | Must contain `id`, `title` and `url` properties |
| `apiProtocol` | String | no | The protocol to use when making requests to the gift article and URL shortening services. Ignored if `apiDomain` is not set. |
| `apiDomain` | String | no | The domain to use when making requests to the gift article and URL shortening services. |
| `enterpriseApiBaseUrl` | String | no | The base URL to use when making requests to the enterprise sharing service. |
| `title` | String | no | The title for the modal |
| `showHighlightsCheckbox` | Boolean | no | Show or hide the option to include highlights |
| `showHighlightsRecipientMessage` | Boolean | no | Show or hide `ReceivedHighlightsAlert` component |
| `highlight` | String | no | The text of the quote or highlight to be shared |

0 comments on commit 5ba7980

Please sign in to comment.