aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/hooks/use-breadcrumbs/use-breadcrumbs.ts
blob: fd14e23da3dce31ee070bbaf4d6d8f6ed53454a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
import { useRouter } from 'next/router';
import { useCallback } from 'react';
import { useIntl } from 'react-intl';
import type { BreadcrumbList } from 'schema-dts';
import type { BreadcrumbsItem } from '../../../components';
import { PAGINATED_ROUTE_PREFIX, ROUTES } from '../../constants';
import { capitalize, getBreadcrumbItemGraph } from '../../helpers';

const is404 = (slug: string) => slug === ROUTES.NOT_FOUND;
const isArticle = (slug: string) => slug === ROUTES.ARTICLE;
const isBlog = (slug: string) => slug === ROUTES.BLOG;
const isHome = (slug: string) => slug === ROUTES.HOME;
const isPaginated = (slug: string) =>
  new RegExp(`${PAGINATED_ROUTE_PREFIX}/[0-9]+$`).test(slug);
const isProjects = (slug: string) => slug === ROUTES.PROJECTS;
const isSearch = (slug: string) => slug.startsWith(ROUTES.SEARCH);
const isThematic = (slug: string) => slug === ROUTES.THEMATICS;
const isTopic = (slug: string) => slug === ROUTES.TOPICS;

const getCrumbsSlug = (
  acc: string[],
  current: string,
  index: number
): string[] => [
  ...acc,
  ...(isSearch(`/${current}`) && current.includes('?s=')
    ? [`/${current.split('?s=')[0]}`]
    : []),
  `${acc[acc.length - 1]}${index === 0 ? '' : '/'}${current}`,
];

export type UseBreadcrumbsReturn = {
  items: BreadcrumbsItem[];
  schema: BreadcrumbList;
};

export const useBreadcrumbs = (
  currentPageTitle?: string
): UseBreadcrumbsReturn => {
  const { asPath } = useRouter();
  const intl = useIntl();

  const getCrumbLabel = useCallback(
    (slug: string) => {
      switch (true) {
        case is404(slug):
          return intl.formatMessage({
            defaultMessage: '404: Not found',
            description: 'UseBreadcrumbs: page not found label',
            id: 'EH+dam',
          });
        case isBlog(slug):
          return intl.formatMessage({
            defaultMessage: 'Blog',
            description: 'UseBreadcrumbs: blog label',
            id: 'K6aSZi',
          });
        case isHome(slug):
          return intl.formatMessage({
            defaultMessage: 'Home',
            description: 'UseBreadcrumbs: home label',
            id: 'aZIuPO',
          });
        case isPaginated(slug):
          return intl.formatMessage(
            {
              defaultMessage: 'Page {number}',
              description: 'UseBreadcrumbs: paginated route label',
              id: '/5tytV',
            },
            { number: slug.split('/').pop() }
          );
        case isProjects(slug):
          return intl.formatMessage({
            defaultMessage: 'Projects',
            description: 'UseBreadcrumbs: projects label',
            id: 'rkz8C6',
          });
        case isSearch(slug):
          if (slug.includes('?s='))
            return intl.formatMessage(
              {
                defaultMessage: 'Search results for "{query}"',
                description: 'UseBreadcrumbs: search results label',
                id: 'gSevGm',
              },
              { query: slug.split('?s=').pop() }
            );

          return intl.formatMessage({
            defaultMessage: 'Search',
            description: 'UseBreadcrumbs: search label',
            id: 'iHC3Qx',
          });
        default:
          return capitalize(
            (slug.split('/').pop() ?? slug).replaceAll('-', ' ')
          );
      }
    },
    [intl]
  );

  const items = asPath
    .split('/')
    .filter((part) => part)
    .reduce(getCrumbsSlug, [ROUTES.HOME as string])
    .filter((slug) => !slug.endsWith(PAGINATED_ROUTE_PREFIX))
    .map((slug, index, arr) => {
      if (isArticle(slug) || isThematic(slug) || isTopic(slug))
        return {
          id: ROUTES.BLOG,
          label: getCrumbLabel(ROUTES.BLOG),
          slug: ROUTES.BLOG,
        };

      const isLastSlug = index === arr.length - 1;

      return {
        id: slug,
        label:
          isLastSlug && currentPageTitle
            ? currentPageTitle
            : getCrumbLabel(slug),
        slug,
      };
    });

  return {
    items,
    schema: {
      '@type': 'BreadcrumbList',
      '@id': 'breadcrumbs',
      itemListElement: items.map((item, index) =>
        getBreadcrumbItemGraph({
          label: item.label,
          position: index + 1,
          slug: item.slug,
        })
      ),
    },
  };
};