Created
March 24, 2025 20:19
-
-
Save janis-me/1a55a8747f12e1c4fc86ebe2d05a0a55 to your computer and use it in GitHub Desktop.
React/ink ScrollArea component
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import { Box, DOMElement, measureElement, useFocus, useInput } from 'ink'; | |
| import { useEffect, useReducer, useRef } from 'react'; | |
| interface ScrollAreaState { | |
| innerHeight: number; | |
| height: number; | |
| scrollTop: number; | |
| } | |
| type ScrollAreaAction = | |
| | { type: 'SET_INNER_HEIGHT'; innerHeight: number } | |
| | { type: 'SET_HEIGHT'; height: number } | |
| | { type: 'SCROLL_DOWN' } | |
| | { type: 'SCROLL_UP' }; | |
| const reducer = (state: ScrollAreaState, action: ScrollAreaAction) => { | |
| switch (action.type) { | |
| case 'SET_INNER_HEIGHT': | |
| return { | |
| ...state, | |
| innerHeight: action.innerHeight, | |
| }; | |
| case 'SET_HEIGHT': | |
| return { | |
| ...state, | |
| height: action.height, | |
| }; | |
| case 'SCROLL_DOWN': | |
| return { | |
| ...state, | |
| scrollTop: Math.min( | |
| state.innerHeight <= state.height ? 0 : state.innerHeight - state.height, | |
| state.scrollTop + 1, | |
| ), | |
| }; | |
| case 'SCROLL_UP': | |
| return { | |
| ...state, | |
| scrollTop: Math.max(0, state.scrollTop - 1), | |
| }; | |
| default: | |
| return state; | |
| } | |
| }; | |
| export interface ScrollAreaProps extends React.PropsWithChildren { | |
| height: number; | |
| } | |
| export function ScrollArea({ height, children }: ScrollAreaProps) { | |
| useFocus(); | |
| const [state, dispatch] = useReducer(reducer, { | |
| height: height, | |
| scrollTop: 0, | |
| innerHeight: 0, | |
| }); | |
| const innerRef = useRef<DOMElement>(null); | |
| useEffect(() => { | |
| dispatch({ type: 'SET_HEIGHT', height }); | |
| }, [height]); | |
| useEffect(() => { | |
| if (!innerRef.current) return; | |
| const dimensions = measureElement(innerRef.current); | |
| dispatch({ | |
| type: 'SET_INNER_HEIGHT', | |
| innerHeight: dimensions.height, | |
| }); | |
| }, []); | |
| useInput((_input, key) => { | |
| if (key.downArrow) { | |
| dispatch({ | |
| type: 'SCROLL_DOWN', | |
| }); | |
| } | |
| if (key.upArrow) { | |
| dispatch({ | |
| type: 'SCROLL_UP', | |
| }); | |
| } | |
| }); | |
| return ( | |
| <Box height={height} borderStyle="single" flexDirection="column" flexGrow={1} overflow="hidden"> | |
| <Box ref={innerRef} flexShrink={0} flexDirection="column" marginTop={-state.scrollTop}> | |
| {children} | |
| </Box> | |
| </Box> | |
| ); | |
| } |
Author
Author
Also, The same ref/meassureDimensions approach can be used for the outer div as well, so you don't have to pass in height in a flex-grow context
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
flexGrow={1}on the outer Box is not needed, but I like to treat this component as a 'full-width' and 'full-height' component.