Added the ability to turn on/off row expanders

Author: aschonfeld

docs/CONFIGURATION.md

@@ -25,6 +25,7 @@ lock_header_menu = False
 hide_header_menu = False
 hide_main_menu = False
 hide_column_menus = False
+hide_row_expanders = False
 enable_custom_filters = False
 enable_web_uploads = False
 

dtale/__init__.py

@@ -22,6 +22,7 @@
     HIDE_HEADER_MENU = False
     HIDE_MAIN_MENU = False
     HIDE_COLUMN_MENUS = False
+    HIDE_ROW_EXPANDERS = False
     ENABLE_CUSTOM_FILTERS = False
     ENABLE_WEB_UPLOADS = False
 

dtale/app.py

@@ -722,6 +722,8 @@ def show(data=None, data_loader=None, name=None, context_vars=None, **options):
     :param hide_column_menus: If true, this will hide the column menus from the screen
     :type hide_column_menus: bool, optional
     :param column_edit_options: The options to allow on the front-end when editing a cell for the columns specified
+    :param hide_row_expanders: If true, this will hide the row expanders from the screen
+    :type hide_row_expanders: bool, optional
     :type column_edit_options: dict, optional
     :param auto_hide_empty_columns: if True, then auto-hide any columns on the front-end that are comprised entirely of
                                     NaN values
@@ -830,6 +832,7 @@ def show(data=None, data_loader=None, name=None, context_vars=None, **options):
             hide_header_menu=final_options.get("hide_header_menu"),
             hide_main_menu=final_options.get("hide_main_menu"),
             hide_column_menus=final_options.get("hide_column_menus"),
+            hide_row_expanders=final_options.get("hide_row_expanders"),
             enable_custom_filters=final_options.get("enable_custom_filters"),
             enable_web_uploads=final_options.get("enable_web_uploads"),
             main_title=final_options.get("main_title"),

dtale/config.py

@@ -96,6 +96,13 @@ def load_app_settings(config):
         section="app",
         getter="getboolean",
     )
+    hide_row_expanders = get_config_val(
+        config,
+        curr_app_settings,
+        "hide_row_expanders",
+        section="app",
+        getter="getboolean",
+    )
     lock_header_menu = get_config_val(
         config,
         curr_app_settings,
@@ -155,6 +162,7 @@ def load_app_settings(config):
             hide_header_menu=hide_header_menu,
             hide_main_menu=hide_main_menu,
             hide_column_menus=hide_column_menus,
+            hide_row_expanders=hide_row_expanders,
             enable_custom_filters=enable_custom_filters,
             enable_web_uploads=enable_web_uploads,
         )
@@ -226,6 +234,7 @@ def build_show_options(options=None):
         hide_header_menu=None,
         hide_main_menu=None,
         hide_column_menus=None,
+        hide_row_expanders=None,
         enable_custom_filters=None,
         enable_web_uploads=None,
         main_title=None,

dtale/global_state.py

@@ -34,6 +34,7 @@
     "hide_column_menus": False,
     "enable_custom_filters": False,
     "enable_web_uploads": False,
+    "hide_row_expanders": False,
 }
 
 AUTH_SETTINGS = {"active": False, "username": None, "password": None}
@@ -612,6 +613,8 @@ def set_app_settings(settings):
         instance_updates["hide_main_menu"] = settings.get("hide_main_menu")
     if settings.get("hide_column_menus") is not None:
         instance_updates["hide_column_menus"] = settings.get("hide_column_menus")
