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

Fix in controlled mode to ignore any id that not in data #207

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Fix in controlled mode to ignore any id that not in data #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9e72dc
ignore id in controlled mode to not error
yhy-1 Jan 15, 2025
2427769
revert test changes by mistake
yhy-1 Jan 15, 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
307 changes: 155 additions & 152 deletions src/TreeView/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import {
getOnSelectTreeAction,
getBranchNodesToExpand,
IFlatMetadata,
isNode,
} from "./utils";
import { Node } from "./node";
import {
Expand Down Expand Up @@ -267,15 +268,17 @@ const useTree = ({
multiSelect,
});
for (const id of controlledSelectedIds) {
propagateSelect &&
!disabledIds.has(id) &&
dispatch({
type: treeTypes.changeSelectMany,
ids: propagatedIds(data, [id], disabledIds),
select: true,
multiSelect,
lastInteractedWith: id,
});
if (isNode(data, id)) {
propagateSelect &&
!disabledIds.has(id) &&
dispatch({
type: treeTypes.changeSelectMany,
ids: propagatedIds(data, [id], disabledIds),
select: true,
multiSelect,
lastInteractedWith: id,
});
}
}
}
}, [controlledSelectedIds]);
Expand All @@ -295,33 +298,37 @@ const useTree = ({
//controlled collapsing
if (diffCollapseIds.size) {
for (const id of diffCollapseIds) {
if (isBranchNode(data, id) || getTreeNode(data, id).isBranch) {
const ids = [id, ...getDescendants(data, id, new Set<number>())];
dispatch({
type: treeTypes.collapseMany,
ids: ids,
lastInteractedWith: id,
});
if (isNode(data, id)) {
if (isBranchNode(data, id) || getTreeNode(data, id).isBranch) {
const ids = [id, ...getDescendants(data, id, new Set<number>())];
dispatch({
type: treeTypes.collapseMany,
ids: ids,
lastInteractedWith: id,
});
}
}
}
}
//controlled expanding
if (diffExpandedIds.size) {
for (const id of diffExpandedIds) {
if (isBranchNode(data, id) || getTreeNode(data, id).isBranch) {
const parentId = getParent(data, id);
if (parentId) {
dispatch({
type: treeTypes.expandMany,
ids: [id, parentId],
lastInteractedWith: id,
});
} else {
dispatch({
type: treeTypes.expand,
id: id,
lastInteractedWith: id,
});
if (isNode(data, id)) {
if (isBranchNode(data, id) || getTreeNode(data, id).isBranch) {
const parentId = getParent(data, id);
if (parentId) {
dispatch({
type: treeTypes.expandMany,
ids: [id, parentId],
lastInteractedWith: id,
});
} else {
dispatch({
type: treeTypes.expand,
id: id,
lastInteractedWith: id,
});
}
}
}
}
Expand Down Expand Up @@ -554,128 +561,125 @@ export interface ITreeViewProps<M extends IFlatMetadata = IFlatMetadata> {
focusedId?: NodeId;
}

const TreeView = React.forwardRef(
function TreeView<M extends IFlatMetadata = IFlatMetadata>(
{
data,
selectedIds,
nodeRenderer,
onSelect = noop,
onNodeSelect = noop,
onExpand = noop,
onLoadData,
className = "",
multiSelect = false,
propagateSelect = false,
propagateSelectUpwards = false,
propagateCollapse = false,
expandOnKeyboardSelect = false,
togglableSelect = false,
defaultExpandedIds = [],
defaultSelectedIds = [],
defaultDisabledIds = [],
clickAction = clickActions.select,
nodeAction = "select",
expandedIds,
focusedId,
onBlur,
...other
}: ITreeViewProps<M>,
ref: React.ForwardedRef<HTMLUListElement>
) {
validateTreeViewData(data);
const nodeRefs = useRef({});
const leafRefs = useRef({});
let innerRef = useRef<HTMLUListElement | null>(null);
if (ref != null) {
innerRef = ref as React.MutableRefObject<HTMLUListElement>;
}
const [state, dispatch] = useTree({
data,
controlledSelectedIds: selectedIds,
controlledExpandedIds: expandedIds,
defaultExpandedIds,
defaultSelectedIds,
defaultDisabledIds,
nodeRefs,
leafRefs,
onSelect,
onNodeSelect,
onExpand,
onLoadData,
togglableSelect,
multiSelect,
propagateSelect,
propagateSelectUpwards,
treeRef: innerRef,
focusedId,
});
propagateSelect = propagateSelect && multiSelect;

return (
<ul
className={cx(baseClassNames.root, className)}
role="tree"
aria-multiselectable={nodeAction === "select" ? multiSelect : undefined}
ref={innerRef}
onBlur={(event) => {
onComponentBlur(event, innerRef.current, () => {
onBlur &&
onBlur({
treeState: state,
dispatch,
});
dispatch({ type: treeTypes.blur });
});
}}
onKeyDown={handleKeyDown({
data,
tabbableId: state.tabbableId,
expandedIds: state.expandedIds,
selectedIds: state.selectedIds,
disabledIds: state.disabledIds,
halfSelectedIds: state.halfSelectedIds,
clickAction,
dispatch,
propagateCollapse,
propagateSelect,
multiSelect,
expandOnKeyboardSelect,
togglableSelect,
})}
{...other}
>
{getTreeParent(data).children.map((x, index) => (
<Node
key={`${x}-${typeof x}`}
data={data}
element={getTreeNode(data, x) as INode<M>}
setsize={getTreeParent(data).children.length}
posinset={index + 1}
level={1}
{...state}
state={state}
dispatch={dispatch}
nodeRefs={nodeRefs}
leafRefs={leafRefs}
baseClassNames={baseClassNames}
nodeRenderer={nodeRenderer}
propagateCollapse={propagateCollapse}
propagateSelect={propagateSelect}
propagateSelectUpwards={propagateSelectUpwards}
multiSelect={multiSelect}
togglableSelect={togglableSelect}
clickAction={clickAction}
nodeAction={nodeAction}
/>
))}
</ul>
)
})



const TreeView = React.forwardRef(function TreeView<
M extends IFlatMetadata = IFlatMetadata
>(
{
data,
selectedIds,
nodeRenderer,
onSelect = noop,
onNodeSelect = noop,
onExpand = noop,
onLoadData,
className = "",
multiSelect = false,
propagateSelect = false,
propagateSelectUpwards = false,
propagateCollapse = false,
expandOnKeyboardSelect = false,
togglableSelect = false,
defaultExpandedIds = [],
defaultSelectedIds = [],
defaultDisabledIds = [],
clickAction = clickActions.select,
nodeAction = "select",
expandedIds,
focusedId,
onBlur,
...other
}: ITreeViewProps<M>,
ref: React.ForwardedRef<HTMLUListElement>
) {
validateTreeViewData(data);
const nodeRefs = useRef({});
const leafRefs = useRef({});
let innerRef = useRef<HTMLUListElement | null>(null);
if (ref != null) {
innerRef = ref as React.MutableRefObject<HTMLUListElement>;
}
const [state, dispatch] = useTree({
data,
controlledSelectedIds: selectedIds,
controlledExpandedIds: expandedIds,
defaultExpandedIds,
defaultSelectedIds,
defaultDisabledIds,
nodeRefs,
leafRefs,
onSelect,
onNodeSelect,
onExpand,
onLoadData,
togglableSelect,
multiSelect,
propagateSelect,
propagateSelectUpwards,
treeRef: innerRef,
focusedId,
});
propagateSelect = propagateSelect && multiSelect;

return (
<ul
className={cx(baseClassNames.root, className)}
role="tree"
aria-multiselectable={nodeAction === "select" ? multiSelect : undefined}
ref={innerRef}
onBlur={(event) => {
onComponentBlur(event, innerRef.current, () => {
onBlur &&
onBlur({
treeState: state,
dispatch,
});
dispatch({ type: treeTypes.blur });
});
}}
onKeyDown={handleKeyDown({
data,
tabbableId: state.tabbableId,
expandedIds: state.expandedIds,
selectedIds: state.selectedIds,
disabledIds: state.disabledIds,
halfSelectedIds: state.halfSelectedIds,
clickAction,
dispatch,
propagateCollapse,
propagateSelect,
multiSelect,
expandOnKeyboardSelect,
togglableSelect,
})}
{...other}
>
{getTreeParent(data).children.map((x, index) => (
<Node
key={`${x}-${typeof x}`}
data={data}
element={getTreeNode(data, x) as INode<M>}
setsize={getTreeParent(data).children.length}
posinset={index + 1}
level={1}
{...state}
state={state}
dispatch={dispatch}
nodeRefs={nodeRefs}
leafRefs={leafRefs}
baseClassNames={baseClassNames}
nodeRenderer={nodeRenderer}
propagateCollapse={propagateCollapse}
propagateSelect={propagateSelect}
propagateSelectUpwards={propagateSelectUpwards}
multiSelect={multiSelect}
togglableSelect={togglableSelect}
clickAction={clickAction}
nodeAction={nodeAction}
/>
))}
</ul>
);
});

const handleKeyDown = ({
data,
Expand Down Expand Up @@ -979,7 +983,6 @@ const handleKeyDown = ({
}
};


TreeView.propTypes = {
/** Tree data*/
data: PropTypes.array.isRequired,
Expand Down
13 changes: 11 additions & 2 deletions src/TreeView/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ export const isBranchNode = (data: INode[], i: NodeId) => {
return !!node.children?.length;
};

export const isNode = (data: INode[], id: NodeId) => {
return data.find((node) => node.id === id);
};

export const getBranchNodesToExpand = (data: INode[], id: NodeId): NodeId[] => {
const parentId = getParent(data, id);
const isNodeExpandable =
Expand Down Expand Up @@ -515,7 +519,9 @@ export const getOnSelectTreeAction = (
return treeTypes.toggleSelect;
};

export const getTreeParent = <M extends IFlatMetadata = IFlatMetadata>(data: INode<M>[]): INode<M> => {
export const getTreeParent = <M extends IFlatMetadata = IFlatMetadata>(
data: INode<M>[]
): INode<M> => {
const parentNode: INode<M> | undefined = data.find(
(node) => node.parent === null
);
Expand All @@ -527,7 +533,10 @@ export const getTreeParent = <M extends IFlatMetadata = IFlatMetadata>(data: INo
return parentNode;
};

export const getTreeNode = <M extends IFlatMetadata = IFlatMetadata>(data: INode<M>[], id: NodeId): INode<M> => {
export const getTreeNode = <M extends IFlatMetadata = IFlatMetadata>(
data: INode<M>[],
id: NodeId
): INode<M> => {
const treeNode = data.find((node) => node.id === id);

if (treeNode == null) {
Expand Down
Loading
Loading