Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/python-3/.devcontainer/base.Dockerfile
# See here for image contents: https://github.com/devcontainers/images/tree/main/src/python

# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
ARG VARIANT="3.10-bullseye"
FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
# [Choice] Python version: 3.10-bookworm, 3.11-bookworm, 3.12-bookworm, 3.13-bookworm
ARG VARIANT="3.13-bookworm"
FROM mcr.microsoft.com/devcontainers/python:1-${VARIANT}

# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
# [Choice] Node.js version: none, 20, 22, lts/*
ARG NODE_VERSION="none"
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi

Expand Down
71 changes: 33 additions & 38 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/python-3
// For format details, see https://containers.dev/implementors/json_reference/
{
"name": "Python 3",
"build": {
"dockerfile": "Dockerfile",
"context": "..",
"args": {
// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
// Append -bullseye or -buster to pin to an OS version.
// Use -bullseye variants on local on arm64/Apple Silicon.
"VARIANT": "3.7",
// Options
"NODE_VERSION": "lts/*"
}
},
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/usr/local/bin/python",
},
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"ms-python.python",
"ms-python.vscode-pylance"
],
// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [
3000
],
// Use 'postCreateCommand' to run commands after the container is created.
// Install NPM dependencies.
"postCreateCommand": "make",
"name": "streamlit-docs",
"build": {
"dockerfile": "Dockerfile",
"context": "..",
"args": {
// Streamlit currently supports Python 3.10 through 3.13.
// Valid devcontainer variants here are 3.10-bookworm through 3.13-bookworm.
"VARIANT": "3.13-bookworm",
// Keep Node aligned with package.json.
"NODE_VERSION": "20"
}
},
"customizations": {
"vscode": {
"settings": {
"python.defaultInterpreterPath": "/usr/local/bin/python"
},
"extensions": ["ms-python.python", "ms-python.vscode-pylance"]
}
},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [3000],
// Use 'postCreateCommand' to run commands after the container is created.
// Install NPM dependencies.
"postCreateCommand": "make",
// Use 'postStartCommand' to run 'make up' every time the container is started.
"postStartCommand": "make up",
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode",
"features": {
"git": "latest",
"github-cli": "latest"
}
"postStartCommand": "make up",
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode",
"features": {
"ghcr.io/devcontainers/features/git:1": {},
"ghcr.io/devcontainers/features/github-cli:1": {}
}
}
27 changes: 27 additions & 0 deletions content/develop/api-reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,19 @@ Renders HTML strings to your app.
st.html("<p>Foo bar.</p>")
```

</RefCard>
<RefCard href="/develop/api-reference/text/st.iframe">

<h4>Iframe</h4>

Display content in an iframe

```python
st.iframe("https://docs.streamlit.io")
st.iframe("<p>Streamlit is cool.</p>")
st.iframe("my_content.html")
```

</RefCard>
</TileContainer>

Expand Down Expand Up @@ -831,6 +844,20 @@ Display a link button.
st.link_button("Go to gallery", url)
```

</RefCard>

<RefCard href="/develop/api-reference/widgets/st.menu_button">

<Image pure alt="screenshot" src="/images/api/menu_button.jpg" />

<h4>Menu button</h4>

Display a menu button.

```python
st.menu_button("Export", options=["CSV", "JSON", "PDF"])
```

</RefCard>
<RefCard href="/develop/api-reference/widgets/st.page_link">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ keywords: bidicomponentcallable, bidirectional, custom components v2, interface,

<Autofunction function="ComponentRenderer" oldName="BidiComponentCallable" />

<Autofunction function="BidiComponentResult" />
<Autofunction function="ComponentResult" oldName="BidiComponentResult" />
2 changes: 1 addition & 1 deletion content/develop/api-reference/custom-components/html.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: st.components.v1.html displays an HTML string in an iframe within y
keywords: html, iframe, custom component, html string, display, frontend, web content, components v1
---

