Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(feedback): Clarify the difference between createWidget and create Form in the feedback public api #11838

Merged
merged 3 commits into from
Apr 30, 2024
Merged

fix(feedback): Clarify the difference between createWidget and create Form in the feedback public api #11838

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05960ce
fix(feedback): Clarify the difference between createWidget and create…
ryan953 Apr 29, 2024
9e8e953
fix types
mydea Apr 30, 2024
809711e
fix lint
mydea Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions packages/feedback/src/core/integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import {
import { DEBUG_BUILD } from '../util/debug-build';
import { isScreenshotSupported } from '../util/isScreenshotSupported';
import { mergeOptions } from '../util/mergeOptions';
import type { ActorComponent } from './components/Actor';
import { Actor } from './components/Actor';
import { createMainStyles } from './createMainStyles';
import { sendFeedback } from './sendFeedback';
Expand All @@ -53,7 +54,8 @@ export const buildFeedbackIntegration = ({
}: BuilderOptions): IntegrationFn<
Integration & {
attachTo(el: Element | string, optionOverrides: OverrideFeedbackConfiguration): Unsubscribe;
createWidget(optionOverrides: OverrideFeedbackConfiguration): Promise<FeedbackDialog>;
createForm(optionOverrides: OverrideFeedbackConfiguration): Promise<FeedbackDialog>;
createWidget(optionOverrides: OverrideFeedbackConfiguration): ActorComponent;
remove(): void;
}
> => {
Expand Down Expand Up @@ -198,7 +200,7 @@ export const buildFeedbackIntegration = ({
});
};

const attachTo = (el: Element | string, optionOverrides: OverrideFeedbackConfiguration = {}): Unsubscribe => {
const _attachTo = (el: Element | string, optionOverrides: OverrideFeedbackConfiguration = {}): Unsubscribe => {
const mergedOptions = mergeOptions(_options, optionOverrides);

const targetEl =
Expand Down Expand Up @@ -238,10 +240,11 @@ export const buildFeedbackIntegration = ({
return unsubscribe;
};

const autoInjectActor = (): void => {
const _createActor = (optionOverrides: OverrideFeedbackConfiguration = {}): ActorComponent => {
const shadow = _createShadow(_options);
const actor = Actor({ buttonLabel: _options.buttonLabel, shadow });
const mergedOptions = mergeOptions(_options, {
...optionOverrides,
onFormOpen() {
actor.removeFromDom();
},
Expand All @@ -252,9 +255,8 @@ export const buildFeedbackIntegration = ({
actor.appendToDom();
},
});
attachTo(actor.el, mergedOptions);

actor.appendToDom();
_attachTo(actor.el, mergedOptions);
return actor;
};

return {
Expand All @@ -264,20 +266,31 @@ export const buildFeedbackIntegration = ({
return;
}

autoInjectActor();
_createActor().appendToDom();
},

/**
* Adds click listener to the element to open a feedback dialog
*
* The returned function can be used to remove the click listener
*/
attachTo,
attachTo: _attachTo,

/**
* Creates a new widget which is composed of a Button which triggers a Dialog.
* Accepts partial options to override any options passed to constructor.
*/
createWidget(optionOverrides: OverrideFeedbackConfiguration = {}): ActorComponent {
const actor = _createActor(mergeOptions(_options, optionOverrides));
actor.appendToDom();
return actor;
},

/**
* Creates a new widget. Accepts partial options to override any options passed to constructor.
* Creates a new Form which you can
* Accepts partial options to override any options passed to constructor.
*/
async createWidget(optionOverrides: OverrideFeedbackConfiguration = {}): Promise<FeedbackDialog> {
async createForm(optionOverrides: OverrideFeedbackConfiguration = {}): Promise<FeedbackDialog> {
return _loadAndRenderDialog(mergeOptions(_options, optionOverrides));
},

Expand Down
Loading