browser-sdk: open_settings command

fuo213 commented 2 months ago

Description

Summary:

This is a command for the embed element that allows developers to set up their own button to open the settings pane.

Related Issue:

None

Testing

Create a localstack room to use in story book
Add a supported command for the button under sdk/packages/browser-sdk/src/stories/prebuilt-ui.stories.tsx
Run yarn dev and navigate to Prebuilt-UI Stories -> Embed Element Example
Click button, settings page should open to the defined pane

Screenshots/GIFs (if applicable)

N/A

Checklist

[x ] My code follows the project's coding standards.
[ x] Prefixed the PR title and commit messages with the service or package name
[ x] I have written unit tests (if applicable).
[ x] I have updated the documentation (if applicable).
[ x] By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

Additional Information

Supported values for this command are any of the following [theme, integrations, streaming, effects, notifications, advanced, media]

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: 2609995f7f7b9fef1a1691c67b107bf34ea289e8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ------------------------ | ----- | | @whereby.com/browser-sdk | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

fuo213 commented 2 months ago

One question I have around this command is currently nothing will happen if a value is not passed in or an unsupported value is passed in. I could see a few options here

Add some sort of validation to ensure only supported values are passed in and/or create error handling to notify users of issues with the supplied value
Add a default value (probably "media")

Not totally sure on the best way to do this, and think this would be a good learning opportunity for myself and Nick if a kind developer would be willing to weigh in on this.

@thyal @kevinwhereby maybe?

kevinwhereby commented 2 months ago

hmmmmm I'm not sure what the default settings pane would be ... I'd probably lean towards a console.warn message saying you need to pass one.

Or a more complicated solution would be toggle whatever the last opened pane was... but that's a whole other story. I defer to @thyal :D

thyal commented 2 months ago

console.warn sounds good. But we can also type the input, instead of accepting just string. Let me know if you want some help to look at that

whereby / sdk