Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor ScrollHeader and utility functions for improved performance and readability #52

Merged
merged 1 commit into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions src/components/Scroll/ScrollHeader.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { CSSProperties, useEffect, useMemo, useRef } from 'react';
import React, { CSSProperties, useCallback, useEffect, useMemo, useRef } from 'react';
import { useScrollContext } from './Scroll.provider';
import { Item } from './types';

Expand Down Expand Up @@ -50,6 +50,22 @@ export const ScrollHeader: React.FC<IScrollHeaderProps> = ({ path, itemId, itemR
}
}, [headerBehavior, path, stickTo]);

const memoizedHeaderCollapseOpen = useCallback(() => headerCollaspeOpen(path), [headerCollaspeOpen, path]);
const memoizedHeaderCollapseClose = useCallback(() => headerCollaspeClose(path), [headerCollaspeClose, path]);
const isCollapsed = useMemo(() => collapsedPaths.includes(path.join('-')), [collapsedPaths]);

const momoizedHeader = useMemo(
() =>
itemRender({
collapse: {
open: memoizedHeaderCollapseOpen,
close: memoizedHeaderCollapseClose,
isOpen: !isCollapsed,
},
}),
[itemRender, isCollapsed, memoizedHeaderCollapseOpen, memoizedHeaderCollapseClose],
);

return (
<li
id={itemId}
Expand All @@ -58,16 +74,10 @@ export const ScrollHeader: React.FC<IScrollHeaderProps> = ({ path, itemId, itemR
style={{ ...behaviorStyle }}
aria-label="Scroll Header"
role="heading"
aria-level={1}
aria-level={path.length}
ref={ref}
>
{itemRender({
collapse: {
open: () => headerCollaspeOpen(path),
close: () => headerCollaspeClose(path),
isOpen: !collapsedPaths.includes(path.join('-')),
},
})}
{momoizedHeader}
</li>
);
};
33 changes: 20 additions & 13 deletions src/components/Scroll/story/util.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { faker } from '@faker-js/faker';
import { Item } from '../types';
import { useMemo } from 'react';

const argTypes = {
items: {
Expand Down Expand Up @@ -32,14 +33,15 @@ const headerRender =
({ collapse }) => {
const { isOpen, close, open } = collapse ?? {};

let header;
if (key === 1) {
header = faker.person.jobTitle();
} else if (key === 2) {
header = faker.location.country();
} else {
header = faker.company.name();
}
const header = useMemo(() => {
if (key === 1) {
return faker.person.jobTitle();
} else if (key === 2) {
return faker.location.country();
} else {
return faker.company.name();
}
}, []);

return (
<div
Expand Down Expand Up @@ -74,10 +76,15 @@ const headerRender =
};

const itemRender: Item['render'] = () => {
const randomName = faker.person.fullName();
const color = `#${Math.floor(Math.random() * 16777215)
.toString(16)
.padStart(6, '0')}`;
const name = useMemo(() => faker.person.fullName(), []);
const color = useMemo(
() =>
`#${Math.floor(Math.random() * 16777215)
.toString(16)
.padStart(6, '0')}`,
[],
);

return (
<div
style={{
Expand All @@ -99,7 +106,7 @@ const itemRender: Item['render'] = () => {
marginRight: '10px',
}}
></div>
{randomName}
{name}
</div>
);
};
Expand Down
12 changes: 8 additions & 4 deletions src/components/Scroll/util/get-items.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import React from 'react';
import React, { CSSProperties } from 'react';
import { ScrollHeader } from '../ScrollHeader';
import { ScrollItem } from '../ScrollItem';
import { Items, HeaderBehavior } from '../types';

const hiddenStyles: CSSProperties = { visibility: 'hidden', position: 'absolute', width: '0', height: '0' };

type GetItemsProps = {
items: Items;
headerBehavior: HeaderBehavior;
Expand All @@ -19,12 +21,14 @@ export const getItems = ({ headerBehavior, items, path = [], collapsedPaths }: G
const currentPath = [...path, index];

if (item.nestedItems?.length) {
const hiddenStyle = collapsedPaths.includes(currentPath.join('-')) ? hiddenStyles : {};

return (
<Wrapper key={currentPath.join('-')}>
<ScrollHeader path={currentPath} itemRender={item.render} itemId={item.id} />
{collapsedPaths.includes(currentPath.join('-'))
? null
: getItems({ items: item.nestedItems, headerBehavior, path: currentPath, collapsedPaths })}
<section style={hiddenStyle}>
{getItems({ items: item.nestedItems, headerBehavior, path: currentPath, collapsedPaths })}
</section>
</Wrapper>
);
} else {
Expand Down
1 change: 1 addition & 0 deletions src/welcome.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export default {
options: { showPanel: false },
controls: { hideNoControlsWarning: true, disable: true },
actions: { disable: true },
toolbar: { hidden: true },
},
} as Meta;

Expand Down
Loading