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

feat(Table): add sticky modifiers to Td #8391

Merged
merged 3 commits into from Dec 7, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/react-table/src/components/Table/base/types.tsx
Expand Up @@ -171,6 +171,10 @@ export interface ThSelectType {
isSelected: boolean;
/** Flag indicating the select checkbox in the th is disabled */
isHeaderSelectDisabled?: boolean;
/** Whether to disable the selection */
isDisabled?: boolean;
/** Additional props forwarded to select rowData */
props?: any;
}

export interface ThExpandType {
Expand Down
22 changes: 22 additions & 0 deletions packages/react-table/src/components/TableComposable/Td.tsx
@@ -1,6 +1,7 @@
import * as React from 'react';
import { css } from '@patternfly/react-styles';
import styles from '@patternfly/react-styles/css/components/Table/table';
import scrollStyles from '@patternfly/react-styles/css/components/Table/table-scrollable';
import { BaseCellProps } from './TableComposable';
import { cellActions } from '../Table/utils/decorators/cellActions';
import { selectable } from '../Table/utils/decorators/selectable';
Expand Down Expand Up @@ -57,6 +58,14 @@ export interface TdProps extends BaseCellProps, Omit<React.HTMLProps<HTMLTableDa
tooltip?: React.ReactNode;
/** Callback on mouse enter */
onMouseEnter?: (event: any) => void;
/** Indicates the column should be sticky */
isStickyColumn?: boolean;
/** Adds a border to the right side of the cell */
hasRightBorder?: boolean;
/** Minimum width for a sticky column */
stickyMinWidth?: string;
/** Left offset of a sticky column. This will typically be equal to the combined value set by stickyMinWidth of any sticky columns that precede the current sticky column. */
stickyLeftOffset?: string;
}

const TdBase: React.FunctionComponent<TdProps> = ({
Expand All @@ -80,6 +89,10 @@ const TdBase: React.FunctionComponent<TdProps> = ({
draggableRow: draggableRowProp = null,
tooltip = '',
onMouseEnter: onMouseEnterProp = () => {},
isStickyColumn = false,
hasRightBorder = false,
stickyMinWidth = '120px',
stickyLeftOffset,
...props
}: TdProps) => {
const [showTooltip, setShowTooltip] = React.useState(false);
Expand Down Expand Up @@ -239,13 +252,22 @@ const TdBase: React.FunctionComponent<TdProps> = ({
isActionCell && styles.tableAction,
textCenter && styles.modifiers.center,
noPadding && styles.modifiers.noPadding,
isStickyColumn && scrollStyles.tableStickyColumn,
hasRightBorder && scrollStyles.modifiers.borderRight,
styles.modifiers[modifier as 'breakWord' | 'fitContent' | 'nowrap' | 'truncate' | 'wrap' | undefined],
draggableParams && styles.tableDraggable,
mergedClassName
)}
ref={innerRef}
{...mergedProps}
{...props}
{...(isStickyColumn && {
style: {
'--pf-c-table__sticky-column--MinWidth': stickyMinWidth ? stickyMinWidth : undefined,
'--pf-c-table__sticky-column--Left': stickyLeftOffset ? stickyLeftOffset : undefined,
...props.style
} as React.CSSProperties
})}
>
{mergedChildren || children}
</MergedComponent>
Expand Down
5 changes: 5 additions & 0 deletions packages/react-table/src/components/TableComposable/Th.tsx
Expand Up @@ -109,6 +109,11 @@ const ThBase: React.FunctionComponent<ThProps> = ({
}
const selectParams = select
? selectable(children as IFormatterValueType, {
rowData: {
selected: select.isSelected,
disableSelection: select?.isDisabled,
props: select?.props
},
column: {
extraParams: {
onSelect: select?.onSelect,
Expand Down
Expand Up @@ -327,14 +327,14 @@ There are a few ways this can be handled:

### Composable: Sticky column

To make a column sticky, wrap `TableComposable` with `InnerScrollContainer` and add the following properties to the `Th` that should be sticky: `isStickyColumn` and `hasRightBorder`. To prevent the default text wrapping behavior and allow horizontal scrolling, all `Th` should also have the `modifier="nowrap"` property. To set the minimum width of the sticky column, use the `stickyMinWidth` property.
To make a column sticky, wrap `TableComposable` with `InnerScrollContainer` and add the following properties to the `Th` or `Td` that should be sticky: `isStickyColumn` and `hasRightBorder`. To prevent the default text wrapping behavior and allow horizontal scrolling, all `Th` or `Td` cells should also have the `modifier="nowrap"` property. To set the minimum width of the sticky column, use the `stickyMinWidth` property.

```ts file="ComposableTableStickyColumn.tsx"
```

### Composable: Multiple sticky columns

To make multiple columns sticky, wrap `TableComposable` with `InnerScrollContainer` and add `isStickyColumn` to all columns that should be sticky. The rightmost column should also have the `hasRightBorder` property, and each sticky column after the first must define a `stickyLeftOffset` property that equals the combined width of the previous sticky columns - set by `stickyMinWidth`. To prevent the default text wrapping behavior and allow horizontal scrolling, all `Th` should also have the `modifier="nowrap"` property.
To make multiple columns sticky, wrap `TableComposable` with `InnerScrollContainer` and add `isStickyColumn` to all columns that should be sticky. The rightmost column should also have the `hasRightBorder` property, and each sticky column after the first must define a `stickyLeftOffset` property that equals the combined width of the previous sticky columns - set by `stickyMinWidth`. To prevent the default text wrapping behavior and allow horizontal scrolling, all `Th` or `Td` cells should also have the `modifier="nowrap"` property.

```ts file="ComposableTableMultipleStickyColumns.tsx"
```
Expand Down