Skip to content

Commit 8abc535

Browse files
committed
docs: add metatada support
1 parent bec8a49 commit 8abc535

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

docs/customization/layout.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ The table below lists all the available properties you can set:
3030
| `hide-icon` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the button icon.|
3131
| `hide-mobile` | **Type**: `boolean`<br/>**Default value**: `false`<br /> <br /> When set to `true`, hides the feedback button on mobile devices.|
3232
| `hide-privacy-policy` | **Type**: `boolean`<br />**Default value**: `true`<br /><br />Whether to hide the privacy policy checkbox. |
33-
| `hide-ratings` | **Type**: `boolean`<br />**Default value**: `false` <br /><br /> Wether to hide the ratings input. |
33+
| `hide-rating` | **Type**: `boolean`<br />**Default value**: `false` <br /><br /> Wether to hide the ratings input. |
3434
| `hide-screenshot-button` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the screenshot button.|
3535
| `is-email-required` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, users must provide an email address to submit feedback. Tip: Remember to also update the [`email-placeholder`](text) property to remove "(optional)" from the text when using this option. |
36+
| `metadata` | **Type**: `string`<br />**Default value**: ``<br /><br />Any metadata to tag feedback submissions. This can be used to attach additional context or categorization information to the feedback.|
3637
| `modal-position` | **Type**: `string`<br />**Default value**: `center`<br />**Available values:** `center`, `sidebar-right`, `sidebar-left`, `top-right`, `top-left`, `bottom-right`, `bottom-left`, `center-right`, `center-left`<br /><br />Position of the feedback modal.|
3738
| `rating` | **Type**: `number`<br />**Default value**: -1 (neutral) <br /><br /> Rating selected by default. **Available values:** `stars` mode: 1...5. `thumbs` mode: `0` dislike and `1` like. `-1` means neutral in both modes. |
3839
| `rating-mode` | **Type**: `string`<br />**Default value**: `thumbs` <br /><br /> **Available values:** `thumbs`, `stars`<br /><br />Type of rating system.|

docs/customization/text.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ The table below lists all the available properties you can override:
3838
| `privacy-policy-text` | **Type**: `boolean`<br />**Default value**: `I have read and expressly consent to the terms of the <a href='https://pushfeedback.com/privacy'>Privacy Policy</a>.`<br /><br />Privacy policy text. |
3939
| `rating-placeholder` | **Type**: `string`<br />**Default value**: `Was this page helpful?`<br />Heading for the feedback rating feature (thumbs).<br /><br />|
4040
| `rating-stars-placeholder` | **Type**: `string`<br />**Default value**: `How would you rate this page`<br />Heading for the feedback rating feature (stars).<br /><br />|
41-
| `screenshot-button-text` | **Type**: `string`<br />**Default value**: `Take a Screenshot`<br />Tooltip text for the screenshot button.<br /><br /> |
41+
| `screenshot-attached-text` | **Type**: `string`<br>**Default**: `Screenshot attached text`<br>Label for the screenshot button when a screenshot has been attached. |
42+
| `screenshot-button-text` | **Type**: `string`<br />**Default value**: `Take a Screenshot`<br />Label for the screenshot button.<br /><br /> |
4243
| `screenshot-topbar-text` | **Type**: `string`<br />**Default value**: `SELECT AN ELEMENT ON THE PAGE`<br />Instructional text when taking a screenshot.<br /><br />|
4344
| `send-button-text` | **Type**: `string`<br />**Default value**: `Send`<br />Text for the button that submits feedback.<br /><br /> |
4445

docs/integrations/webhooks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Here's an example of a webhook payload that PushFeedback sends to the specified
5353
"id": "feedback123",
5454
"project_id": "https://app.pushfeedback.com/team1/projects/project1/",
5555
"message": "This is a sample feedback message.",
56+
"metadata": "Feature A",
5657
"url": "https://example.com/page",
5758
"rating": 4,
5859
"rating_mode": "star",

0 commit comments

Comments
 (0)