Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

4.8 KB
Raw Blame
import _map from 'lodash/map'
import { useMemo } from 'react'
import { Trans, useTranslation } from 'react-i18next'
import { Link } from '~/ui/Link'
import sanitizeHtml from 'sanitize-html'

import { DOCS_URL, PLAN_LIMITS, TRIAL_DAYS, DISCORD_URL } from '~/lib/constants'
import { FAQ as FAQAccordion } from '~/ui/FAQ'
import { Text } from '~/ui/Text'
import routesPath from '~/utils/routes'

interface FAQProps {
  includeGAQuestions?: boolean
  includeAgencyQuestions?: boolean
}

const FAQ = ({
  includeGAQuestions = false,
  includeAgencyQuestions = false,
}: FAQProps) => {
  const { t } = useTranslation('common')

  const onLinkClick = (e: React.MouseEvent<HTMLAnchorElement>) => {
    e.stopPropagation()
  }

  const values = useMemo(
    () => ({
      lowestPlanEventsAmount:
        PLAN_LIMITS['100k'].monthlyUsageLimit.toLocaleString('en-US'),
      moderatePlanEventsAmount:
        PLAN_LIMITS['500k'].monthlyUsageLimit.toLocaleString('en-US'),
      freeTrialDays: TRIAL_DAYS,
    }),
    [],
  )
  const stripTags = (html: string) =>
    sanitizeHtml(html, {
      allowedTags: [],
      allowedAttributes: {},
    })

  const items = useMemo(() => {
    const regularItems = t('main.faq.items', { returnObjects: true }) as {
      q: string
      a: string
    }[]

    const questions = regularItems.map((item, idx) => ({
      ...item,
      i18nKey: `main.faq.items.${idx}`,
    }))

    if (includeGAQuestions) {
      const gaItems = t('main.faq.gaItems', { returnObjects: true }) as {
        q: string
        a: string
      }[]

      const gaQuestions = gaItems.map((item, idx) => ({
        ...item,
        i18nKey: `main.faq.gaItems.${idx}`,
      }))

      return [...gaQuestions, ...questions]
    }

    if (includeAgencyQuestions) {
      const agencyItems = t('main.faq.agencyItems', {
        returnObjects: true,
      }) as {
        q: string
        a: string
      }[]

      const agencyQuestions = Array.isArray(agencyItems)
        ? agencyItems.map((item, idx) => ({
            ...item,
            i18nKey: `main.faq.agencyItems.${idx}`,
          }))
        : []

      return [...agencyQuestions, ...questions]
    }

    return questions
  }, [t, includeGAQuestions, includeAgencyQuestions])

  const structuredData = {
    '@context': 'https://schema.org',
    '@type': 'FAQPage',
    mainEntity: items.map((item) => ({
      '@type': 'Question',
      name: t(`${item.i18nKey}.q`),
      acceptedAnswer: {
        '@type': 'Answer',
        text: stripTags(
          t(`${item.i18nKey}.a`, {
            ...values,
          }),
        ),
      },
    })),
  }

  const formattedItems = useMemo(() => {
    return items.map((item) => ({
      question: <Trans t={t} i18nKey={`${item.i18nKey}.q`} />,
      answer: (
        <Trans
          t={t}
          i18nKey={`${item.i18nKey}.a`}
          values={values}
          components={{
            dataPolicyUrl: (
              <Link
                to={routesPath.dataPolicy}
                className='underline decoration-dashed hover:decoration-solid'
                aria-label='Data policy'
                onClick={onLinkClick}
              />
            ),
            apiDocumentationUrl: (
              <a
                href={DOCS_URL}
                className='underline decoration-dashed hover:decoration-solid'
                target='_blank'
                rel='noopener noreferrer'
                aria-label='API documentation (opens in a new tab)'
                onClick={onLinkClick}
              />
            ),
            contactUsUrl: (
              <Link
                to={routesPath.contact}
                className='underline decoration-dashed hover:decoration-solid'
                aria-label='Contact us'
                onClick={onLinkClick}
              />
            ),
            discordUrl: (
              <a
                href={DISCORD_URL}
                className='underline decoration-dashed hover:decoration-solid'
                target='_blank'
                rel='noopener noreferrer'
                aria-label='Discord (opens in a new tab)'
                onClick={onLinkClick}
              />
            ),
          }}
        />
      ),
    }))
  }, [items, t, values])

  return (
    <section className='relative mx-auto max-w-5xl px-2 py-14 lg:px-8'>
      <Text
        as='h2'
        size='3xl'
        weight='bold'
        tracking='tight'
        className='text-center sm:text-4xl'
      >
        {t('main.faq.title')}
      </Text>
      <div className='mt-8 flex flex-col'>
        <FAQAccordion items={formattedItems} withPadding />
      </div>
      <script
        type='application/ld+json'
        dangerouslySetInnerHTML={{
          __html: JSON.stringify(structuredData)
            .replace(/</g, '\\u003c')
            .replace(/\u2028|\u2029/g, ''),
        }}
      />
    </section>
  )
}

export default FAQ