Fix locked behavior

Author: mayagbarnes

README.md

@@ -101,7 +101,7 @@ Returns a `PivotTableResult` dict containing the current `config` state.
 | `on_cell_click` | `Callable[[], None] \| None` | `None` | Called when a user clicks a data cell. Read the payload from `st.session_state[key]`. |
 | `on_config_change` | `Callable[[], None] \| None` | `None` | Called when the user changes the pivot config interactively, including toolbar and header-menu actions. |
 | `enable_drilldown` | `bool` | `True` | Show an inline drill-down panel with source records when a cell is clicked. |
-| `locked` | `bool` | `False` | Viewer mode with exploration enabled. Toolbar config controls and settings toggles are disabled, while header-menu sorting/filtering and drill-down remain available. |
+| `locked` | `bool` | `False` | Viewer mode with exploration enabled. Toolbar config controls are read-only, viewer-safe actions like data export and group expand/collapse remain available, and header-menu sorting/filtering/`Show Values As` plus drill-down still work. |
 | `export_filename` | `str \| None` | `None` | Base filename (without extension) for exported files. Date and extension are appended automatically. Defaults to `"pivot-table"`. |
 
 #### Data Control
@@ -428,7 +428,7 @@ Hover over a parent column header to reveal the collapse toggle.
 
 ### Data Export
 
-Export the pivot table as CSV, TSV, or copy to clipboard. Available via the toolbar utility menu (download icon) when `interactive=True`.
+Export the pivot table as CSV, TSV, or copy to clipboard. Available via the toolbar utility menu (download icon) whenever the interactive toolbar is shown, including locked viewer mode.
 
 - **Format**: CSV, TSV, or Clipboard (tab-separated for pasting into spreadsheets)
 - **Content**: Formatted (display values with currency, percentages, etc.) or Raw (unformatted numbers)