<Autofunction function="streamlit.components.v1.html" />
<Autofunction function="streamlit.components.v1.html" deprecated={true} deprecatedText="<code>st.components.v1.html</code> was deprecated in version 1.56.0 and will be removed in a later version. Use <a href='/develop/api-reference/text/st.html'><code>st.html</code></a> instead."/>
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: st.components.v1.iframe embeds web content in an iframe.
keywords: st.components.v1.iframe, iframe, embed html, external content, web content, streamlit components, html embedding, custom components, streamlit iframe
---

<Autofunction function="streamlit.components.v1.iframe" />
<Autofunction function="streamlit.components.v1.iframe" deprecated={true} deprecatedText="<code>st.components.v1.iframe</code> was deprecated in version 1.56.0 and will be removed in a later version. Use <a href='/develop/api-reference/text/st.iframe'><code>st.iframe</code></a> instead."/>
26 changes: 26 additions & 0 deletions content/develop/api-reference/data/column_config/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,32 @@ ImageColumn("Preview Image", help="The preview screenshots")

</RefCard>

<RefCard href="/develop/api-reference/data/st.column_config/st.column_config.audiocolumn">
<Image pure alt="screenshot" src="/images/api/column_config.audiocolumn.jpg" />

<h4>Audio column</h4>

Configure an audio column.

```python
AudioColumn("Sound effect", help="Double click to play.")
```

</RefCard>

<RefCard href="/develop/api-reference/data/st.column_config/st.column_config.videocolumn">
<Image pure alt="screenshot" src="/images/api/column_config.videocolumn.jpg" />

<h4>Video column</h4>

Configure a video column.

```python
VideoColumn("Highlight clip", help="Double click to play.")
```

</RefCard>

<RefCard href="/develop/api-reference/data/st.column_config/st.column_config.areachartcolumn">
<Image pure alt="screenshot" src="/images/api/column_config.areachartcolumn.jpg" />

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: st.column_config.AudioColumn
slug: /develop/api-reference/data/st.column_config/st.column_config.audiocolumn
description: st.column_config.AudioColumn configures audio columns for playing audio directly within dataframe cells from URLs or file paths.
keywords: st.column_config.AudioColumn, audio column, play audio, audio urls, audio dataframe, inline audio, dataframe audio
---

<Autofunction function="streamlit.column_config.AudioColumn" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: st.column_config.VideoColumn
slug: /develop/api-reference/data/st.column_config/st.column_config.videocolumn
description: st.column_config.VideoColumn configures video columns for displaying videos directly within dataframe cells from URLs or file paths.
keywords: st.column_config.VideoColumn, video column, display videos, video urls, video dataframe, inline videos, video display, dataframe videos
---

<Autofunction function="streamlit.column_config.VideoColumn" />
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Note that you can also retrieve elements within a specific container in the same

<Autofunction function="AppTest.expander" />

<Autofunction function="AppTest.file_uploader" />

<Autofunction function="AppTest.header" />

<Autofunction function="AppTest.info" />
Expand Down
2 changes: 2 additions & 0 deletions content/develop/api-reference/testing/testing_elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ The `Block` class has the same methods and attributes as `AppTest`. A `Block` in

<Autofunction function="streamlit.testing.v1.element_tree.DateInput" />

<Autofunction function="streamlit.testing.v1.element_tree.FileUploader" />

<Autofunction function="streamlit.testing.v1.element_tree.Multiselect" />

<Autofunction function="streamlit.testing.v1.element_tree.NumberInput" />
Expand Down
17 changes: 15 additions & 2 deletions content/develop/api-reference/text/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ st.divider()
## Utilities

<TileContainer>
<RefCard href="/develop/api-reference/text/st.help" size="half">
<RefCard href="/develop/api-reference/text/st.help">

<h4>Get help</h4>

Expand All @@ -188,7 +188,7 @@ st.help(pd.DataFrame)
```

</RefCard>
<RefCard href="/develop/api-reference/text/st.html" size="half">
<RefCard href="/develop/api-reference/text/st.html">

<h4>Render HTML</h4>

Expand All @@ -198,6 +198,19 @@ Renders HTML strings to your app.
st.html("<p>Foo bar.</p>")
```

</RefCard>
<RefCard href="/develop/api-reference/text/st.iframe">

