Skip to content

feat: support scrollbar style #235

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 22, 2023
Merged

feat: support scrollbar style #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
400d88d
feat: support scrollbar style
linxianxi Sep 22, 2023
9aaed5e
docs: update md
linxianxi Sep 22, 2023
60b40b1
test: add case
linxianxi Sep 22, 2023
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
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,16 @@ import List from 'rc-virtual-list';

## List

| Prop | Description | Type | Default |
| ---------- | ------------------------------------------------------- | ------------------------------------ | ------- |
| children | Render props of item | (item, index, props) => ReactElement | - |
| component | Customize List dom element | string \| Component | div |
| data | Data list | Array | - |
| disabled | Disable scroll check. Usually used on animation control | boolean | false |
| height | List height | number | - |
| itemHeight | Item minium height | number | - |
| itemKey | Match key with item | string | - |
| Prop | Description | Type | Default |
| ---------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| children | Render props of item | (item, index, props) => ReactElement | - |
| component | Customize List dom element | string \| Component | div |
| data | Data list | Array | - |
| disabled | Disable scroll check. Usually used on animation control | boolean | false |
| height | List height | number | - |
| itemHeight | Item minium height | number | - |
| itemKey | Match key with item | string | - |
| styles | style | { horizontalScrollBar?: React.CSSProperties; horizontalScrollBarThumb?: React.CSSProperties; verticalScrollBar?: React.CSSProperties; verticalScrollBarThumb?: React.CSSProperties; } | - |

`children` provides additional `props` argument to support IE 11 scroll shaking.
It will set `style` to `visibility: hidden` when measuring. You can ignore this if no requirement on IE.
12 changes: 12 additions & 0 deletions src/List.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ export interface ListProps<T> extends Omit<React.HTMLAttributes<any>, 'children'
*/
scrollWidth?: number;

styles?: {
horizontalScrollBar?: React.CSSProperties;
horizontalScrollBarThumb?: React.CSSProperties;
verticalScrollBar?: React.CSSProperties;
verticalScrollBarThumb?: React.CSSProperties;
};

onScroll?: React.UIEventHandler<HTMLElement>;

/**
Expand Down Expand Up @@ -102,6 +109,7 @@ export function RawList<T>(props: ListProps<T>, ref: React.Ref<ListRef>) {
onVisibleChange,
innerProps,
extraRender,
styles,
...restProps
} = props;

Expand Down Expand Up @@ -560,6 +568,8 @@ export function RawList<T>(props: ListProps<T>, ref: React.Ref<ListRef>) {
onStopMove={onScrollbarStopMove}
spinSize={verticalScrollBarSpinSize}
containerSize={size.height}
style={styles?.verticalScrollBar}
thumbStyle={styles?.verticalScrollBarThumb}
/>
)}

Expand All @@ -576,6 +586,8 @@ export function RawList<T>(props: ListProps<T>, ref: React.Ref<ListRef>) {
spinSize={horizontalScrollBarSpinSize}
containerSize={size.width}
horizontal
style={styles?.horizontalScrollBar}
thumbStyle={styles?.horizontalScrollBarThumb}
/>
)}
</div>
Expand Down
7 changes: 6 additions & 1 deletion src/ScrollBar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ export interface ScrollBarProps {
onStartMove: () => void;
onStopMove: () => void;
horizontal?: boolean;

style?: React.CSSProperties;
thumbStyle?: React.CSSProperties;
spinSize: number;
containerSize: number;
}
Expand Down Expand Up @@ -42,6 +43,8 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
horizontal,
spinSize,
containerSize,
style,
thumbStyle: propsThumbStyle,
} = props;

const [dragging, setDragging] = React.useState(false);
Expand Down Expand Up @@ -204,6 +207,7 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
const containerStyle: React.CSSProperties = {
position: 'absolute',
visibility: visible && canScroll ? null : 'hidden',
...style,
};

const thumbStyle: React.CSSProperties = {
Expand All @@ -212,6 +216,7 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
borderRadius: 99,
cursor: 'pointer',
userSelect: 'none',
...propsThumbStyle,
};

if (horizontal) {
Expand Down
35 changes: 35 additions & 0 deletions tests/scroll.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,4 +401,39 @@ describe('List.Scroll', () => {

expect(extraRender).toHaveBeenCalledWith(expect.objectContaining({ end: 99 }));
});

it('scrollbar styles should work', () => {
const { container } = genList(
{
itemHeight: 20,
height: 100,
data: genData(100),
scrollWidth: 1000,
styles: {
horizontalScrollBar: { background: 'red' },
horizontalScrollBarThumb: { background: 'green' },
verticalScrollBar: { background: 'orange' },
verticalScrollBarThumb: { background: 'blue' },
},
},
render,
);

expect(
container.querySelector('.rc-virtual-list-scrollbar-horizontal').style.background,
).toEqual('red');
expect(
container.querySelector(
'.rc-virtual-list-scrollbar-horizontal .rc-virtual-list-scrollbar-thumb',
).style.background,
).toEqual('green');
expect(container.querySelector('.rc-virtual-list-scrollbar-vertical').style.background).toEqual(
'orange',
);
expect(
container.querySelector(
'.rc-virtual-list-scrollbar-vertical .rc-virtual-list-scrollbar-thumb',
).style.background,
).toEqual('blue');
});
});