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

Call onCellEditComplete callback on cell edit completion in tree table, document issue w… #7636

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

Call onCellEditComplete callback on cell edit completion in tree table, document issue w… #7636

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
8bc7ecc
Call callback on cell edit completion in tree table, document issue w…
MBelniak Jan 22, 2025
778460f
Return new state
MBelniak Jan 22, 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
7 changes: 7 additions & 0 deletions components/doc/common/apidoc/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12702,6 +12702,13 @@
"readonly": false,
"type": "any",
"description": "New value of the element."
},
{
"name": "props",
"optional": false,
"readonly": true,
"type": "any",
"description": "All props received by cell component."
}
]
},
Expand Down
146 changes: 89 additions & 57 deletions components/doc/datatable/edit/celleditdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,33 @@ export function CellEditDoc(props) {
};

const onCellEditComplete = (e) => {
let { rowData, newValue, field, originalEvent: event } = e;

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) {
rowData[field] = newValue;
} else {
event.preventDefault();
}

break;

default:
if (newValue.trim().length > 0) {
rowData[field] = newValue;
} else {
event.preventDefault();
}

break;
}
setProducts((products) => {
let { rowData, newValue, field, originalEvent: event } = e;
let newProducts = JSON.parse(JSON.stringify(products));

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;

default:
if (newValue.trim().length > 0) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;
}

return newProducts;
});
};

