-
Notifications
You must be signed in to change notification settings - Fork 381
feat(Table): support dynamic sticky styling #12348
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
Open
kmcfaul
wants to merge
3
commits into
patternfly:main
Choose a base branch
from
kmcfaul:sticky-table-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
140 changes: 140 additions & 0 deletions
140
packages/react-table/src/components/Table/examples/TableStickyHeaderDynamic.tsx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import { useLayoutEffect, useRef, useState } from 'react'; | ||
| import { Table, Thead, Tr, Th, Tbody, Td, InnerScrollContainer } from '@patternfly/react-table'; | ||
| import BlueprintIcon from '@patternfly/react-icons/dist/esm/icons/blueprint-icon'; | ||
|
|
||
| interface Fact { | ||
| name: string; | ||
| state: string; | ||
| detail1: string; | ||
| detail2: string; | ||
| detail3: string; | ||
| detail4: string; | ||
| detail5: string; | ||
| detail6: string; | ||
| detail7: string; | ||
| } | ||
|
|
||
| const useIsStuckFromScrollParent = ({ | ||
| shouldTrack, | ||
| scrollParentRef | ||
| }: { | ||
| /** Indicates whether to track the scroll top position of the scroll parent element */ | ||
| shouldTrack: boolean; | ||
| /** Reference to the scroll parent element */ | ||
| scrollParentRef: React.RefObject<any>; | ||
| }): boolean => { | ||
| const [isStuck, setIsStuck] = useState(false); | ||
|
|
||
| useLayoutEffect(() => { | ||
| if (!shouldTrack) { | ||
| setIsStuck(false); | ||
| return; | ||
| } | ||
|
|
||
| const scrollElement = scrollParentRef.current; | ||
| if (!scrollElement) { | ||
| setIsStuck(false); | ||
| return; | ||
| } | ||
|
|
||
| const syncFromScroll = () => { | ||
| setIsStuck(scrollElement.scrollTop > 0); | ||
| }; | ||
| syncFromScroll(); | ||
| scrollElement.addEventListener('scroll', syncFromScroll, { passive: true }); | ||
| return () => scrollElement.removeEventListener('scroll', syncFromScroll); | ||
| }, [shouldTrack, scrollParentRef]); | ||
|
|
||
| return isStuck; | ||
| }; | ||
|
|
||
| export const TableStickyHeaderDynamic: React.FunctionComponent = () => { | ||
| const scrollContainerRef = useRef<HTMLDivElement>(null); | ||
| const isStuck = useIsStuckFromScrollParent({ shouldTrack: true, scrollParentRef: scrollContainerRef }); | ||
|
|
||
| // In real usage, this data would come from some external source like an API via props. | ||
| const facts: Fact[] = Array.from({ length: 9 }, (_, index) => ({ | ||
| name: `Fact ${index + 1}`, | ||
| state: `State ${index + 1}`, | ||
| detail1: `Test cell ${index + 1}-3`, | ||
| detail2: `Test cell ${index + 1}-4`, | ||
| detail3: `Test cell ${index + 1}-5`, | ||
| detail4: `Test cell ${index + 1}-6`, | ||
| detail5: `Test cell ${index + 1}-7`, | ||
| detail6: `Test cell ${index + 1}-8`, | ||
| detail7: `Test cell ${index + 1}-9` | ||
| })); | ||
|
|
||
| const columnNames = { | ||
| name: 'Fact', | ||
| state: 'State', | ||
| header3: 'Header 3', | ||
| header4: 'Header 4', | ||
| header5: 'Header 5', | ||
| header6: 'Header 6', | ||
| header7: 'Header 7', | ||
| header8: 'Header 8', | ||
| header9: 'Header 9' | ||
| }; | ||
|
|
||
| return ( | ||
| <div style={{ height: '400px' }}> | ||
| <InnerScrollContainer ref={scrollContainerRef}> | ||
| <Table | ||
| aria-label="Sticky columns and header table" | ||
| gridBreakPoint="" | ||
| isStickyHeaderBase | ||
| isStickyHeaderStuck={isStuck} | ||
| > | ||
| <Thead> | ||
| <Tr> | ||
| <Th modifier="truncate">{columnNames.name}</Th> | ||
| <Th modifier="truncate">{columnNames.state}</Th> | ||
| <Th modifier="truncate">{columnNames.header3}</Th> | ||
| <Th modifier="truncate">{columnNames.header4}</Th> | ||
| <Th modifier="truncate">{columnNames.header5}</Th> | ||
| <Th modifier="truncate">{columnNames.header6}</Th> | ||
| <Th modifier="truncate">{columnNames.header7}</Th> | ||
| <Th modifier="truncate">{columnNames.header8}</Th> | ||
| <Th modifier="truncate">{columnNames.header9}</Th> | ||
| </Tr> | ||
| </Thead> | ||
| <Tbody> | ||
| {facts.map((fact) => ( | ||
| <Tr key={fact.name}> | ||
| <Th modifier="nowrap" dataLabel={columnNames.name}> | ||
| {fact.name} | ||
| </Th> | ||
| <Th modifier="nowrap" dataLabel={columnNames.state}> | ||
| <BlueprintIcon /> | ||
| {` ${fact.state}`} | ||
| </Th> | ||
kmcfaul marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <Td modifier="nowrap" dataLabel={columnNames.header3}> | ||
| {fact.detail1} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header4}> | ||
| {fact.detail2} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header5}> | ||
| {fact.detail3} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header6}> | ||
| {fact.detail4} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header7}> | ||
| {fact.detail5} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header8}> | ||
| {fact.detail6} | ||
| </Td> | ||
| <Td modifier="nowrap" dataLabel={columnNames.header9}> | ||
| {fact.detail7} | ||
| </Td> | ||
| </Tr> | ||
| ))} | ||
| </Tbody> | ||
| </Table> | ||
| </InnerScrollContainer> | ||
| </div> | ||
| ); | ||
| }; | ||
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.