Add JSDoc comments to timeline components

This commit is contained in:
Alex Gleason
2022-06-03 13:09:46 -05:00
parent aad192d150
commit fbb460817f
4 changed files with 50 additions and 12 deletions

View File

@@ -15,9 +15,11 @@ const messages = defineMessages({
});
interface ITimeline extends Omit<IStatusList, 'statusIds' | 'isLoading' | 'hasMore'> {
/** ID of the timeline in Redux. */
timelineId: string,
}
/** Scrollable list of statuses from a timeline in the Redux store. */
const Timeline: React.FC<ITimeline> = ({
timelineId,
onLoadMore,
@@ -55,6 +57,7 @@ const Timeline: React.FC<ITimeline> = ({
/>
<StatusList
timelineId={timelineId}
onScrollToTop={handleScrollToTop}
onScroll={handleScroll}
lastStatusId={lastStatusId}