Support passing query params to `st.page_link` #13093

lukasmasuch · 2025-11-22T23:47:32Z

Describe your changes

Adds support for passing query parameters to st.page_link:

st.page_link(..., query_params={"foo": "bar", "baz": ["1", "2"]})

GitHub Issue Link (if applicable)

Closes Support query params in st.page_link #8112

Testing Plan

Added unit & e2e tests.

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

snyk-io · 2025-11-22T23:47:39Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scanner	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

github-actions · 2025-11-22T23:47:48Z

✅ PR preview is ready!

Name	Link
📦 Wheel file	https://core-previews.s3-us-west-2.amazonaws.com/pr-13093/streamlit-1.51.0-py3-none-any.whl
📦 `@streamlit/component-v2-lib`	Download from artifacts
🕹️ Preview app	pr-13093.streamlit.app (☁️ Deploy here if not accessible)

Copilot

Pull request overview

This PR adds support for passing query parameters to st.page_link, enabling developers to navigate to pages with pre-set query parameters for both internal multipage apps and external URLs.

Key Changes

Added query_string field to the PageLink protobuf message
Implemented process_query_params() helper function to convert query param dicts/iterables into URL-encoded strings
Updated frontend to append query params to external link hrefs and pass them through onPageChange for internal navigation

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
proto/streamlit/proto/PageLink.proto	Added `query_string` field to PageLink message for storing URL-encoded query parameters
lib/streamlit/runtime/state/query_params.py	Added `process_query_params()` and `_set_item_in_dict()` helper functions to process and validate query params
lib/streamlit/elements/widgets/button.py	Added `query_params` parameter to `page_link()` and `_page_link()` methods with processing logic
lib/tests/streamlit/runtime/state/query_params_test.py	Added comprehensive unit tests for `process_query_params()` covering dicts, iterables, list values, type conversions, and validation
lib/tests/streamlit/elements/page_link_test.py	Added test for `query_params` parameter with external URL
frontend/lib/src/components/elements/PageLink/PageLink.tsx	Updated to append query string to external link hrefs and pass to `onPageChange` for internal navigation
frontend/lib/src/components/core/NavigationContext.tsx	Updated `onPageChange` signature to accept optional `queryString` parameter
frontend/app/src/App.tsx	Updated `onPageChange` and `sendRerunBackMsg` to handle query string overrides with proper embed param preservation
e2e_playwright/multipage_apps_v2/mpa_v2_basics.py	Added test page link with query params
e2e_playwright/multipage_apps_v2/mpa_v2_basics_test.py	Added E2E test verifying query params are properly set when navigating via page link

frontend/lib/src/components/elements/PageLink/PageLink.tsx

lib/streamlit/elements/widgets/button.py

lib/streamlit/runtime/state/query_params.py

…-to-page-link

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.

lib/streamlit/runtime/state/query_params.py

lib/streamlit/elements/widgets/button.py

lib/streamlit/runtime/state/query_params.py

lib/streamlit/elements/widgets/button.py

frontend/app/src/App.tsx

…-to-page-link

sfc-gh-lwilby · 2025-11-26T15:00:15Z

frontend/app/src/App.tsx

-        queryString = preservedQueryParams
-        this.setState({ queryParams: preservedQueryParams })
+
+        if (queryStringOverride !== undefined) {


[nit] This could be a bit easier to read if it were separated out into a function so that the reader can get a high level idea of what it happening based on the function name.

E.g.

queryString = getQueryString(queryStringOverride, preservedQueryParams)

Moved into helper function 👍

sfc-gh-lwilby · 2025-11-26T15:13:54Z

frontend/lib/src/components/elements/PageLink/PageLink.tsx

    }
  }

+  let href = element.page


[nit] It would also be more readable here to separate this into a function.

const href = buildHref(element)

Moved into helper function 👍

sfc-gh-lwilby · 2025-11-26T15:18:57Z

lib/streamlit/runtime/state/query_params.py

