Revision: be96b0a181

doc: custom columns for MultiSelectDialog https://github.com/frappe/frappe/pull/15738

pruthvi_patel edited on Feb 15, 2022, 2:43:18 PM

@@ -288,6 +288,7 @@
 - `date_field`: It is necessary to pass the `date_field` of the DocType in consideration.
 - `get_query`: A function that returns `query` and `filters` to query the selection list. A custom server side method can be passed via `query`, and `filters` will be passed to that method.
 - `action`: Contains the primary action to be performed on the selected options. It takes `selections` as a parameter, which comprises of the selected options.
+- `columns`: An array of fields returned by custom query which will become columns in result datatable. Only works with the custom query (`get_query` argument returning a `query`).
 
 Let us assume we want to fetch  Material Requests into our dialog. We can then go on to invoke the MultiSelectDialog in the following manner:
 
@@ -326,6 +327,7 @@
  },
  add_filters_group: 1,
  date_field: "transaction_date",
+ columns: ["name", "transaction_date", "status"],
  get_query() {
  return query_args;
  },
@@ -357,7 +359,7 @@
  add_filters_group: 1,
  date_field: "transaction_date",
  allow_child_item_selection: 1,
- child_fieldname: "items", // child table fieldname, whose records will be shown & can be filtered
+ child_fieldname: "items", // child table fieldname, whose records will be shown & can be filtered
  child_columns: ["item_code", "qty"], // child item columns to be displayed
  get_query() {
  return {
@@ -373,6 +375,6 @@
 ![MultiSelectDialog](/files/dialog-api-multiselectdialog-child-selection.png)
 *frappe.ui.form.MultiSelectDialog*
 
-Here you will see a checkbox **Select Individual Items** to toggle between child item selection & parent selection. Once you toggle it, all the individual Material Requests Items are listed from the all the queried Material Request, you can now filter these items for selection. 
+Here you will see a checkbox **Select Individual Items** to toggle between child item selection & parent selection. Once you toggle it, all the individual Material Requests Items are listed from the all the queried Material Request, you can now filter these items for selection. 
 
 To access the selected children, you can use `args.filtered_children` list which contains selected child item names.