Support Intercom (#92)

* Add ChatIcon

* FooterDesktop Help&Support

* HelpDialog w/ triggers

* Add other links

* item gap css var passing

* inject script

* Add quotes to script

* Close modal on select

* Remove feedback form
This commit is contained in:
Jared Vu 2023-10-20 16:30:22 -07:00 committed by GitHub
parent 051bdda73a
commit 835f82dbcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 275 additions and 100 deletions

View File

@ -13,6 +13,7 @@
"build:inject-app-deeplinks": "sh scripts/inject-app-deeplinks.sh",
"build:inject-amplitude": "node scripts/inject-amplitude.js",
"build:inject-bugsnag": "node scripts/inject-bugsnag.js",
"build:inject-intercom": "node scripts/inject-intercom.js",
"build:inject-statuspage": "node scripts/inject-statuspage.js",
"deploy:ipfs": "node scripts/upload-ipfs.js --verbose",
"deploy:update-ipns": "node scripts/update-ipns.js",

View File

@ -0,0 +1,76 @@
/* eslint-disable no-console */
import fs from 'fs/promises';
import path from 'path';
import { fileURLToPath } from 'url';
const INTERCOM_APP_ID = process.env.INTERCOM_APP_ID;
const currentPath = fileURLToPath(import.meta.url);
const projectRoot = path.dirname(currentPath);
const htmlFilePath = path.resolve(projectRoot, '../dist/index.html');
if (INTERCOM_APP_ID) {
try {
const html = await fs.readFile(htmlFilePath, 'utf-8');
const intercomScripts = `
<!-- Intercom -->
<script>
window.intercomSettings = {
api_base: 'https://api-iam.intercom.io',
app_id: '${INTERCOM_APP_ID}',
custom_launcher_selector: '.custom_intercom',
hide_default_launcher: true,
};
</script>
<script>
// We pre-filled your app ID in the widget URL: 'https://widget.intercom.io/widget/${INTERCOM_APP_ID}'
(function () {
var w = window;
var ic = w.Intercom;
if (typeof ic === 'function') {
ic('reattach_activator');
ic('update', w.intercomSettings);
} else {
var d = document;
var i = function () {
i.c(arguments);
};
i.q = [];
i.c = function (args) {
i.q.push(args);
};
w.Intercom = i;
var l = function () {
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://widget.intercom.io/widget/${INTERCOM_APP_ID}';
var x = d.getElementsByTagName('script')[0];
x.parentNode.insertBefore(s, x);
};
if (document.readyState === 'complete') {
l();
} else if (w.attachEvent) {
w.attachEvent('onload', l);
} else {
w.addEventListener('load', l, false);
}
}
})();
</script>
`;
const injectedHtml = html.replace(
'<div id="root"></div>',
`<div id="root"></div>\n${intercomScripts}\n`
);
await fs.writeFile(htmlFilePath, injectedHtml, 'utf-8');
console.log('Intercom scripts successfully injected.');
} catch (err) {
console.error('Error injecting Intercom scripts:', err);
}
}

View File

@ -3,31 +3,43 @@ import styled, { AnyStyledComponent } from 'styled-components';
import { type MenuConfig } from '@/constants/menus';
import { Dialog, DialogPlacement } from '@/components/Dialog';
import { ComboboxMenu } from '@/components/ComboboxMenu';
import { Dialog, DialogPlacement, type DialogProps } from '@/components/Dialog';
import { ComboboxMenu, type ComboboxMenuProps } from '@/components/ComboboxMenu';
type ElementProps<MenuItemValue extends string | number, MenuGroupValue extends string | number> = {
isOpen?: boolean;
setIsOpen?: (open: boolean) => void;
title?: React.ReactNode;
description?: React.ReactNode;
slotTrigger?: React.ReactNode;
slotHeaderInner?: React.ReactNode;
slotFooter?: React.ReactNode;
children?: React.ReactNode;
items: MenuConfig<MenuItemValue, MenuGroupValue>;
onItemSelected?: () => void;
inputPlaceholder?: string;
slotEmpty?: React.ReactNode;
};
type StyleProps = {
placement: DialogPlacement,
className?: string;
};
export const ComboboxDialogMenu = <MenuItemValue extends string | number, MenuGroupValue extends string | number>({
type PickComboxMenuProps<
MenuItemValue extends string | number,
MenuGroupValue extends string | number
> = Pick<
ComboboxMenuProps<MenuItemValue, MenuGroupValue>,
'inputPlaceholder' | 'onItemSelected' | 'slotEmpty' | 'withSearch' | 'withStickyLayout'
>;
type PickDialogProps = Pick<
DialogProps,
| 'description'
| 'isOpen'
| 'placement'
| 'setIsOpen'
| 'slotHeaderInner'
| 'slotTrigger'
| 'slotFooter'
>;
export const ComboboxDialogMenu = <
MenuItemValue extends string | number,
MenuGroupValue extends string | number
>({
isOpen = false,
setIsOpen,
title,
@ -40,11 +52,16 @@ export const ComboboxDialogMenu = <MenuItemValue extends string | number, MenuGr
onItemSelected,
inputPlaceholder,
slotEmpty,
withSearch,
withStickyLayout = true,
children,
placement = DialogPlacement.Default,
className,
}: ElementProps<MenuItemValue, MenuGroupValue> & StyleProps) => (
}: ElementProps<MenuItemValue, MenuGroupValue> &
PickComboxMenuProps<MenuItemValue, MenuGroupValue> &
PickDialogProps &
StyleProps) => (
// TODO: sub-menu state management
<Styled.Dialog
isOpen={isOpen}
@ -54,7 +71,6 @@ export const ComboboxDialogMenu = <MenuItemValue extends string | number, MenuGr
slotHeaderInner={slotHeaderInner}
slotTrigger={slotTrigger}
slotFooter={slotFooter}
placement={placement}
className={className}
>
@ -64,7 +80,8 @@ export const ComboboxDialogMenu = <MenuItemValue extends string | number, MenuGr
title={title}
inputPlaceholder={inputPlaceholder}
slotEmpty={slotEmpty}
withStickyLayout
withSearch={withSearch}
withStickyLayout={withStickyLayout}
/>
{children}
</Styled.Dialog>
@ -98,4 +115,5 @@ Styled.Dialog = styled(Dialog)`
Styled.ComboboxMenu = styled(ComboboxMenu)`
--comboboxMenu-backgroundColor: var(--comboboxDialogMenu-backgroundColor);
--comboboxMenu-item-gap: var(--comboxDialogMenu-item-gap, 0.5rem);
`;

View File

@ -8,7 +8,7 @@ import { layoutMixins } from '@/styles/layoutMixins';
import { Tag } from '@/components/Tag';
type ElementProps<MenuItemValue extends string, MenuGroupValue extends string> = {
type ElementProps<MenuItemValue extends string | number, MenuGroupValue extends string | number> = {
items: MenuConfig<MenuItemValue, MenuGroupValue>;
onItemSelected?: () => void;
@ -23,6 +23,11 @@ type StyleProps = {
withStickyLayout?: boolean;
};
export type ComboboxMenuProps<
MenuItemValue extends string | number,
MenuGroupValue extends string | number
> = ElementProps<MenuItemValue, MenuGroupValue> & StyleProps;
export const ComboboxMenu = <MenuItemValue extends string, MenuGroupValue extends string>({
items,
onItemSelected,
@ -34,7 +39,7 @@ export const ComboboxMenu = <MenuItemValue extends string, MenuGroupValue extend
className,
withStickyLayout,
}: ElementProps<MenuItemValue, MenuGroupValue> & StyleProps) => {
}: ComboboxMenuProps<MenuItemValue, MenuGroupValue>) => {
const [highlightedCommand, setHighlightedCommand] = useState<MenuItemValue>();
const [searchValue, setSearchValue] = useState('');
// const inputRef = useRef<HTMLInputElement | null>(null);
@ -171,6 +176,7 @@ Styled.Command = styled(Command)<{ $withStickyLayout?: boolean }>`
--comboboxMenu-item-highlighted-backgroundColor: var(--color-layer-3);
--comboboxMenu-item-highlighted-textColor: var(--color-text-1);
--comboboxMenu-item-backgroundColor: ;
--comboboxMenu-item-gap: 0.5rem;
display: grid;
align-content: start;
@ -269,18 +275,17 @@ Styled.List = styled(Command.List)<{ $withStickyLayout?: boolean }>`
`;
Styled.Item = styled(Command.Item)`
${layoutMixins.scrollSnapItem}
${popoverMixins.item}
--item-checked-backgroundColor: var(--comboboxMenu-item-checked-backgroundColor);
--item-checked-textColor: var(--comboboxMenu-item-checked-textColor);
--item-highlighted-textColor: var(--comboboxMenu-item-highlighted-textColor);
${layoutMixins.scrollSnapItem}
--item-gap: var(--comboboxMenu-item-gap);
background-color: var(--comboboxMenu-backgroundColor, inherit);
display: flex;
align-items: center;
gap: 0.5rem;
&[aria-disabled='true'] {
opacity: 0.75;

View File

@ -48,6 +48,8 @@ type StyleProps = {
className?: string;
};
export type DialogProps = ElementProps & StyleProps;
const DialogPortal = ({
withPortal,
container,
@ -82,7 +84,7 @@ export const Dialog = ({
hasHeaderBorder = false,
children,
className,
}: ElementProps & StyleProps) => {
}: DialogProps) => {
const closeButtonRef = useRef<HTMLButtonElement>();
const showOverlay = ![DialogPlacement.Inline, DialogPlacement.FullScreen].includes(placement);

View File

@ -13,6 +13,7 @@ import {
CaretIcon,
CautionCircleStrokeIcon,
CautionCircleIcon,
ChatIcon,
CheckIcon,
ChevronLeftIcon,
ChevronRightIcon,
@ -80,6 +81,7 @@ export enum IconName {
Caret = 'Caret',
CautionCircle = 'CautionCircle',
CautionCircleStroked = 'CautionCircleStroked',
Chat = 'Chat',
Check = 'Check',
ChevronLeft = 'ChevronLeft',
ChevronRight = 'ChevronRight',
@ -148,6 +150,7 @@ const icons = {
[IconName.Caret]: CaretIcon,
[IconName.CautionCircle]: CautionCircleIcon,
[IconName.CautionCircleStroked]: CautionCircleStrokeIcon,
[IconName.Chat]: ChatIcon,
[IconName.Check]: CheckIcon,
[IconName.ChevronLeft]: ChevronLeftIcon,
[IconName.ChevronRight]: ChevronRightIcon,

View File

@ -21,7 +21,7 @@ export type MenuItem<MenuItemValue, MenuItemTypes = string> = {
value: MenuItemValue;
slotBefore?: React.ReactNode;
label: string;
label: React.ReactNode;
labelRight?: React.ReactNode;
tag?: React.ReactNode;
slotAfter?: React.ReactNode;

View File

@ -0,0 +1 @@
<svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.625 6.1875h6.75m-6.75 2.25H9M1.6875 9.57c0 1.2.84225 2.2455 2.03025 2.4203.84675.1245 1.7025.2197 2.56725.2842.2625.0195.5025.1575.64875.3758L9 15.75l2.0663-3.0997c.0724-.1078.1685-.1977.2809-.2628.1125-.0651.2382-.1038.3678-.113.8589-.0641 1.7152-.1589 2.5672-.2842 1.188-.1748 2.0303-1.2195 2.0303-2.42105v-4.5135c0-1.2015-.8423-2.24625-2.0303-2.421A36.294434 36.294434 0 0 0 9 2.25c-1.794 0-3.558.13125-5.28225.38475-1.188.17475-2.03025 1.22025-2.03025 2.421V9.57Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/></svg>

After

Width:  |  Height:  |  Size: 672 B

View File

@ -1 +1 @@
<svg viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M15 8C15 9.53527 14.6867 10.8758 14.2269 11.7954C13.77 12.7092 13.3116 12.9664 13.0527 12.9968L12.6636 12.8953C12.4116 12.7511 12.092 12.4331 11.7731 11.7954C11.3133 10.8758 11 9.53527 11 8C11 6.46473 11.3133 5.12424 11.7731 4.20457C12.0924 3.56607 12.4124 3.24815 12.6645 3.10417L13.0519 3.00311C13.3107 3.0331 13.7696 3.28991 14.2269 4.20457C14.6867 5.12424 15 6.46473 15 8ZM12.2928 2.16768L1.41963 5.00415C0.628571 5.08768 0 6.39699 0 7.99992C0 9.60346 0.629045 10.9131 1.42053 10.9958L2.50023 11.2774V12.9998C2.50023 13.8283 3.17181 14.4998 4.00023 14.4998C4.82866 14.4998 5.50023 13.8283 5.50023 12.9998V12.0601L12.2914 13.8317C12.5186 13.9417 12.7559 14 13 14C14.6569 14 16 11.3137 16 8C16 4.68629 14.6569 2 13 2C12.7564 2 12.5196 2.05808 12.2928 2.16768ZM10.9931 3.5402L2.49607 5.75681C2.80523 6.30634 3 7.10764 3 7.99992C3 8.89214 2.80525 9.69339 2.49614 10.2429L10.9929 12.4595C10.3833 11.3612 10 9.77013 10 8C10 6.22968 10.3834 4.63843 10.9931 3.5402ZM2 7.99992C2 8.70677 1.85462 9.29725 1.66623 9.67403C1.59961 9.80728 1.54246 9.88955 1.5 9.93955C1.45754 9.88955 1.40039 9.80728 1.33377 9.67403C1.14538 9.29725 1 8.70677 1 7.99992C1 7.29308 1.14538 6.70259 1.33377 6.32582C1.40039 6.19256 1.45754 6.11029 1.5 6.06029C1.54246 6.11029 1.59961 6.19256 1.66623 6.32582C1.85462 6.70259 2 7.29308 2 7.99992ZM1.41964 10.0124C1.41962 10.0124 1.42071 10.0118 1.42296 10.0109C1.42079 10.0121 1.41966 10.0125 1.41964 10.0124ZM1.57704 10.0109C1.57929 10.0118 1.58038 10.0124 1.58036 10.0124C1.58033 10.0125 1.57921 10.0121 1.57704 10.0109ZM1.58036 5.9874C1.58038 5.98747 1.57929 5.98808 1.57704 5.98899C1.57921 5.98778 1.58034 5.98732 1.58036 5.9874ZM1.42296 5.98899C1.42071 5.98808 1.41962 5.98747 1.41964 5.9874C1.41966 5.98732 1.42079 5.98778 1.42296 5.98899ZM3.50023 12.9998V11.5383L4.50023 11.7992V12.9998C4.50023 13.276 4.27638 13.4998 4.00023 13.4998C3.72409 13.4998 3.50023 13.276 3.50023 12.9998Z" fill="currentColor"/></svg>
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M15 8C15 9.53527 14.6867 10.8758 14.2269 11.7954C13.77 12.7092 13.3116 12.9664 13.0527 12.9968L12.6636 12.8953C12.4116 12.7511 12.092 12.4331 11.7731 11.7954C11.3133 10.8758 11 9.53527 11 8C11 6.46473 11.3133 5.12424 11.7731 4.20457C12.0924 3.56607 12.4124 3.24815 12.6645 3.10417L13.0519 3.00311C13.3107 3.0331 13.7696 3.28991 14.2269 4.20457C14.6867 5.12424 15 6.46473 15 8ZM12.2928 2.16768L1.41963 5.00415C0.628571 5.08768 0 6.39699 0 7.99992C0 9.60346 0.629045 10.9131 1.42053 10.9958L2.50023 11.2774V12.9998C2.50023 13.8283 3.17181 14.4998 4.00023 14.4998C4.82866 14.4998 5.50023 13.8283 5.50023 12.9998V12.0601L12.2914 13.8317C12.5186 13.9417 12.7559 14 13 14C14.6569 14 16 11.3137 16 8C16 4.68629 14.6569 2 13 2C12.7564 2 12.5196 2.05808 12.2928 2.16768ZM10.9931 3.5402L2.49607 5.75681C2.80523 6.30634 3 7.10764 3 7.99992C3 8.89214 2.80525 9.69339 2.49614 10.2429L10.9929 12.4595C10.3833 11.3612 10 9.77013 10 8C10 6.22968 10.3834 4.63843 10.9931 3.5402ZM2 7.99992C2 8.70677 1.85462 9.29725 1.66623 9.67403C1.59961 9.80728 1.54246 9.88955 1.5 9.93955C1.45754 9.88955 1.40039 9.80728 1.33377 9.67403C1.14538 9.29725 1 8.70677 1 7.99992C1 7.29308 1.14538 6.70259 1.33377 6.32582C1.40039 6.19256 1.45754 6.11029 1.5 6.06029C1.54246 6.11029 1.59961 6.19256 1.66623 6.32582C1.85462 6.70259 2 7.29308 2 7.99992ZM1.41964 10.0124C1.41962 10.0124 1.42071 10.0118 1.42296 10.0109C1.42079 10.0121 1.41966 10.0125 1.41964 10.0124ZM1.57704 10.0109C1.57929 10.0118 1.58038 10.0124 1.58036 10.0124C1.58033 10.0125 1.57921 10.0121 1.57704 10.0109ZM1.58036 5.9874C1.58038 5.98747 1.57929 5.98808 1.57704 5.98899C1.57921 5.98778 1.58034 5.98732 1.58036 5.9874ZM1.42296 5.98899C1.42071 5.98808 1.41962 5.98747 1.41964 5.9874C1.41966 5.98732 1.42079 5.98778 1.42296 5.98899ZM3.50023 12.9998V11.5383L4.50023 11.7992V12.9998C4.50023 13.276 4.27638 13.4998 4.00023 13.4998C3.72409 13.4998 3.50023 13.276 3.50023 12.9998Z" fill="currentColor"/></svg>

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

@ -8,6 +8,7 @@ export { default as CalculatorIcon } from './calculator.svg';
export { default as CaretIcon } from './caret-down.svg';
export { default as CautionCircleIcon } from './caution-circle.svg';
export { default as CautionCircleStrokeIcon } from './caution-circle-stroke.svg';
export { default as ChatIcon } from './chat-bubble.svg';
export { default as CheckIcon } from './check.svg';
export { default as ChevronLeftIcon } from './chevron-left.svg';
export { default as ChevronRightIcon } from './chevron-right.svg';

View File

@ -1,12 +1,16 @@
import styled, { type AnyStyledComponent, css } from 'styled-components';
import { AbacusApiStatus } from '@/constants/abacus';
import { ButtonSize } from '@/constants/buttons';
import { STRING_KEYS } from '@/constants/localization';
import { ENVIRONMENT_CONFIG_MAP } from '@/constants/networks';
import { useApiState, useStringGetter } from '@/hooks';
import { useApiState, useSelectedNetwork, useStringGetter } from '@/hooks';
import { ChatIcon, LinkOutIcon } from '@/icons';
import { layoutMixins } from '@/styles/layoutMixins';
import { Button } from '@/components/Button';
import { Details } from '@/components/Details';
import { Output, OutputType } from '@/components/Output';
import { WithTooltip } from '@/components/WithTooltip';
@ -24,6 +28,8 @@ enum ExchangeStatus {
export const FooterDesktop = () => {
const stringGetter = useStringGetter();
const { height, indexerHeight, status, statusErrorMessage } = useApiState();
const { selectedNetwork } = useSelectedNetwork();
const { statusPage } = ENVIRONMENT_CONFIG_MAP[selectedNetwork].links;
const { exchangeStatus, label } =
!status || status === AbacusApiStatus.NORMAL
@ -38,20 +44,37 @@ export const FooterDesktop = () => {
return (
<Styled.Footer>
<WithTooltip
slotTooltip={
statusErrorMessage && (
<dl>
<dd>{statusErrorMessage}</dd>
</dl>
)
}
>
<Styled.Row>
<Styled.StatusDot exchangeStatus={exchangeStatus} />
<span>{label}</span>
</Styled.Row>
</WithTooltip>
<Styled.Row>
<WithTooltip
slotTooltip={
statusErrorMessage && (
<dl>
<dd>{statusErrorMessage}</dd>
</dl>
)
}
>
<Styled.FooterButton
slotLeft={<Styled.StatusDot exchangeStatus={exchangeStatus} />}
slotRight={statusPage && <LinkOutIcon />}
size={ButtonSize.XSmall}
state={{ isDisabled: !statusPage }}
>
{label}
</Styled.FooterButton>
</WithTooltip>
{globalThis?.Intercom && (
<Styled.FooterButton
slotLeft={<ChatIcon />}
size={ButtonSize.XSmall}
onClick={() => globalThis.Intercom('show')}
>
{stringGetter({ key: STRING_KEYS.HELP_AND_SUPPORT })}
</Styled.FooterButton>
)}
</Styled.Row>
{import.meta.env.MODE !== 'production' && (
<Styled.Details
withSeparators
@ -82,20 +105,22 @@ Styled.Footer = styled.footer`
${layoutMixins.stickyFooter}
${layoutMixins.spacedRow}
grid-area: Footer;
font-size: 0.66em;
`;
Styled.Row = styled.div`
${layoutMixins.row}
padding: 0 1rem;
gap: 0.5rem;
${layoutMixins.spacedRow}
width: var(--sidebar-width);
padding: 0 0.5rem;
border-right: 1px solid var(--color-border);
`;
Styled.StatusDot = styled.div<{ exchangeStatus: ExchangeStatus }>`
width: 1em;
height: 1em;
width: 0.5rem;
height: 0.5rem;
border-radius: 50%;
margin-right: 0.25rem;
background-color: ${({ exchangeStatus }) =>
({
@ -104,12 +129,28 @@ Styled.StatusDot = styled.div<{ exchangeStatus: ExchangeStatus }>`
}[exchangeStatus])};
`;
Styled.FooterButton = styled(Button)`
--button-height: 1.5rem;
--button-radius: 0.25rem;
--button-backgroundColor: var(--color-layer-2);
--button-border: none;
--button-textColor: var(--color-text-0);
&:hover:not(:disabled) {
--button-backgroundColor: var(--color-layer-3);
--button-textColor: var(--color-text-1);
}
&:disabled {
cursor: default;
}
`;
Styled.WarningOutput = styled(Output)`
color: var(--color-warning);
`;
Styled.Details = styled(Details)`
${layoutMixins.scrollArea}
padding: 0 0.5em;
font: var(--font-tiny-book);
`;

View File

@ -13,4 +13,6 @@ declare global {
'abacus:connectNetwork': CustomEvent;
}
var Intercom: any;
}

View File

@ -36,11 +36,10 @@
--single-unit-height: 9.375rem;
/* Modal constants */
--sidebar-modal-width: 18.75rem;
--modal-small-width: 18.75rem;
--modal-medium-width: 20.5rem;
--modal-large-width: 26.25rem;
--modal-header-height: 4rem;
--dialog-small-width: 18.75rem;
--dialog-medium-width: 20.5rem;
--dialog-large-width: 26.25rem;
--dialog-header-height: 4rem;
/* Market Selector constants */
--marketsDropdown-openWidth: 45rem;

View File

@ -188,13 +188,14 @@ export const popoverMixins = {
--item-highlighted-backgroundColor: var(--color-layer-2);
--item-highlighted-textColor: var(--color-text-2);
--item-gap: 0.5em;
--item-radius: 0px;
--item-padding: 0.5em 1em;
display: flex;
justify-content: space-between;
align-items: center;
gap: 0.5em;
gap: var(--item-gap);
padding: var(--item-padding);
border-radius: var(--item-radius);

View File

@ -1,69 +1,94 @@
import { useMemo } from 'react';
import styled, { AnyStyledComponent } from 'styled-components';
import { useDispatch } from 'react-redux';
import { Close } from '@radix-ui/react-dialog';
import { STRING_KEYS } from '@/constants/localization';
import { useStringGetter } from '@/hooks';
import { layoutMixins } from '@/styles/layoutMixins';
import { ChatIcon, FeedbackIcon, FileIcon, TerminalIcon } from '@/icons';
import { Button } from '@/components/Button';
import { Dialog } from '@/components/Dialog';
import { ButtonAction, ButtonType } from '@/constants/buttons';
import { Icon, IconName } from '@/components/Icon';
import { ComboboxDialogMenu } from '@/components/ComboboxDialogMenu';
import { isTruthy } from '@/lib/isTruthy';
type ElementProps = {
setIsOpen: (open: boolean) => void;
};
export const HELP_URL = `https://docs.google.com/forms/d/e/1FAIpQLSezLsWCKvAYDEb7L-2O4wOON1T56xxro9A2Azvl6IxXHP_15Q/viewform?usp=sf_link`;
const HELP_LINKS = {
apiDocumentation: 'https://v4-teacher.vercel.app/',
helpCenter: null,
feedback: null,
};
/**
* HelpDialog
* - Will temporarily be used as a 'Give Feedback' dialog.
* - It will ask users to navigate to a Google Form in order to record feedback.
*/
export const HelpDialog = ({ setIsOpen }: ElementProps) => {
const stringGetter = useStringGetter();
const HELP_ITEMS = useMemo(
() => [
{
group: 'help-items',
items: [
HELP_LINKS.helpCenter && {
value: 'help-center',
label: stringGetter({ key: STRING_KEYS.HELP_CENTER }),
description: stringGetter({ key: STRING_KEYS.HELP_CENTER_DESCRIPTION }),
onSelect: () => {
HELP_LINKS.helpCenter && globalThis.open(HELP_LINKS.helpCenter, '_blank');
setIsOpen(false);
},
slotBefore: <FileIcon />,
},
HELP_LINKS.apiDocumentation && {
value: 'api-documentation',
label: stringGetter({ key: STRING_KEYS.API_DOCUMENTATION }),
description: stringGetter({ key: STRING_KEYS.API_DOCUMENTATION_DESCRIPTION }),
onSelect: () => {
HELP_LINKS.apiDocumentation && globalThis.open(HELP_LINKS.apiDocumentation, '_blank');
setIsOpen(false);
},
slotBefore: <TerminalIcon />,
},
globalThis?.Intercom && {
value: 'live-chat',
label: stringGetter({ key: STRING_KEYS.LIVE_CHAT }),
description: stringGetter({ key: STRING_KEYS.LIVE_CHAT_DESCRIPTION }),
onSelect: () => {
globalThis.Intercom('show');
setIsOpen(false);
},
slotBefore: <ChatIcon />,
},
HELP_LINKS.feedback && {
value: 'feedback',
label: stringGetter({ key: STRING_KEYS.PROVIDE_FEEDBACK }),
description: stringGetter({ key: STRING_KEYS.PROVIDE_FEEDBACK_DESCRIPTION }),
onSelect: () => {
HELP_LINKS.feedback && globalThis.open(HELP_LINKS.feedback, '_blank');
setIsOpen(false);
},
slotBefore: <FeedbackIcon />,
},
].filter(isTruthy),
},
],
[stringGetter]
);
return (
<Dialog
<Styled.ComboboxDialogMenu
isOpen
withSearch={false}
setIsOpen={setIsOpen}
title={stringGetter({ key: STRING_KEYS.PROVIDE_FEEDBACK })}
description={stringGetter({ key: STRING_KEYS.PROVIDE_FEEDBACK_DESCRIPTION })}
>
<Styled.Content>
<p>
You will be navigated to a Google Form where you will be able to provide feedback. Thank
you for your contribution!
</p>
<Styled.ButtonRow>
<Close asChild>
<Button
action={ButtonAction.Primary}
type={ButtonType.Link}
href={HELP_URL}
slotRight={<Icon iconName={IconName.LinkOut} />}
>
{stringGetter({ key: STRING_KEYS.CONTINUE })}
</Button>
</Close>
</Styled.ButtonRow>
</Styled.Content>
</Dialog>
title={stringGetter({ key: STRING_KEYS.HELP })}
items={HELP_ITEMS}
/>
);
};
const Styled: Record<string, AnyStyledComponent> = {};
Styled.ButtonRow = styled.div`
${layoutMixins.row}
gap: 0.5rem;
justify-content: end;
`;
Styled.Content = styled.div`
${layoutMixins.column}
gap: 1rem;
Styled.ComboboxDialogMenu = styled(ComboboxDialogMenu)`
--dialog-width: var(--dialog-small-width);
--dialog-content-paddingTop: 1rem;
--dialog-content-paddingBottom: 1rem;
--comboxDialogMenu-item-gap: 1rem;
`;