+    if settings.get("hide_row_expanders") is not None:
+        instance_updates["hide_row_expanders"] = settings.get("hide_row_expanders")
     if settings.get("enable_custom_filters") is not None:
         instance_updates["enable_custom_filters"] = settings.get(
             "enable_custom_filters"

dtale/templates/dtale/base.html

@@ -44,6 +44,7 @@
         <input type="hidden" id="hide_header_menu" value="{{hide_header_menu}}" />
         <input type="hidden" id="hide_main_menu" value="{{hide_main_menu}}" />
         <input type="hidden" id="hide_column_menus" value="{{hide_column_menus}}" />
+        <input type="hidden" id="hide_row_expanders" value="{{hide_row_expanders}}" />
         <input type="hidden" id="enable_custom_filters" value="{{enable_custom_filters}}" />
         <input type="hidden" id="enable_web_uploads" value="{{enable_web_uploads}}" />
         <input type="hidden" id="allow_cell_edits" value="{{allow_cell_edits}}" />

dtale/views.py

@@ -366,6 +366,7 @@ def update_settings(self, **updates):
         * hide_header_menu - if true, this will hide the header menu from the screen
         * hide_main_menu - if true, this will hide the main menu from the screen
         * hide_column_menus - if true, this will hide the column menus from the screen
+        * hide_row_expanders - if true, this will hide row expanders from the screen
         * enable_custom_filters - if True, allow users to specify custom filters from the UI using pandas.query strings
         * enable_web_uploads - if True, allow users to upload files using URLs from the UI
 
@@ -938,6 +939,7 @@ def startup(
     hide_header_menu=None,
     hide_main_menu=None,
     hide_column_menus=None,
+    hide_row_expanders=None,
     enable_custom_filters=None,
     enable_web_uploads=None,
     force_save=True,
@@ -1069,6 +1071,7 @@ def startup(
             hide_header_menu=hide_header_menu,
             hide_main_menu=hide_main_menu,
             hide_column_menus=hide_column_menus,
+            hide_row_expanders=hide_row_expanders,
             enable_custom_filters=enable_custom_filters,
             enable_web_uploads=enable_web_uploads,
             main_title=main_title,
@@ -1144,6 +1147,7 @@ def startup(
                 hide_header_menu=hide_header_menu,
                 hide_main_menu=hide_main_menu,
                 hide_column_menus=hide_column_menus,
+                hide_row_expanders=hide_row_expanders,
                 enable_custom_filters=enable_custom_filters,
                 enable_web_uploads=enable_web_uploads,
                 main_title=main_title,
@@ -1215,6 +1219,8 @@ def startup(
             base_settings["hide_main_menu"] = hide_main_menu
         if hide_column_menus is not None:
             base_settings["hide_column_menus"] = hide_column_menus
+        if hide_row_expanders is not None:
+            base_settings["hide_row_expanders"] = hide_row_expanders
         if enable_custom_filters is not None:
             base_settings["enable_custom_filters"] = enable_custom_filters
         if enable_web_uploads is not None:
@@ -1317,6 +1323,7 @@ def base_render_template(template, data_id, **kwargs):
     hide_header_menu = global_state.load_flag(data_id, "hide_header_menu", False)
     hide_main_menu = global_state.load_flag(data_id, "hide_main_menu", False)
     hide_column_menus = global_state.load_flag(data_id, "hide_column_menus", False)
+    hide_row_expanders = global_state.load_flag(data_id, "hide_row_expanders", False)
     main_title = global_state.load_flag(data_id, "main_title", None)
     main_title_font = global_state.load_flag(data_id, "main_title_font", None)
     enable_custom_filters = global_state.load_flag(
@@ -1331,6 +1338,7 @@ def base_render_template(template, data_id, **kwargs):
         hide_header_menu=hide_header_menu,
         hide_main_menu=hide_main_menu,
         hide_column_menus=hide_column_menus,
+        hide_row_expanders=hide_row_expanders,
         enable_custom_filters=enable_custom_filters,
         enable_web_uploads=enable_web_uploads,
         github_fork=github_fork,

frontend/static/__tests__/dtale/menu/HideRowExpanders-test.tsx

@@ -0,0 +1,66 @@
+import { act, fireEvent, render } from '@testing-library/react';
+import * as React from 'react';
+import { Provider } from 'react-redux';
+import { Store } from 'redux';
+
+import HideRowExpanders from '../../../dtale/menu/HideRowExpanders';
+import * as serverState from '../../../dtale/serverStateManagement';
+import reduxUtils from '../../redux-test-utils';
+import { buildInnerHTML } from '../../test-utils';
+
+describe('HideRowExpanders tests', () => {
+  let result: Element;
+  let store: Store;
+  let updateSettingsSpy: jest.SpyInstance;
+
+  const setupOption = async (settings = ''): Promise<void> => {
+    store = reduxUtils.createDtaleStore();
+    buildInnerHTML({ settings }, store);
+    result = await act(() => {
+      return render(
+        <Provider store={store}>
+          <HideRowExpanders />,
+        </Provider>,
+        {
+          container: document.getElementById('content') ?? undefined,
+        },
+      ).container;
+    });
+  };
+
+  beforeEach(() => {
+    updateSettingsSpy = jest.spyOn(serverState, 'updateSettings');
+    updateSettingsSpy.mockImplementation(() => undefined);
+  });
+
+  afterEach(jest.resetAllMocks);
+
+  afterAll(jest.restoreAllMocks);
+
+  it('renders successfully with defaults', async () => {
+    await setupOption();
+    expect(result.getElementsByClassName('ico-check-box-outline-blank')).toHaveLength(1);
+  });
+
+  it('renders successfully with specified value', async () => {
+    await setupOption('{&quot;hide_row_expanders&quot;:&quot;True&quot;}');
+    expect(result.getElementsByClassName('ico-check-box')).toHaveLength(1);
+  });
+
+  it('handles changes to checkbox', async () => {
+    await setupOption();
+    await act(async () => {
+      await fireEvent.click(result.getElementsByClassName('ico-check-box-outline-blank')[0]);
+    });
+    expect(updateSettingsSpy).toBeCalledTimes(1);
+    expect(store.getState().settings).toEqual(expect.objectContaining({ hide_row_expanders: true }));
+    await act(async () => {
+      await fireEvent.click(result.getElementsByClassName('ico-check-box')[0]);
+    });
+    expect(updateSettingsSpy).toBeCalledTimes(2);
+    expect(updateSettingsSpy.mock.calls[1][0]).toEqual({
+      hide_row_expanders: false,
+    });
+    expect(store.getState().settings).toEqual(expect.objectContaining({ hide_row_expanders: false }));
+  });
+});

frontend/static/__tests__/dtale/reduxGridUtils-test.ts

@@ -23,6 +23,7 @@ describe('reduxGridUtils', () => {
       hide_header_menu: false,
       hide_main_menu: false,
       hide_column_menus: false,
+      hide_row_expanders: false,
       enable_custom_filters: false,
     };
     reduxUtils.handleReduxState(

frontend/static/__tests__/reducers/dtale-test.tsx

@@ -28,6 +28,7 @@ describe('reducer tests', () => {
       hideHeaderMenu: false,
       hideMainMenu: false,
       hideColumnMenus: false,
+      hideRowExpanders: false,
       enableCustomFilters: false,
       enableWebUploads: false,
       hideDropRows: false,
@@ -54,6 +55,7 @@ describe('reducer tests', () => {
         hide_header_menu: false,
         hide_main_menu: false,
         hide_column_menus: false,
+        hide_row_expanders: false,
         enable_custom_filters: false,
       },
       pythonVersion: null,