aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/posts-list/posts-list.tsx
blob: ad5bed56f416c3f4a2df5edf2049567314afe36e (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
import {
  type ForwardRefRenderFunction,
  type HTMLAttributes,
  forwardRef,
  useCallback,
  useRef,
  type RefCallback,
} from 'react';
import { useIntl } from 'react-intl';
import { mergeRefs } from '../../../utils/helpers';
import {
  Heading,
  type HeadingLevel,
  List,
  ListItem,
  Button,
  ProgressBar,
} from '../../atoms';
import {
  PostPreview,
  type PostPreviewMetaData,
  type PostPreviewProps,
} from '../post-preview';
import styles from './posts-list.module.scss';

const MAX_HEADING_LVL = 6;

export type PostData = Pick<
  PostPreviewProps,
  'cover' | 'excerpt' | 'heading' | 'url'
> & {
  /**
   * The post id.
   */
  id: string | number;
  /**
   * The post meta.
   */
  meta: PostPreviewMetaData &
    Required<Pick<PostPreviewMetaData, 'publicationDate'>>;
};

/**
 * Method to sort PageLink objects by name.
 *
 * @param {PageLink} a - A PageLink object.
 * @param {PageLink} b - Another PageLink object.
 * @returns {1 | -1 | 0}
 */
export const sortPostsByDate = (a: PostData, b: PostData) =>
  new Date(b.meta.publicationDate).getTime() -
  new Date(a.meta.publicationDate).getTime();

const getPostsByYear = (posts: PostData[]) => {
  const yearCollection = new Map<string, PostData[]>();
  const sortedPosts = [...posts].sort(sortPostsByDate);

  for (const post of sortedPosts) {
    const currentPostYear = new Date(post.meta.publicationDate)
      .getFullYear()
      .toString();

    const yearPosts = yearCollection.get(currentPostYear) ?? [];

    yearCollection.set(currentPostYear, [...yearPosts, post]);
  }

  return yearCollection;
};

type GetPostsListOptions = {
  headingLvl: HeadingLevel;
  isOrdered?: boolean;
};

export type PostsListProps = Omit<
  HTMLAttributes<HTMLDivElement>,
  'children'
> & {
  /**
   * The first new result index. It will be use to make the load more button
   * accessible for keyboard users.
   */
  firstNewResult?: number;
  /**
   * The heading level to use on posts titles.
   *
   * @default 2
   */
  headingLvl?: HeadingLevel;
  /**
   * Should we indicate that new posts are loading?
   *
   * @default false
   */
  isLoading?: boolean;
  /**
   * A callback function to handle loading more posts.
   */
  onLoadMore?: () => void;
  /**
   * The posts.
   */
  posts: PostData[];
  /**
   * Should we use a different section by year?
   */
  sortByYear?: boolean;
  /**
   * The total posts number.
   */
  total?: number;
};

const PostsListWithRef: ForwardRefRenderFunction<
  HTMLDivElement,
  PostsListProps
> = (
  {
    firstNewResult,
    headingLvl = 2,
    isLoading = false,
    onLoadMore,
    posts,
    sortByYear = false,
    total,
    ...props
  },
  ref
) => {
  const wrapperRef = useRef<HTMLDivElement | null>(null);
  const firstNewResultRef: RefCallback<HTMLLIElement> = useCallback((el) => {
    el?.focus();
  }, []);
  const intl = useIntl();
  const progressInfo = intl.formatMessage(
    {
      defaultMessage:
        '{articlesCount, plural, =0 {# loaded articles} one {# loaded article} other {# loaded articles}} out of a total of {total}',
      description: 'PostsList: loaded articles progress',
      id: '9MeLN3',
    },
    {
      articlesCount: posts.length,
      total,
    }
  );
  const loadMoreBtn = intl.formatMessage({
    defaultMessage: 'Load more posts?',
    description: 'PostsList: load more button',
    id: 'hGvQpI',
  });

  const getPostsList = useCallback(
    (
      data: PostData[],
      { headingLvl: lvl, isOrdered }: GetPostsListOptions,
      indexAcc = 0
    ) => (
      <List
        hideMarker
        isOrdered={isOrdered}
        // eslint-disable-next-line react/jsx-no-literals
        spacing="md"
      >
        {data.map(({ id, ...post }, index) => {
          const isFirstNewResult = firstNewResult === indexAcc + index;

          return (
            <ListItem
              key={id}
              ref={isFirstNewResult ? firstNewResultRef : undefined}
              tabIndex={isFirstNewResult ? -1 : undefined}
            >
              <PostPreview {...post} headingLvl={lvl} />
            </ListItem>
          );
        })}
      </List>
    ),
    [firstNewResult, firstNewResultRef]
  );

  const getSortedPostsList = useCallback(
    (data: PostData[]) => {
      const postsByYear = Array.from(getPostsByYear(data));
      const postsLvl =
        headingLvl < MAX_HEADING_LVL
          ? ((headingLvl + 1) as HeadingLevel)
          : headingLvl;
      let indexAcc = 0;

      return postsByYear.map(([year, sortedPosts], index) => {
        indexAcc +=
          index > 0 ? postsByYear[index - 1][1].length : sortedPosts.length;

        return (
          <section className={styles.section} key={year}>
            <Heading className={styles.year} level={headingLvl}>
              {year}
            </Heading>
            {getPostsList(
              sortedPosts,
              {
                headingLvl: postsLvl,
                isOrdered: true,
              },
              indexAcc
            )}
          </section>
        );
      });
    },
    [getPostsList, headingLvl]
  );

  return (
    <div {...props} ref={mergeRefs([wrapperRef, ref])}>
      {sortByYear
        ? getSortedPostsList(posts)
        : getPostsList(posts, { headingLvl })}
      {total ? (
        <ProgressBar
          aria-label={progressInfo}
          className={styles.progress}
          current={posts.length}
          isCentered
          isLoading={isLoading}
          label={progressInfo}
          max={total}
        />
      ) : null}
      {onLoadMore && (!total || (total && posts.length < total)) ? (
        <Button
          className={styles.btn}
          isLoading={isLoading}
          // eslint-disable-next-line react/jsx-no-literals
          kind="tertiary"
          onClick={onLoadMore}
        >
          {loadMoreBtn}
        </Button>
      ) : null}
    </div>
  );
};

export const PostsList = forwardRef(PostsListWithRef);