Skip to content

feat(feedback): Make "required" text for input elements configurable #11153

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

Merged
merged 3 commits into from
Mar 25, 2024
Merged

feat(feedback): Make "required" text for input elements configurable #11153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac96a15
feat(feedback): Configurable "required" label (#11152)
soerface Mar 19, 2024
a7a99ff
lint
billyvg Mar 22, 2024
0984abe
Update packages/feedback/src/modal/components/Form.tsx
soerface Mar 22, 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
1 change: 1 addition & 0 deletions packages/feedback/src/constants/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export const MESSAGE_LABEL = 'Description';
export const NAME_PLACEHOLDER = 'Your Name';
export const NAME_LABEL = 'Name';
export const SUCCESS_MESSAGE_TEXT = 'Thank you for your report!';
export const IS_REQUIRED_TEXT = '(required)';

export const FEEDBACK_WIDGET_SOURCE = 'widget';
export const FEEDBACK_API_SOURCE = 'api';
Expand Down
3 changes: 3 additions & 0 deletions packages/feedback/src/core/integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
EMAIL_LABEL,
EMAIL_PLACEHOLDER,
FORM_TITLE,
IS_REQUIRED_TEXT,
MESSAGE_LABEL,
MESSAGE_PLACEHOLDER,
NAME_LABEL,
Expand Down Expand Up @@ -76,6 +77,7 @@ export const _feedbackIntegration = (({
nameLabel = NAME_LABEL,
namePlaceholder = NAME_PLACEHOLDER,
successMessageText = SUCCESS_MESSAGE_TEXT,
isRequiredText = IS_REQUIRED_TEXT,

// FeedbackCallbacks
onFormOpen,
Expand Down Expand Up @@ -116,6 +118,7 @@ export const _feedbackIntegration = (({
nameLabel,
namePlaceholder,
successMessageText,
isRequiredText,

onFormClose,
onFormOpen,
Expand Down
16 changes: 11 additions & 5 deletions packages/feedback/src/modal/components/Form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export interface Props
| 'showEmail'
| 'showName'
| 'submitButtonLabel'
| 'isRequiredText'
> {
defaultEmail: string;
defaultName: string;
Expand Down Expand Up @@ -66,6 +67,7 @@ export function Form({
showEmail,
showName,
submitButtonLabel,
isRequiredText,
screenshotInput,
}: Props): VNode {
// TODO: set a ref on the form, and whenever an input changes call proceessForm() and setError()
Expand Down Expand Up @@ -145,7 +147,7 @@ export function Form({

{showName ? (
<label for="name" class="form__label">
<LabelText label={nameLabel} isRequired={isNameRequired} />
<LabelText label={nameLabel} isRequiredText={isRequiredText} isRequired={isNameRequired} />
<input
class="form__input"
defaultValue={defaultName}
Expand All @@ -162,7 +164,7 @@ export function Form({

{showEmail ? (
<label for="email" class="form__label">
<LabelText label={emailLabel} isRequired={isEmailRequired} />
<LabelText label={emailLabel} isRequiredText={isRequiredText} isRequired={isEmailRequired} />
<input
class="form__input"
defaultValue={defaultEmail}
Expand All @@ -178,7 +180,7 @@ export function Form({
)}

<label for="message" class="form__label">
<LabelText label={messageLabel} isRequired />
<LabelText label={messageLabel} isRequiredText={isRequiredText} isRequired />
<textarea
autoFocus
class="form__input form__input--textarea"
Expand Down Expand Up @@ -223,11 +225,15 @@ export function Form({
);
}

function LabelText({ label, isRequired }: { label: string; isRequired: boolean }): VNode {
function LabelText({
label,
isRequired,
isRequiredText,
}: { label: string; isRequired: boolean; isRequiredText: string }): VNode {
return (
<span class="form__label__text">
{label}
{isRequired && <span class="form__label__text--required">(required)</span>}
{isRequired && <span class="form__label__text--required">{isRequiredText}</span>}
</span>
);
}
1 change: 1 addition & 0 deletions packages/feedback/src/modal/createDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export function createDialog({ options, screenshotIntegration, sendFeedback, sha
defaultName={(userKey && user && user[userKey.name]) || ''}
defaultEmail={(userKey && user && user[userKey.email]) || ''}
successMessageText={options.successMessageText}
isRequiredText={options.isRequiredText}
onFormClose={() => {
renderContent(false);
options.onFormClose && options.onFormClose();
Expand Down
5 changes: 5 additions & 0 deletions packages/feedback/src/types/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ export interface FeedbackTextConfiguration {
* Message after feedback was sent successfully
*/
successMessageText: string;

/**
* Text which indicates that a field is required
*/
isRequiredText: string;
}

/**
Expand Down