const cellEditor = (options) => {
Expand All @@ -71,11 +76,11 @@ export function CellEditDoc(props) {
};

const textEditor = (options) => {
return <InputText type="text" value={options.value} onChange={(e) => options.editorCallback(e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.value} onChange={(e) => options.editorCallback(e.target.value)} />;
};

const priceEditor = (options) => {
return <InputNumber value={options.value} onValueChange={(e) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" onKeyDown={(e) => e.stopPropagation()} />;
return <InputNumber value={options.value} onValueChange={(e) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" />;
};

const priceBodyTemplate = (rowData) => {
Expand Down Expand Up @@ -130,20 +135,33 @@ export default function CellEditingDemo() {
};

const onCellEditComplete = (e) => {
let { rowData, newValue, field, originalEvent: event } = e;

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) rowData[field] = newValue;
else event.preventDefault();
break;

default:
if (newValue.trim().length > 0) rowData[field] = newValue;
else event.preventDefault();
break;
}
setProducts((products) => {
let { rowData, newValue, field, originalEvent: event } = e;
let newProducts = JSON.parse(JSON.stringify(products));

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;

default:
if (newValue.trim().length > 0) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;
}

return newProducts;
});
};

const cellEditor = (options) => {
Expand All @@ -152,11 +170,11 @@ export default function CellEditingDemo() {
};

const textEditor = (options) => {
return <InputText type="text" value={options.value} onChange={(e) => options.editorCallback(e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.value} onChange={(e) => options.editorCallback(e.target.value)} />;
};

const priceEditor = (options) => {
return <InputNumber value={options.value} onValueChange={(e) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" onKeyDown={(e) => e.stopPropagation()} />;
return <InputNumber value={options.value} onValueChange={(e) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" />;
};

const priceBodyTemplate = (rowData) => {
Expand Down Expand Up @@ -230,20 +248,33 @@ export default function CellEditingDemo() {
};

const onCellEditComplete = (e: ColumnEvent) => {
let { rowData, newValue, field, originalEvent: event } = e;

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) rowData[field] = newValue;
else event.preventDefault();
break;

default:
if (newValue.trim().length > 0) rowData[field] = newValue;
else event.preventDefault();
break;
}
setProducts((products) => {
let { rowData, newValue, field, originalEvent: event } = e;
let newProducts = JSON.parse(JSON.stringify(products));

switch (field) {
case 'quantity':
case 'price':
if (isPositiveInteger(newValue)) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;

default:
if (newValue.trim().length > 0) {
newProducts.find((row) => row.id === rowData.id)[field] = newValue;
} else {
event.preventDefault();
}

break;
}

return newProducts;
});
};

const cellEditor = (options: ColumnEditorOptions) => {
Expand All @@ -252,11 +283,11 @@ export default function CellEditingDemo() {
};

const textEditor = (options: ColumnEditorOptions) => {
return <InputText type="text" value={options.value} onChange={(e: React.ChangeEvent<HTMLInputElement>) => options.editorCallback(e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.value} onChange={(e: React.ChangeEvent<HTMLInputElement>) => options.editorCallback(e.target.value)} />;
};

const priceEditor = (options: ColumnEditorOptions) => {
return <InputNumber value={options.value} onValueChange={(e: InputNumberValueChangeEvent) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" onKeyDown={(e) => e.stopPropagation()} />;
return <InputNumber value={options.value} onValueChange={(e: InputNumberValueChangeEvent) => options.editorCallback(e.value)} mode="currency" currency="USD" locale="en-US" />;
};

const priceBodyTemplate = (rowData: Product) => {
Expand Down Expand Up @@ -295,7 +326,8 @@ export default function CellEditingDemo() {
<>
<DocSectionText {...props}>
<p>
Cell editing is enabled by setting <i>editMode</i> as <i>cell</i>, defining input elements with <i>editor</i> property of a Column and implementing <i>onCellEditComplete</i> to update the state.
Cell editing is enabled by setting <i>editMode</i> as <i>cell</i>, defining input elements with <i>editor</i> property of a Column and implementing <i>onCellEditComplete</i> to update the state. When updating the state from
React's useState hook, use a callback format to always work on the up-to-date state.
</p>
</DocSectionText>
<DeferredDemo onLoad={loadDemoData}>
Expand Down
64 changes: 34 additions & 30 deletions components/doc/treetable/editdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ export function EditDoc(props) {
NodeService.getTreeTableNodes().then((data) => setNodes(data));
}, []); // eslint-disable-line react-hooks/exhaustive-deps

const onEditorValueChange = (options, value) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, options.node.key);
const onEditComplete = (event) => {
setNodes((nodes) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, event.props.node.key);

editedNode.data[options.field] = value;
editedNode.data[event.field] = event.newValue;

setNodes(newNodes);
return newNodes;
});
};

const findNodeByKey = (nodes, key) => {
Expand All @@ -37,7 +39,7 @@ export function EditDoc(props) {
};

const inputTextEditor = (options) => {
return <InputText type="text" value={options.rowData[options.field]} onChange={(e) => onEditorValueChange(options, e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.rowData[options.field]} onChange={(event) => options.editorCallback(event.target.value)} />;
};

const sizeEditor = (options) => {
Expand All @@ -49,8 +51,7 @@ export function EditDoc(props) {
};

const requiredValidator = (e) => {
let props = e.columnProps;
let value = props.node.data[props.field];
let value = e.newValue;

return value && value.length > 0;
};
Expand All @@ -77,13 +78,14 @@ export default function EditDemo() {
NodeService.getTreeTableNodes().then((data) => setNodes(data));
}, []);

const onEditorValueChange = (options, value) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, options.node.key);

editedNode.data[options.field] = value;
const onEditComplete = (event) => {
setNodes((nodes) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, event.props.node.key);

setNodes(newNodes);
editedNode.data[event.field] = event.newValue;
return newNodes;
});
};

const findNodeByKey = (nodes, key) => {
Expand All @@ -101,7 +103,7 @@ export default function EditDemo() {
};

const inputTextEditor = (options) => {
return <InputText type="text" value={options.rowData[options.field]} onChange={(e) => onEditorValueChange(options, e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.rowData[options.field]} onChange={(event) => options.editorCallback(event.target.value)} />;
};

const sizeEditor = (options) => {
Expand All @@ -123,8 +125,8 @@ export default function EditDemo() {
<div className="card">
<TreeTable value={nodes} tableStyle={{ minWidth: '50rem' }}>
<Column field="name" header="Name" expander style={{ height: '3.5rem' }}></Column>
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} style={{ height: '3.5rem' }}></Column>
<Column field="type" header="Type" editor={typeEditor} style={{ height: '3.5rem' }}></Column>
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} onCellEditComplete={onEditComplete} style={{ height: '3.5rem' }}></Column>
<Column field="type" header="Type" editor={typeEditor} onCellEditComplete={onEditComplete} style={{ height: '3.5rem' }}></Column>
</TreeTable>
</div>
);
Expand All @@ -145,13 +147,14 @@ export default function EditDemo() {
NodeService.getTreeTableNodes().then((data) => setNodes(data));
}, []);

const onEditorValueChange = (options: ColumnEditorOptions, value: string) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, options.node.key);
const onEditComplete = (event) => {
setNodes((nodes) => {
let newNodes = JSON.parse(JSON.stringify(nodes));
let editedNode = findNodeByKey(newNodes, event.props.node.key);

editedNode.data[options.field] = value;

setNodes(newNodes);
editedNode.data[event.field] = event.newValue;
return newNodes;
});
};

const findNodeByKey = (nodes: TreeNode[], key: string) => {
Expand All @@ -169,7 +172,7 @@ export default function EditDemo() {
};

const inputTextEditor = (options: ColumnEditorOptions) => {
return <InputText type="text" value={options.rowData[options.field]} onChange={(e: React.ChangeEvent<HTMLInputElement>) => onEditorValueChange(options, e.target.value)} onKeyDown={(e) => e.stopPropagation()} />;
return <InputText type="text" value={options.rowData[options.field]} onChange={(event) => options.editorCallback(event.target.value)} />;
};

const sizeEditor = (options: ColumnEditorOptions) => {
Expand All @@ -181,7 +184,7 @@ export default function EditDemo() {
};

const requiredValidator = (e: ColumnEvent) => {
let props = e.columnProps;
let props = e.props;
let value = props.node.data[props.field];

return value && value.length > 0;
Expand All @@ -191,8 +194,8 @@ export default function EditDemo() {
<div className="card">
<TreeTable value={nodes} tableStyle={{ minWidth: '50rem' }}>
<Column field="name" header="Name" expander style={{ height: '3.5rem' }}></Column>
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} style={{ height: '3.5rem' }}></Column>
<Column field="type" header="Type" editor={typeEditor} style={{ height: '3.5rem' }}></Column>
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} onCellEditComplete={onEditComplete} style={{ height: '3.5rem' }}></Column>
<Column field="type" header="Type" editor={typeEditor} onCellEditComplete={onEditComplete} style={{ height: '3.5rem' }}></Column>
</TreeTable>
</div>
);
Expand Down Expand Up @@ -267,14 +270,15 @@ export default function EditDemo() {
<>
<DocSectionText {...props}>
<p>
Incell editing is enabled by defining input elements with <i>editor</i> property of a Column.
Incell editing is enabled by defining input elements with <i>editor</i> property of a Column and implementing <i>onCellEditComplete</i> to update the state. When updating the state from React's useState hook, use a callback format
to always work on the up-to-date state.
</p>
</DocSectionText>
<div className="card">
<TreeTable value={nodes} tableStyle={{ minWidth: '50rem' }}>
<Column field="name" header="Name" expander style={{ height: '3.5rem' }} />
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} style={{ height: '3.5rem' }} />
<Column field="type" header="Type" editor={typeEditor} style={{ height: '3.5rem' }} />
<Column field="size" header="Size" editor={sizeEditor} cellEditValidator={requiredValidator} onCellEditComplete={onEditComplete} style={{ height: '3.5rem' }} />
<Column field="type" header="Type" editor={typeEditor} style={{ height: '3.5rem' }} onCellEditComplete={onEditComplete} />
</TreeTable>
</div>
<DocSectionCode code={code} service={['NodeService']} />
Expand Down
Loading
Loading