@@ -458,7 +458,7 @@ result = st_pivot_table(
 
 ### Locked Mode
 
-Use `locked=True` for a viewer-mode experience with exploration enabled. Toolbar config controls stay locked so end-users cannot change rows, columns, values, per-measure aggregation, or settings toggles. Reset, Swap, config import/export, and data export are hidden, while the Settings gear remains visible so users can inspect settings and use Expand/Collapse All group controls. Header-menu sorting and filtering remain available, and drill-down still works.
+Use `locked=True` for a viewer-mode experience with exploration enabled. Toolbar config controls stay locked so end-users cannot change rows, columns, values, per-measure aggregation, or settings toggles. Reset, Swap, and config import/export are hidden, while data export remains available and the Settings gear stays visible for read-only display status plus Expand/Collapse All group controls. Header-menu sorting, filtering, and `Show Values As` remain available, and drill-down still works.
 
 ```python
 st_pivot_table(
@@ -484,7 +484,7 @@ When `interactive=True`, hovering over the top-right of the toolbar reveals util
 | **Export Data** | Open the export popover (CSV / TSV / Clipboard). Use `export_filename` to customize the download filename. |
 | **Settings** (gear icon) | Opens a popover with display toggles: Row Totals, Column Totals, Subtotals, Repeat Labels, Sticky Headers, and Expand/Collapse All group controls |
 
-In **locked mode**, Reset, Swap, config import/export, and data export are hidden. The Settings gear remains visible, settings toggles are disabled, group expand/collapse actions remain available, and header-menu sorting and filtering stay enabled.
+In **locked mode**, Reset, Swap, and config import/export are hidden. `Export Data` remains available as a viewer action. The Settings gear remains visible, its popover shows read-only display status plus group expand/collapse actions, and header-menu sorting, filtering, and `Show Values As` stay enabled.
 
 ### Non-Interactive Mode
 

SKILL.md

@@ -111,7 +111,7 @@ Returns a `PivotTableResult` dict containing the current `config` state.
 | `on_cell_click` | `Callable[[], None] \| None` | `None` | Called when a user clicks a data cell. Read the payload from `st.session_state[key]`. See [Cell Click Payload](#cell-click-payload). |
 | `on_config_change` | `Callable[[], None] \| None` | `None` | Called when the user changes the pivot config via the toolbar. |
 | `enable_drilldown` | `bool` | `True` | Show an inline drill-down panel with source records when a cell is clicked. |
-| `locked` | `bool` | `False` | Freeze toolbar config controls (rows/columns/values/aggregation/settings). The entire utility menu is hidden. Sorting and filtering via header menus remain available. |
+| `locked` | `bool` | `False` | Viewer mode with exploration enabled. Toolbar config controls are read-only, while data export, group expand/collapse, and header-menu sorting/filtering/show-values-as remain available. |
 | `export_filename` | `str \| None` | `None` | Base filename (without extension) for exported files. Date and extension are appended automatically. Defaults to `"pivot-table"`. |
 
 #### Data Control
@@ -471,7 +471,7 @@ When `interactive=True`, hovering over the top-right of the toolbar reveals util
 | **Export Data** | Open the export popover (CSV / TSV / Clipboard). Use `export_filename` to customize the download filename. |
 | **Settings** (gear icon) | Opens a popover with display toggles: Row Totals, Column Totals, Subtotals, Repeat Labels, Sticky Headers, and Expand/Collapse All group controls |
 
-In **locked mode**, Reset, Swap, config import/export, and data export are hidden. The Settings gear remains visible, its toggles are disabled, and sorting/filtering via header menus remain available.
+In **locked mode**, Reset, Swap, and config import/export are hidden while data export remains available. The Settings gear remains visible, its popover shows read-only view status plus group expand/collapse actions, and sorting/filtering/show-values-as remain available via header menus.
 
 ---
 

e2e_playwright/pivot_table.py

@@ -125,16 +125,35 @@ def handle_config():
     key="test_pivot_locked",
     rows=["Region"],
     columns=["Year"],
+    values=["Revenue", "Profit"],
+    aggregation={"Revenue": "sum", "Profit": "avg"},
+    locked=True,
+    interactive=True,
+    on_config_change=lambda: None,
+)
+
+
+# ---------------------------------------------------------------------------
+# 4. Locked mode with row groups
+# ---------------------------------------------------------------------------
+st.subheader("Locked Grouped Pivot")
+
+st_pivot_table(
+    df,
+    key="test_pivot_locked_groups",
+    rows=["Region", "Category"],
+    columns=["Year"],
     values=["Revenue"],
     aggregation="sum",
+    show_subtotals=True,
     locked=True,
     interactive=True,
     on_config_change=lambda: None,
 )
 
 
 # ---------------------------------------------------------------------------
-# 4. Conditional formatting -- color scale + data bars
+# 5. Conditional formatting -- color scale + data bars
 # ---------------------------------------------------------------------------
 st.subheader("Conditional Format Pivot")
 
@@ -165,7 +184,23 @@ def handle_config():
 
 
 # ---------------------------------------------------------------------------
-# 5. Number formatting
+# 6. Non-interactive read-only mode
+# ---------------------------------------------------------------------------
+st.subheader("Read Only Pivot")
+
+st_pivot_table(
+    df,
+    key="test_pivot_readonly",
+    rows=["Region"],
+    columns=["Year"],
+    values=["Revenue"],
+    aggregation="sum",
+    interactive=False,
+)
+
+
+# ---------------------------------------------------------------------------
+# 7. Number formatting
 # ---------------------------------------------------------------------------
 st.subheader("Number Format Pivot")
 
@@ -183,7 +218,7 @@ def handle_config():
 
 
 # ---------------------------------------------------------------------------
-# 6. Drilldown
+# 8. Drilldown
 # ---------------------------------------------------------------------------
 st.subheader("Drilldown Pivot")
 

e2e_playwright/pivot_table_test.py

@@ -39,7 +39,9 @@
     "test_pivot",
     "test_pivot_subtotals",
     "test_pivot_locked",
+    "test_pivot_locked_groups",
     "test_pivot_cond_fmt",
+    "test_pivot_readonly",
     "test_pivot_number_fmt",
     "test_pivot_drilldown",
     "test_pivot_empty",
@@ -865,7 +867,7 @@ def test_number_format_currency(page_at_app: Page):
 
 
 def test_locked_mode_toolbar_disabled(page_at_app: Page):
-    """In locked mode, toolbar dropdowns are disabled and config buttons hidden."""
+    """In locked mode, authoring controls are hidden but viewer actions remain."""
     page = page_at_app
     container = get_pivot(page, "test_pivot_locked")
     expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
@@ -880,6 +882,7 @@ def test_locked_mode_toolbar_disabled(page_at_app: Page):
 
     expect(container.get_by_test_id("toolbar-rows-select")).to_have_count(0)
     expect(container.get_by_test_id("toolbar-swap")).to_have_count(0)
+    expect(container.get_by_test_id("toolbar-export-data")).to_be_visible()
     expect(container.get_by_test_id("toolbar-settings")).to_be_visible()
 
 
@@ -903,10 +906,84 @@ def test_locked_mode_header_sort_and_filter_still_work(page_at_app: Page):
     checkboxes = filter_section.locator("input[type=checkbox]")
     assert checkboxes.count() > 0
 
-    menu.get_by_test_id("header-sort-key-desc").click()
+    menu.get_by_test_id("header-sort-key-desc").evaluate("el => el.click()")
     expect(container.get_by_test_id("pivot-row-header").first).to_have_text("West")
 
 
+def test_locked_mode_show_values_as_still_works(page_at_app: Page):
+    """In locked mode, value-header display modes remain available."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_locked")
+    expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
+
+    trigger = container.get_by_test_id("header-menu-trigger-Revenue").first
+    expect(trigger).to_be_visible(timeout=5000)
+    trigger.click()
+
+    display_group = container.get_by_test_id("header-menu-display")
+    expect(display_group).to_be_visible(timeout=5000)
+    container.get_by_test_id("header-display-pct_of_total").click()
+
+    expect(container.get_by_test_id("pivot-data-cell").first).to_contain_text(
+        "%", timeout=10000
+    )
+
+
+def test_locked_mode_export_data_panel_opens(page_at_app: Page):
+    """In locked mode, export remains available as a viewer action."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_locked")
+    expect(container.get_by_test_id("pivot-toolbar")).to_be_visible(timeout=15000)
+
+    button = container.get_by_test_id("toolbar-export-data")
+    button.scroll_into_view_if_needed()
+    button.evaluate("el => el.click()")
+    panel = page.get_by_test_id("toolbar-export-data-panel")
+    expect(panel).to_be_visible(timeout=5000)
+    expect(panel.get_by_test_id("export-format-csv")).to_be_visible()
+    expect(panel.get_by_test_id("export-content-formatted")).to_be_visible()
+
+
+def test_locked_mode_csv_download_content(page_at_app: Page):
+    """Locked mode can complete a CSV export successfully."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_locked")
+    expect(container.get_by_test_id("pivot-toolbar")).to_be_visible(timeout=15000)
+
+    button = container.get_by_test_id("toolbar-export-data")
+    button.scroll_into_view_if_needed()
+    button.evaluate("el => el.click()")
+    panel = page.get_by_test_id("toolbar-export-data-panel")
+    expect(panel).to_be_visible(timeout=5000)
+
+    panel.get_by_test_id("export-format-csv").click()
+    panel.get_by_test_id("export-content-raw").click()
+
+    with page.expect_download() as dl_info:
+        panel.get_by_test_id("toolbar-export-data-action").click()
+
+    download = dl_info.value
+    path = download.path()
+    assert path is not None
+
+    content = Path(path).read_text()
+    assert "Region" in content
+    assert len(content.strip().splitlines()) > 1
+
+
+def test_readonly_mode_hides_toolbar_and_menu_actions(page_at_app: Page):
+    """interactive=False hides the toolbar and removes header-menu config actions."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_readonly")
+    expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
+
+    expect(container.get_by_test_id("pivot-toolbar")).to_have_count(0)
+    expect(container.get_by_test_id("header-menu-trigger-Region")).to_have_count(0)
+
+    container.get_by_test_id("pivot-data-cell").first.click()
+    expect(container.get_by_test_id("drilldown-panel")).to_be_visible(timeout=5000)
+
+
 # =====================================================================
 # 12. Empty / Edge Cases (3 tests)
 # =====================================================================
@@ -958,9 +1035,11 @@ def test_export_data_panel_opens(page_at_app: Page):
     container = get_pivot(page, "test_pivot")
     expect(container.get_by_test_id("pivot-toolbar")).to_be_visible(timeout=15000)
 
-    container.get_by_test_id("toolbar-export-data").click(force=True)
+    button = container.get_by_test_id("toolbar-export-data")
+    button.scroll_into_view_if_needed()
+    button.evaluate("el => el.click()")
 
-    panel = container.get_by_test_id("toolbar-export-data-panel")
+    panel = page.get_by_test_id("toolbar-export-data-panel")
     expect(panel).to_be_visible(timeout=5000)
 
     expect(panel.get_by_test_id("export-format-csv")).to_be_visible()
@@ -1414,16 +1493,60 @@ def test_action_bar_always_visible(page_at_app: Page):
 
 
 def test_locked_mode_gear_visible_and_functional(page_at_app: Page):
-    """In locked mode, the settings gear is visible and opens the popover."""
+    """In locked mode, the settings gear opens a viewer-oriented popover."""
     page = page_at_app
     container = get_pivot(page, "test_pivot_locked")
     expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
 
     expect(container.get_by_test_id("toolbar-settings")).to_be_visible()
 
     open_settings_popover(container)
-    expect(container.get_by_test_id("toolbar-row-totals")).to_be_visible()
-    expect(container.get_by_test_id("toolbar-col-totals")).to_be_visible()
+    expect(container.get_by_test_id("toolbar-row-totals-status")).to_be_visible()
+    expect(container.get_by_test_id("toolbar-col-totals-status")).to_be_visible()
+
+
+def test_locked_mode_group_actions_still_work(page_at_app: Page):
+    """In locked mode, settings popover group actions still collapse/expand rows."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_locked_groups")
+    expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
+
+    button = container.get_by_test_id("toolbar-settings")
+    button.scroll_into_view_if_needed()
+    button.evaluate("el => el.click()")
+    panel = page.get_by_test_id("toolbar-settings-panel")
+    expect(panel).to_be_visible(timeout=5000)
+    panel.get_by_test_id("pivot-group-toggle-expand-all").click()
+
+    data_rows = container.get_by_test_id("pivot-data-row")
+    rows_expanded = data_rows.count()
+    assert rows_expanded > 0
+
+    expect(panel.get_by_test_id("toolbar-subtotals-status")).to_be_visible()
+    panel.get_by_test_id("pivot-group-toggle-collapse-all").click()
+    expect(data_rows).not_to_have_count(rows_expanded, timeout=10000)
+    rows_collapsed = data_rows.count()
+    assert rows_collapsed < rows_expanded
+
+    panel.get_by_test_id("pivot-group-toggle-expand-all").click()
+    expect(data_rows).to_have_count(rows_expanded, timeout=10000)
+
+
+def test_locked_mode_inline_row_dim_toggle_still_works(page_at_app: Page):
+    """Locked mode still allows inline row dimension toggles for group exploration."""
+    page = page_at_app
+    container = get_pivot(page, "test_pivot_locked_groups")
+    expect(container.get_by_test_id("pivot-table")).to_be_visible(timeout=15000)
+
+    rows_before = container.get_by_test_id("pivot-data-row").count()
+    toggle = container.get_by_test_id("pivot-dim-toggle-row-0-region")
+    expect(toggle).to_have_attribute("aria-expanded", "true")
+
+    toggle.click()
+    expect(toggle).to_have_attribute("aria-expanded", "false", timeout=10000)
+
+    rows_after = container.get_by_test_id("pivot-data-row").count()
+    assert rows_after < rows_before
 
 
 # =====================================================================

streamlit_app.py

@@ -166,15 +166,17 @@
 Control which values appear via **header menu filters** or the Python API.
 **Locked mode** freezes the toolbar config controls so end-users cannot change
 rows, columns, values, or per-measure aggregation — but sorting and filtering via header
-menus still work. **Custom sorters** enforce a specific dimension order.
+menus still work, **Show Values As** remains available on value headers, and
+export still stays available as a viewer action. **Custom sorters** enforce a specific dimension order.
 
 **Try it (left table):**
 - Click the **⋮** menu icon on the "Region" header → uncheck regions to filter them out.
 - Use the search box to find specific values quickly.
 
-**Right table** is **locked** — the toolbar config controls and utility actions
-(reset, swap, import/export) are hidden, the **Settings** gear remains visible
-for inspection only, and you can still sort and filter via the column header menus.
+**Right table** is **locked** — authoring actions like reset, swap, and config import/export
+are hidden, but **Export Data** remains available, the **Settings** gear shows
+read-only view status, and you can still sort, filter, and change **Show Values As**
+from the header menus.
 
 **API parameters used:** `hidden_from_aggregators`, `sorters`, `locked`
 """

streamlit_pivot_table/__init__.py

@@ -497,9 +497,9 @@ def st_pivot_table(
         of values in the desired order.
     locked : bool
         If True, toolbar config controls are disabled. The settings gear stays
-        visible so users can inspect settings and expand/collapse groups, but
-        settings toggles are disabled. Header-menu sorting and filtering remain
-        available. Defaults to False.
+        visible so users can inspect current view status and expand/collapse
+        groups. Data export plus header-menu sorting, filtering, and show-values-as
+        remain available. Defaults to False.
     menu_limit : int or None
         Max items to show in the header-menu filter checklist. Defaults
         to 50 when None.