<h4>Iframe</h4>

Display content in an iframe

```python
st.iframe("https://docs.streamlit.io")
st.iframe("<p>Streamlit is cool.</p>")
st.iframe("my_content.html")
```

</RefCard>
</TileContainer>

Expand Down
8 changes: 8 additions & 0 deletions content/develop/api-reference/text/iframe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: st.iframe
slug: /develop/api-reference/text/st.iframe
description: st.iframe renders arbitrary HTML, files, or URLs in an iframe.
keywords: st.iframe, iframe, html, html rendering, html display, custom html, html strings, web content, html elements, raw html
---

<Autofunction function="streamlit.iframe" />
14 changes: 14 additions & 0 deletions content/develop/api-reference/widgets/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@ st.link_button("Go to gallery", url)

</RefCard>

<RefCard href="/develop/api-reference/widgets/st.menu_button">

<Image pure alt="screenshot" src="/images/api/menu_button.jpg" />

<h4>Menu button</h4>

Display a menu button.

```python
st.menu_button("Export", options=["CSV", "JSON", "PDF"])
```

</RefCard>

<RefCard href="/develop/api-reference/widgets/st.page_link">

<Image pure alt="screenshot" src="/images/api/page_link.jpg" />
Expand Down
8 changes: 8 additions & 0 deletions content/develop/api-reference/widgets/menu_button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: st.menu_button
slug: /develop/api-reference/widgets/st.menu_button
description: st.menu_button displays a multi-action drop-down button
keywords: menu, multi-action button, drop-down button, multiple trigger button
---

<Autofunction function="streamlit.menu_button" />
10 changes: 10 additions & 0 deletions content/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ site_menu:
url: /develop/api-reference/text/st.help
- category: Develop / API reference / Text elements / st.html
url: /develop/api-reference/text/st.html
- category: Develop / API reference / Text elements / st.iframe
url: /develop/api-reference/text/st.iframe
- category: Develop / API reference / Data elements
url: /develop/api-reference/data
- category: Develop / API reference / Data elements / st.dataframe
Expand Down Expand Up @@ -250,6 +252,10 @@ site_menu:
url: /develop/api-reference/data/st.column_config/st.column_config.linkcolumn
- category: Develop / API reference / Data elements / st.column_config / Image column
url: /develop/api-reference/data/st.column_config/st.column_config.imagecolumn
- category: Develop / API reference / Data elements / st.column_config / Audio column
url: /develop/api-reference/data/st.column_config/st.column_config.audiocolumn
- category: Develop / API reference / Data elements / st.column_config / Video column
url: /develop/api-reference/data/st.column_config/st.column_config.videocolumn
- category: Develop / API reference / Data elements / st.column_config / Area chart column
url: /develop/api-reference/data/st.column_config/st.column_config.areachartcolumn
- category: Develop / API reference / Data elements / st.column_config / Line chart column
Expand Down Expand Up @@ -309,6 +315,8 @@ site_menu:
url: https://docs.streamlit.io/develop/api-reference/execution-flow/st.form_submit_button
- category: Develop / API reference / Input widgets / st.link_button
url: /develop/api-reference/widgets/st.link_button
- category: Develop / API reference / Input widgets / st.menu_button
url: /develop/api-reference/widgets/st.menu_button
- category: Develop / API reference / Input widgets / st.page_link
url: /develop/api-reference/widgets/st.page_link
- category: Develop / API reference / Input widgets / SELECTIONS
Expand Down Expand Up @@ -549,8 +557,10 @@ site_menu:
url: /develop/api-reference/custom-components/st.components.v1.declare_component
- category: Develop / API reference / Custom components / html
url: /develop/api-reference/custom-components/st.components.v1.html
isDeprecated: true
- category: Develop / API reference / Custom components / iframe
url: /develop/api-reference/custom-components/st.components.v1.iframe
isDeprecated: true
- category: Develop / API reference / Configuration
url: /develop/api-reference/configuration
isVersioned: false
Expand Down
Binary file added public/images/api/column_config.audiocolumn.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/api/column_config.videocolumn.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/api/menu_button.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading