Allow markdown in st.table
#10088
Merged
Allow markdown in st.table
#10088
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrieke
added
security-assessment-completed
Collaborator
Author
|
|
jrieke
commented
Dec 27, 2024
| While ``st.dataframe`` is geared towards large datasets and interactive | ||
| data exploration, ``st.table`` is useful to display a small table without | ||
| scrolling – e.g. a confusion matrix or a leaderboard. For this reason, it also | ||
| supports Markdown formatting. |
Collaborator
Author
There was a problem hiding this comment.
@sfc-gh-dmatthews FYI I updated the description here to make it a bit easier to understand the differences.
jrieke
commented
Dec 27, 2024
| >>> st.table(df) | ||
| .. output:: | ||
| https://doc-table-markdown.streamlit.app/ |
Collaborator
Author
There was a problem hiding this comment.
@sfc-gh-dmatthews we still need to deploy an app here or integrate the code into the previous app. Also, feel free to change the code in any way you want!
lukasmasuch
reviewed
Jan 2, 2025
e2e_playwright/__snapshots__/linux/st_table_test/st_table-10[firefox].png
Show resolved
Hide resolved
e2e_playwright/__snapshots__/linux/st_table_test/st_table-31[firefox].png
Show resolved
Hide resolved
sfc-gh-pchiu
reviewed
Jan 3, 2025
Contributor
|
@lukasmasuch I implemented all the comments above, can you give this another look and approve? |
lukasmasuch
reviewed
Jan 16, 2025
| static: its entire contents are laid out directly on the page. | ||
| While ``st.dataframe`` is geared towards large datasets and interactive | ||
| data exploration, ``st.table`` is useful to display a small table without | ||
| scrolling – e.g. a confusion matrix or a leaderboard. For this reason, it also |
Collaborator
There was a problem hiding this comment.
nit: should we also add that st.table is geared towards more style-related customizability? E.g. it also supports a lot more Pandas Styler features compared to st.dataframe.
lukasmasuch
approved these changes
Jan 16, 2025
Collaborator
lukasmasuch
left a comment
lukasmasuch
left a comment
There was a problem hiding this comment.
LGTM 👍 We just merged some other changes related to ArrowTable, it might need merging + recreating of the snapshots.
Also, it probably makes sense to add this to our new markdown_features e2e test as well (e.g. just use a dataframe with a single markdown cell).
edegp
pushed a commit
to edegp/streamlit
that referenced
this pull request
Jan 19, 2025
## Describe your changes Adds markdown support in `st.table` for data cells, row index, and column headers. Note that unlike labels, this doesn't have any restrictions on which markdown features can be used. I think table cells are big enough to handle larger markdown elements (such as headers or bullet lists) without looking ugly. I also changed the empty value from `<NA>` to a non-breaking space (i.e. an empty cell) because the smaller/greater symbols caused problems with the markdown formatting. Note that for `st.dataframe` we use `None` for empty values. In `st.table`, I think an empty cell looks nicer though, because `st.table` is less geared towards exploring actual datasets where it might be important to see the actual values and more towards showing a small table of fixed values.  ## GitHub Issue Link (if applicable) Closes streamlit#8785 Should also leave a note on streamlit#6461, which asks for markdown on `st.dataframe`. ## Testing Plan - Added an e2e snapshot test for a table with various markdown features. - I also tried adding JS unit tests but it's not super easy because we need to add the encoded data for a Markdown table in `frontend/lib/src/mocks/arrow/index.ts`. Not sure if it's worth doing that given that the e2e test already covers everything. - Note that a lot of snapshots changed because of the move from `<NA>` to an empty cell. --- **Contribution License Agreement** By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license. --------- Co-authored-by: Johannes Rieke <[email protected]>
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Adds markdown support in
st.tablefor data cells, row index, and column headers. Note that unlike labels, this doesn't have any restrictions on which markdown features can be used. I think table cells are big enough to handle larger markdown elements (such as headers or bullet lists) without looking ugly.I also changed the empty value from
<NA>to a non-breaking space (i.e. an empty cell) because the smaller/greater symbols caused problems with the markdown formatting. Note that forst.dataframewe useNonefor empty values. Inst.table, I think an empty cell looks nicer though, becausest.tableis less geared towards exploring actual datasets where it might be important to see the actual values and more towards showing a small table of fixed values.GitHub Issue Link (if applicable)
Closes #8785
Should also leave a note on #6461, which asks for markdown on
st.dataframe.Testing Plan
frontend/lib/src/mocks/arrow/index.ts. Not sure if it's worth doing that given that the e2e test already covers everything.<NA>to an empty cell.Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.