Skip to content

Commit 8597ccf

Browse files
committed
docs: document new properties
1 parent a5b896b commit 8597ccf

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

docs/customization/layout.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,16 @@ The table below lists all the available properties you can set:
2525
| `button-position` | **Type**: `string`<br />**Default value**: `default`<br />**Available values:** `default`, `bottom-right`, `center-right`<br /><br />Position of the button.|
2626
| `button-style` | **Type**: `string`<br />**Default value**: `default`<br />**Available values:** `default`, `dark`, `light`<br /><br />Style of the button.|
2727
| `custom-font` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />When set to `true`, the [Inter font](https://fonts.google.com/specimen/Inter) will not be loaded. Useful if your site already uses a different font, enabling a quicker load time.|
28-
| `hide-email` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the email input. |
2928
| `email-address` | **Type**: `string`<br /><br />Initial value for the email input field. |
29+
| `hide-email` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the email input. |
3030
| `hide-icon` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the button icon.|
31+
| `hide-mobile` | **Type**: `boolean`<br/>**Default value**: `false`<br /> <br /> When set to `true`, hides the feedback button on mobile devices.|
32+
| `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. |
3134
| `hide-screenshot-button` | **Type**: `boolean`<br />**Default value**: `false`<br /><br />Whether to hide the screenshot button.|
3235
| `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.|
33-
| `hide-privacy-policy` | **Type**: `boolean`<br />**Default value**: `true`<br /><br />Whether to hide the privacy policy checkbox. |
34-
| `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. |
3536
| `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. |
36-
| `hide-ratings` | **Type**: `boolean`<br />**Default value**: `false` <br /><br /> Wether to hide the ratings input. |
3737
| `rating-mode` | **Type**: `string`<br />**Default value**: `thumbs` <br /><br /> **Available values:** `thumbs`, `stars`<br /><br />Type of rating system.|
38-
| `hide-mobile` | **Type**: `boolean`<br/>**Default value**: `false`<br /> <br /> When set to `true`, hides the feedback button on mobile devices.|
3938
| `sessionId` | **Type**: `string`<br />**Default value**: Autogenerated <br /><br /> Identifies the current user session. By default, this value is autogenerated if not provided. You can override it to specify a custom session ID, which can be useful for tracking or linking specific sessions across different analytics tools. |
4039
| `submit` | **Type**: `boolean`<br />**Default**: `false`<br /><br />If set to `true`, submits feedback automatically without opening the modal, using the provided `rating` value. If not set, the default rating of `0` (negative feedback) is sent. |
4140

docs/customization/text.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ By customizing these properties, you can ensure a consistent user experience tha
99

1010
## Usage
1111

12-
To customize the textual properties, set the respective attributes on the `<feedback-button>` element in your HTML. Here's an illustrative example:
12+
To customize the textual properties, set the respective attributes on the `<feedback-button>` element in your HTML. Here's an example:
1313

1414
```html
1515
<feedback-button
@@ -26,20 +26,21 @@ The table below lists all the available properties you can override:
2626

2727
| Property | Description |
2828
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
29-
| `email-placeholder` | **Type**: `string`<br />**Default value**: `Email address (optional)`<br />Placeholder text for the email input field.<br /><br /> |
3029
| `error-message` | **Type**: `string`<br />**Default value**: `Please try again later."`<br />Message displayed when there's an error submitting feedback.<br /><br />|
3130
| `modal-title-error-4-0-3` | **Type**: `string`<br />**Default value**: `The request URL does not match the one defined in PushFeedback for this project."`<br />Message displayed when there's a 403 error submitting feedback.<br /><br />|
3231
| `modal-title-error-4-0-4` | **Type**: `string`<br />**Default value**: `We could not find the provided project id in PushFeedback.`<br />Message displayed when there's a 404 error submitting feedback.<br /><br />|
32+
| `email-placeholder` | **Type**: `string`<br />**Default value**: `Email address (optional)`<br />Placeholder text for the email input field.<br /><br /> |
33+
| `footer-text` | **Type**: `string`<br />**Default**: `""`<br /><br />Optional footer text displayed after "Powered by Pushfeedback.com". |
3334
| `message-placeholder` | **Type**: `string`<br />**Default value**: `Comments`<br />Placeholder for the feedback message input.<br /><br />|
3435
| `modal-title` | **Type**: `string`<br />**Default value**: `Share your feedback`<br />Title of the feedback modal.<br /><br /> |
3536
| `modal-title-error` | **Type**: `string`<br />**Default value**: `Oops!`<br />Title displayed when there's an error submitting feedback.<br /><br />|
3637
| `modal-title-success` | **Type**: `string`<br />**Default value**: `Thanks for your feedback!`<br />Title displayed upon successful feedback submission.<br /><br />|
38+
| `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. |
39+
| `rating-placeholder` | **Type**: `string`<br />**Default value**: `Was this page helpful?`<br />Heading for the feedback rating feature (thumbs).<br /><br />|
40+
| `rating-stars-placeholder` | **Type**: `string`<br />**Default value**: `How would you rate this page`<br />Heading for the feedback rating feature (stars).<br /><br />|
3741
| `screenshot-button-text` | **Type**: `string`<br />**Default value**: `Take a Screenshot`<br />Tooltip text for the screenshot button.<br /><br /> |
3842
| `screenshot-topbar-text` | **Type**: `string`<br />**Default value**: `SELECT AN ELEMENT ON THE PAGE`<br />Instructional text when taking a screenshot.<br /><br />|
3943
| `send-button-text` | **Type**: `string`<br />**Default value**: `Send`<br />Text for the button that submits feedback.<br /><br /> |
40-
| `rating-placeholder` | **Type**: `string`<br />**Default value**: `Was this page helpful?`<br />Heading for the feedback rating feature (thumbs).<br /><br />|
41-
| `rating-stars-placeholder` | **Type**: `string`<br />**Default value**: `How would you rate this page`<br />Heading for the feedback rating feature (stars).<br /><br />|
42-
| `footer-text` | **Type**: `string`<br />**Default**: `""`<br /><br />Optional footer text displayed after "Powered by Pushfeedback.com". |
4344

4445
## Example
4546

docs/installation/cdn.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
sidebar_label: HTML
2+
sidebar_label: Basic installation
3+
sidebar_position: 1
34
---
45

56
# Feedback widget for HTML sites

0 commit comments

Comments
 (0)