+    """Set an item in a dictionary."""
+    if isinstance(value, dict):
+        raise StreamlitAPIException(
+            f"You cannot set a query params key `{key}` to a dictionary."


[nit] This isn't new, but I find this error message phrasing odd. Should it be more like, "Query params cannot be a dictionary. Provide a string or iterable as the value for {key}"

Update the error messgae 👍

sfc-gh-lwilby · 2025-11-26T15:44:21Z

lib/streamlit/runtime/state/query_params.py

+            if key in processed_params:
+                # If the key already exists, we need to accumulate the values.
+                if isinstance(value, dict):
+                    raise StreamlitAPIException(


[suggestion] Maybe this should be defined as a specific error message since it is used in two places to keep the message consistent.

Updated the error and reused the message 👍

sfc-gh-lwilby

LGTM, left some minor comments.

…-to-page-link

frontend/lib/src/components/elements/PageLink/PageLink.tsx

…-to-page-link

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 1 comment.

lib/streamlit/runtime/state/query_params.py

Support passing query params to st.page_link

bb9a8f3

Copilot AI review requested due to automatic review settings November 22, 2025 23:47

lukasmasuch requested a review from a team as a code owner November 22, 2025 23:47

Copilot started reviewing on behalf of lukasmasuch November 22, 2025 23:48 View session

lukasmasuch added security-assessment-completed Security assessment has been completed for PR change:feature PR contains new feature or enhancement implementation impact:users PR changes affect end users labels Nov 22, 2025

Update

ed55b47

Copilot finished reviewing on behalf of lukasmasuch November 22, 2025 23:52

Copilot AI reviewed Nov 22, 2025

View reviewed changes

Update

107b873

graphite-app bot reviewed Nov 23, 2025

View reviewed changes

lib/streamlit/runtime/state/query_params.py Outdated Show resolved Hide resolved

lukasmasuch marked this pull request as draft November 24, 2025 15:48

lukasmasuch changed the title ~~Support passing query params to st.page_link~~ [WIP] Support passing query params to st.page_link Nov 24, 2025

lukasmasuch added 3 commits November 25, 2025 14:26

Merge remote-tracking branch 'upstream/develop' into add-query-params…

ced3ecf

…-to-page-link

Fix linting issues

4293a22

Fix test

4275f33

lukasmasuch requested a review from Copilot November 25, 2025 13:34

Copilot started reviewing on behalf of lukasmasuch November 25, 2025 13:34 View session

Copilot finished reviewing on behalf of lukasmasuch November 25, 2025 13:39

Copilot AI reviewed Nov 25, 2025

View reviewed changes

lukasmasuch added 7 commits November 25, 2025 15:05

Apply improvements

3dbd59c

Apply some refactoring

717e258

Remame

730cdb8

Apply fix

8f77803

Update

32ea0e6

Add qyer parames for typing

f2592f5

Add tests

f656cbb

lukasmasuch added 3 commits November 25, 2025 15:35

More tweaks

7253f83

Fixed e2e test

b1ff190

Update

a1bbf97

lukasmasuch changed the title ~~[WIP] Support passing query params to st.page_link~~ Support passing query params to st.page_link Nov 25, 2025

Merge remote-tracking branch 'upstream/develop' into add-query-params…

41564cd

…-to-page-link

lukasmasuch marked this pull request as ready for review November 25, 2025 14:44

sfc-gh-lwilby reviewed Nov 26, 2025

View reviewed changes

sfc-gh-lwilby approved these changes Nov 26, 2025

View reviewed changes

lukasmasuch added 3 commits November 26, 2025 17:00

Apply feedback

ca04a33

Updated

6f4027c

Merge remote-tracking branch 'upstream/develop' into add-query-params…

1d51d23

…-to-page-link

lukasmasuch enabled auto-merge (squash) November 26, 2025 16:04

graphite-app bot reviewed Nov 26, 2025

View reviewed changes

frontend/lib/src/components/elements/PageLink/PageLink.tsx Outdated Show resolved Hide resolved

lukasmasuch disabled auto-merge November 26, 2025 16:11

lukasmasuch added 3 commits November 26, 2025 17:22

Fix CI

f223433

Merge remote-tracking branch 'upstream/develop' into add-query-params…

1622615

…-to-page-link

Apply feedback

5c495d7

lukasmasuch requested a review from Copilot November 26, 2025 16:27

Copilot started reviewing on behalf of lukasmasuch November 26, 2025 16:28 View session

Copilot finished reviewing on behalf of lukasmasuch November 26, 2025 16:30

Copilot AI reviewed Nov 26, 2025

View reviewed changes

lib/streamlit/runtime/state/query_params.py Outdated Show resolved Hide resolved

Treat embed parameters as case insensitive

1316bcb

lukasmasuch enabled auto-merge (squash) November 26, 2025 16:56

lukasmasuch merged commit 63d7f6f into develop Nov 26, 2025
43 checks passed

lukasmasuch deleted the add-query-params-to-page-link branch November 26, 2025 17:12

Support passing query params to st.page_link #13093

Support passing query params to st.page_link #13093

Uh oh!

Conversation

lukasmasuch commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes

GitHub Issue Link (if applicable)

Testing Plan

Uh oh!

snyk-io bot commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

github-actions bot commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ PR preview is ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfc-gh-lwilby Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

sfc-gh-lwilby Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

sfc-gh-lwilby Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

sfc-gh-lwilby Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

lukasmasuch Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfc-gh-lwilby left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Support passing query params to `st.page_link` #13093

Support passing query params to `st.page_link` #13093

lukasmasuch commented Nov 22, 2025 •

edited

Loading

snyk-io bot commented Nov 22, 2025 •

edited

Loading

github-actions bot commented Nov 22, 2025 •

edited

Loading

lukasmasuch Nov 26, 2025 •

edited

Loading