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.

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

chore: Update TreeView API #7613

Open
wants to merge 5 commits into
base: s2-treeview
Choose a base branch
from
Open

chore: Update TreeView API #7613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
881195f
chore: Update TreeView API
snowystinger Jan 15, 2025
f45fad9
fix docs
snowystinger Jan 15, 2025
f806038
fix dynamic example
snowystinger Jan 16, 2025
a9b1e94
actually save
snowystinger Jan 16, 2025
f3dbc78
fix docs
snowystinger Jan 16, 2025
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
153 changes: 67 additions & 86 deletions packages/@react-spectrum/s2/src/TreeView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ import {ActionButtonGroupContext} from './ActionButtonGroup';
import {ActionMenuContext} from './ActionMenu';
import {
ButtonContext,
Collection,
Provider,
TreeItemProps as RACTreeItemProps,
TreeProps as RACTreeProps,
TreeItemContentProps,
UNSTABLE_ListLayout,
UNSTABLE_Tree,
UNSTABLE_TreeItem,
Expand All @@ -34,8 +34,8 @@ import {getAllowedOverrides, StylesPropWithHeight, UnsafeStyles} from './style-u
import {IconContext} from './Icon';
import {isAndroid} from '@react-aria/utils';
import {raw} from '../style/style-macro' with {type: 'macro'};
import React, {createContext, forwardRef, isValidElement, JSXElementConstructor, ReactElement, useContext, useMemo, useRef} from 'react';
import {Text, TextContext} from './Content';
import React, {createContext, forwardRef, JSXElementConstructor, ReactElement, ReactNode, useContext, useMemo, useRef} from 'react';
import {TextContext} from './Content';
import {useButton} from '@react-aria/button';
import {useDOMRef} from '@react-spectrum/utils';
import {useLocale} from '@react-aria/i18n';
Expand Down Expand Up @@ -65,10 +65,6 @@ interface TreeRendererContextValue {
}
const TreeRendererContext = createContext<TreeRendererContextValue>({});

function useTreeRendererContext(): TreeRendererContextValue {
return useContext(TreeRendererContext)!;
}


let InternalTreeContext = createContext<{isDetached?: boolean, isEmphasized?: boolean}>({});

Expand Down Expand Up @@ -340,94 +336,79 @@ const treeRowFocusIndicator = raw(`
}`
);

let TreeItemContext = createContext<{hasChildItems?: boolean}>({});

export const TreeViewItem = <T extends object>(props: TreeViewItemProps<T>) => {
let {
children,
childItems,
hasChildItems,
href
} = props;

let content;
let nestedRows;
let {renderer} = useTreeRendererContext();
let {isDetached, isEmphasized} = useContext(InternalTreeContext);
// TODO alternative api is that we have a separate prop for the TreeItems contents and expect the child to then be
// a nested tree item

if (typeof children === 'string') {
content = <Text>{children}</Text>;
} else {
content = [];
nestedRows = [];
React.Children.forEach(children, node => {
if (isValidElement(node) && node.type === TreeViewItem) {
nestedRows.push(node);
} else {
content.push(node);
}
});
}

if (childItems != null && renderer) {
nestedRows = (
<Collection items={childItems}>
{renderer}
</Collection>
);
}

return (
// TODO right now all the tree rows have the various data attributes applied on their dom nodes, should they? Doesn't feel very useful
<UNSTABLE_TreeItem
{...props}
className={(renderProps) => treeRow({...renderProps, isLink: !!href, isEmphasized}) + (renderProps.isFocusVisible && !isDetached ? ' ' + treeRowFocusIndicator : '')}>
<UNSTABLE_TreeItemContent>
{({isExpanded, hasChildRows, selectionMode, selectionBehavior, isDisabled, isFocusVisible, isSelected, id, state}) => {
let isNextSelected = false;
let isNextFocused = false;
let keyAfter = state.collection.getKeyAfter(id);
if (keyAfter != null) {
isNextSelected = state.selectionManager.isSelected(keyAfter);
}
let isFirst = state.collection.getFirstKey() === id;
return (
<div className={treeCellGrid({isDisabled, isNextSelected, isSelected, isFirst, isNextFocused, isDetached})}>
{selectionMode !== 'none' && selectionBehavior === 'toggle' && (
// TODO: add transition?
<div className={treeCheckbox}>
<Checkbox
isEmphasized={isEmphasized}
slot="selection" />
</div>
)}
<div
className={style({
gridArea: 'level-padding',
width: '[calc(calc(var(--tree-item-level, 0) - 1) * var(--indent))]'
})} />
{/* TODO: revisit when we do async loading, at the moment hasChildItems will only cause the chevron to be rendered, no aria/data attributes indicating the row's expandability are added */}
{(hasChildRows || hasChildItems) && <ExpandableRowChevron isDisabled={isDisabled} isExpanded={isExpanded} />}
<Provider
values={[
[TextContext, {styles: treeContent}],
[IconContext, {
render: centerBaseline({slot: 'icon', styles: treeIcon}),
styles: style({size: fontRelative(20), flexShrink: 0})
}],
[ActionButtonGroupContext, {styles: treeActions}],
[ActionMenuContext, {styles: treeActionMenu, isQuiet: true, 'aria-label': 'Actions'}]
]}>
{content}
</Provider>
{isFocusVisible && isDetached && <div role="presentation" className={style({...cellFocus, position: 'absolute', inset: 0})({isFocusVisible: true})} />}
</div>
);
}}
</UNSTABLE_TreeItemContent>
{nestedRows}
</UNSTABLE_TreeItem>
<TreeItemContext.Provider value={{hasChildItems: !!props.childItems}}>
<UNSTABLE_TreeItem
{...props}
className={(renderProps) => treeRow({
...renderProps,
isLink: !!href, isEmphasized
}) + (renderProps.isFocusVisible && !isDetached ? ' ' + treeRowFocusIndicator : '')} />
</TreeItemContext.Provider>
);
};

export const TreeItemContent = (props: Omit<TreeItemContentProps, 'children'> & {children: ReactNode}) => {
let {
children
} = props;
let {isDetached, isEmphasized} = useContext(InternalTreeContext);
let {hasChildItems} = useContext(TreeItemContext);

return (
<UNSTABLE_TreeItemContent>
{({isExpanded, hasChildRows, selectionMode, selectionBehavior, isDisabled, isFocusVisible, isSelected, id, state}) => {
let isNextSelected = false;
let isNextFocused = false;
let keyAfter = state.collection.getKeyAfter(id);
if (keyAfter != null) {
isNextSelected = state.selectionManager.isSelected(keyAfter);
}
let isFirst = state.collection.getFirstKey() === id;
return (
<div className={treeCellGrid({isDisabled, isNextSelected, isSelected, isFirst, isNextFocused, isDetached})}>
{selectionMode !== 'none' && selectionBehavior === 'toggle' && (
// TODO: add transition?
<div className={treeCheckbox}>
<Checkbox
isEmphasized={isEmphasized}
slot="selection" />
</div>
)}
<div
className={style({
gridArea: 'level-padding',
width: '[calc(calc(var(--tree-item-level, 0) - 1) * var(--indent))]'
})} />
{/* TODO: revisit when we do async loading, at the moment hasChildItems will only cause the chevron to be rendered, no aria/data attributes indicating the row's expandability are added */}
{(hasChildRows || hasChildItems) && <ExpandableRowChevron isDisabled={isDisabled} isExpanded={isExpanded} />}
<Provider
values={[
[TextContext, {styles: treeContent}],
[IconContext, {
render: centerBaseline({slot: 'icon', styles: treeIcon}),
styles: style({size: fontRelative(20), flexShrink: 0})
}],
[ActionButtonGroupContext, {styles: treeActions}],
[ActionMenuContext, {styles: treeActionMenu, isQuiet: true, 'aria-label': 'Actions'}],
[TreeItemContext, {}]
]}>
{children}
</Provider>
{isFocusVisible && isDetached && <div role="presentation" className={style({...cellFocus, position: 'absolute', inset: 0})({isFocusVisible: true})} />}
</div>
);
}}
</UNSTABLE_TreeItemContent>
);
};

Expand Down
2 changes: 1 addition & 1 deletion packages/@react-spectrum/s2/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export {TextArea, TextField, TextAreaContext, TextFieldContext} from './TextFiel
export {ToggleButton, ToggleButtonContext} from './ToggleButton';
export {ToggleButtonGroup, ToggleButtonGroupContext} from './ToggleButtonGroup';
export {Tooltip, TooltipTrigger} from './Tooltip';
export {TreeView, TreeViewItem} from './TreeView';
export {TreeView, TreeViewItem, TreeItemContent} from './TreeView';

export {pressScale} from './pressScale';

Expand Down
Loading
Loading