diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index d3c03afd..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,25 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -## [1.1.1](https://github.com/bucketco/bucket-tracking-sdk/compare/v1.1.0...v1.1.1) - 2023-03-03 - -### Changed - -- Change feedback from 'sentiment' to 'score' (closed beta) - -## [1.1.0](https://github.com/bucketco/bucket-tracking-sdk/compare/v1.0.0...v1.1.0) - 2023-01-12 - -### Added - -- Send feature feedback to Bucket (closed beta) - -### Changed - -- Improved typing for errors - -## 1.0.0 - -### Added - -- Initial release diff --git a/FEEDBACK.md b/FEEDBACK.md index 8543ccf2..f7e36c6b 100644 --- a/FEEDBACK.md +++ b/FEEDBACK.md @@ -36,7 +36,7 @@ See also: - [Positioning and behavior](#positioning-and-behavior) for the position option. - [Static language configuration](#static-language-configuration) if you want to translate the feedback UI. -- [Live Satisfaction](#live-feedback) to override default configuration. +- [Live Satisfaction](#live-satisfaction) to override default configuration. ## Live Satisfaction @@ -289,9 +289,39 @@ bucket.init("bucket-tracking-key", { You can adapt parts of the look of the Bucket feedback UI by applying CSS custom properties to your page in your CSS `:root`-scope. -![image](https://github.com/bucketco/bucket-tracking-sdk/assets/331790/ff7ed885-8308-4c9b-98c6-5623f1026b69) +For example, a dark mode theme might look like this: + +image + +```css +:root { + --bucket-feedback-dialog-background-color: #1e1f24; + --bucket-feedback-dialog-color: rgba(255, 255, 255, 0.92); + --bucket-feedback-dialog-secondary-color: rgba(255, 255, 255, 0.3); + --bucket-feedback-dialog-border: rgba(255, 255, 255, 0.16); + --bucket-feedback-dialog-primary-button-background-color: #655bfa; + --bucket-feedback-dialog-primary-button-color: white; + --bucket-feedback-dialog-input-border-color: rgba(255, 255, 255, 0.16); + --bucket-feedback-dialog-input-focus-border-color: rgba(255, 255, 255, 0.3); + --bucket-feedback-dialog-error-color: #f56565; + + --bucket-feedback-dialog-rating-1-color: #ed8936; + --bucket-feedback-dialog-rating-1-background-color: #7b341e; + --bucket-feedback-dialog-rating-2-color: #dd6b20; + --bucket-feedback-dialog-rating-2-background-color: #652b19; + --bucket-feedback-dialog-rating-3-color: #787c91; + --bucket-feedback-dialog-rating-3-background-color: #3e404c; + --bucket-feedback-dialog-rating-4-color: #38a169; + --bucket-feedback-dialog-rating-4-background-color: #1c4532; + --bucket-feedback-dialog-rating-5-color: #48bb78; + --bucket-feedback-dialog-rating-5-background-color: #22543d; + + --bucket-feedback-dialog-submitted-check-background-color: #38a169; + --bucket-feedback-dialog-submitted-check-color: #ffffff; +} +``` -Examples of custom styling can be found in our [development example stylesheet](./dev/index.css). +Other examples of custom styling can be found in our [development example stylesheet](./dev/index.css). ## Using your own UI to collect feedback diff --git a/README.md b/README.md index f6dc7451..7f184a02 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,8 @@ Supply these to the `init` call (2nd argument) { debug?: false, // enable debug mode to log all info and errors persistUser?: true | false // default value depends on environment, see below under "persisting users" - host?: "https://tracking.bucket.co", // don't change this + host?: "https://tracking.bucket.co", + sseHost?: "https://livemessaging.bucket.co" } ``` @@ -153,7 +154,7 @@ If you are running with strict Content Security Policies active on your website, | ----------- | ------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | connect-src | https://tracking.bucket.co | tracking | Used for all tracking methods: `bucket.user()`, `bucket.company()`, `bucket.track()` and `bucket.feedback()` | | connect-src | https://livemessaging.bucket.co | live satisfaction | Server sent events from the Bucket Live Satisfaction service, which allows for automatically collecting feedback when a user used a feature. | -| style-src | 'unsafe-inline' | feedback UI | The feedback UI is styled with inline script tags. Not having this directive results unstyled HTML elements. | +| style-src | 'unsafe-inline' | feedback UI | The feedback UI is styled with inline styles. Not having this directive results unstyled HTML elements. | If you are including the Bucket tracking SDK with a `