streamlit-nightly 1.43.3.dev20250324__py3-none-any.whl → 1.44.1.dev20250325__py3-none-any.whl

streamlit/config.py

@@ -1052,53 +1052,72 @@ _create_theme_options(
     categories=["theme"],
     description="""
         The preset Streamlit theme that your custom theme inherits from.
-        One of "light" or "dark".
+        This can be one of the following: "light" or "dark".
     """,
 )
 
 _create_theme_options(
     "primaryColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Primary accent color for interactive elements.",
+    description="""
+        Primary accent color.
+    """,
 )
 
 _create_theme_options(
     "backgroundColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Background color for the main content area.",
+    description="""
+        Background color of the app.
+    """,
 )
 
 _create_theme_options(
     "secondaryBackgroundColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Background color used for the sidebar and most interactive widgets.",
+    description="""
+        Background color used for most interactive widgets.
+    """,
 )
 
 _create_theme_options(
     "textColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Color used for almost all text.",
+    description="""
+        Color used for almost all text.
+    """,
 )
 
 _create_theme_options(
     "linkColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Color used for all links.",
+    description="""
+        Color used for all links.
+    """,
 )
 
 _create_theme_options(
     "codeBackgroundColor",
     categories=["theme", CustomThemeCategories.SIDEBAR],
-    description="Background color used for code blocks.",
+    description="""
+        Background color used for code blocks.
+    """,
 )
 
 _create_theme_options(
     "font",
     categories=["theme", CustomThemeCategories.SIDEBAR],
     description="""
-        The font family for all text in the app, except code blocks. One of "sans serif",
-        "serif", or "monospace".
-        To use a custom font, it needs to be added via [theme.fontFaces].
+        The font family for all text, except code blocks. This can be one of
+        the following:
+        - "sans-serif"
+        - "serif"
+        - "monospace"
+        - the `font` value for a custom font table under [[theme.fontFaces]]
+        - a comma-separated list of these (as a single string) to specify
+          fallbacks
+        For example, you can use the following:
+        font = "cool-font, fallback-cool-font, sans-serif"
     """,
 )
 
@@ -1106,8 +1125,14 @@ _create_theme_options(
     "codeFont",
     categories=["theme", CustomThemeCategories.SIDEBAR],
     description="""
-        The font family to use for code (monospace) in the app.
-        To use a custom font, it needs to be added via [theme.fontFaces].
+        The font family to use for code (monospace) in the sidebar. This can be
+        one of the following:
+        - "sans-serif"
+        - "serif"
+        - "monospace"
+        - the `font` value for a custom font table under [[theme.fontFaces]]
+        - a comma-separated list of these (as a single string) to specify
+          fallbacks
     """,
 )
 
@@ -1115,8 +1140,14 @@ _create_theme_options(
     "headingFont",
     categories=["theme", CustomThemeCategories.SIDEBAR],
     description="""
-        The font family to use for headings in the app.
-        To use a custom font, it needs to be added via [theme.fontFaces].
+        The font family to use for headings. This can be one of the following:
+        - "sans-serif"
+        - "serif"
+        - "monospace"
+        - the `font` value for a custom font table under [[theme.fontFaces]]
+        - a comma-separated list of these (as a single string) to specify
+          fallbacks
+        If no heading font is set, Streamlit uses `theme.font` for headings.
     """,
 )
 
@@ -1124,17 +1155,31 @@ _create_theme_options(
     "fontFaces",
     categories=["theme"],
     description="""
-    Configure a list of font faces that you can use for the app & code fonts.
-""",
+        An array of fonts to use in your app. Each font in the array is a table
+        (dictionary) with the following three attributes: font, url, weight,
+        and style. To host a font with your app, enable static file serving
+        with `server.enableStaticServing=true`. You can define multiple
+        [[theme.fontFaces]] tables.
+
+        For example, each font is defined in a [[theme.fontFaces]] table as
+        follows:
+        [[theme.fontFaces]]
+        font = "font_name"
+        url = "app/static/font_file.woff"
+        weight = 400
+        style = "normal"
+    """,
 )
 
 _create_theme_options(
     "baseRadius",
     categories=["theme", CustomThemeCategories.SIDEBAR],
     description="""
-        The radius used as basis for the corners of most UI elements. Can be:
-        "none", "small", "medium", "large", "full", or the number in pixel or rem.
-        For example: "10px", "0.5rem", "1.2rem", "2rem".
+        The radius used as basis for the corners of most UI elements. This can
+        be one of the following: "none", "small", "medium", "large", "full",
+        or the number in pixels or rem. For example, you can use "10px",
+        "0.5rem", or "2rem". To follow best practices, use rem instead of
+        pixels when specifying a numeric size.
     """,
 )
 
@@ -1150,8 +1195,7 @@ _create_theme_options(
     "showWidgetBorder",
     categories=["theme", CustomThemeCategories.SIDEBAR],
     description="""
-        Whether to show a border around input widgets (e.g. text_input, number_input,
-        file_uploader, etc).
+        Whether to show a border around input widgets.
     """,
     type_=bool,
 )
@@ -1160,8 +1204,8 @@ _create_theme_options(
     "baseFontSize",
     categories=["theme"],
     description="""
-        Sets the root font size (in pixels) for the app, which determines the overall
-        scale of text and UI elements. The default base font size is 16.
+        Sets the root font size (in pixels) for the app, which determines the
+        overall scale of text and UI elements. The default base font size is 16.
     """,
     type_=int,
 )
@@ -1170,7 +1214,8 @@ _create_theme_options(
     "showSidebarBorder",
     categories=["theme"],
     description="""
-        Whether to show a vertical separator between the sidebar and the main content.
+        Whether to show a vertical separator between the sidebar and the main
+        content area.
     """,
     type_=bool,
 )

streamlit/elements/exception.py

@@ -43,6 +43,10 @@ class ExceptionMixin:
     def exception(self, exception: BaseException) -> DeltaGenerator:
         """Display an exception.
 
+        In the lower-right corner of the exception, Streamlit displays links to
+        Google and ChatGPT that are prefilled with the contents of the
+        exception message.
+
         Parameters
         ----------
         exception : Exception
@@ -55,6 +59,10 @@ class ExceptionMixin:
         >>> e = RuntimeError("This is an exception of type RuntimeError")
         >>> st.exception(e)
 
+        .. output ::
+            https://doc-status-exception.streamlit.app/
+            height: 220px
+
         """
         return _exception(self.dg, exception)
 

streamlit/elements/markdown.py

@@ -81,9 +81,10 @@ class MarkdownMixin:
               configuration option.
 
             - Colored badges, using the syntax ``:color-badge[text in the badge]``.
-              Supported colors are: blue, green, orange, red, violet, gray/grey,
-              or primary. For example, you can use ``:orange-badge[your text here]``
-              or ``:blue-badge[your text here]``.
+              ``color`` must be replaced with any of the following supported
+              colors: blue, green, orange, red, violet, gray/grey, or primary.
+              For example, you can use ``:orange-badge[your text here]`` or
+              ``:blue-badge[your text here]``.
 
             - Small text, using the syntax ``:small[text to show small]``.
 
@@ -291,16 +292,21 @@ class MarkdownMixin:
             "violet",
             "gray",
             "grey",
-            "rainbow",
             "primary",
         ] = "blue",
     ) -> DeltaGenerator:
         """Display a colored badge with an icon and label.
 
-        You can also insert badges directly in Markdown, e.g. via
-        `st.markdown(":blue-badge[Home]")`. This works in all places where Streamlit
-        supports Markdown, e.g. widget labels or `st.table` cells. See `st.markdown`
-        for more information.
+        This is a thin wrapper around the color-badge Markdown directive.
+        The following are equivalent:
+
+        - ``st.markdown(":blue-badge[Home]")``
+        - ``st.badge("Home", color="blue")``
+
+        .. note::
+            You can insert badges everywhere Streamlit supports Markdown by
+            using the color-badge Markdown directive. See ``st.markdown`` for
+            more information.
 
         Parameters
         ----------
@@ -310,7 +316,9 @@ class MarkdownMixin:
             Strikethroughs, Inline Code.
 
             See the ``body`` parameter of |st.markdown|_ for additional,
-            supported Markdown directives.
+            supported Markdown directives. Because this command escapes square
+            brackets (``[ ]``) in this parameter, any directive requiring
+            square brackets is not supported.
 
             .. |st.markdown| replace:: ``st.markdown``
             .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown
@@ -333,26 +341,32 @@ class MarkdownMixin:
               font library.
 
         color : str
-            The color to use for the badge. Supported colors are: blue, green,
-            orange, red, violet, gray/grey, primary.
-            If you use "primary" for color, Streamlit will use the default
-            primary accent color unless you set the ``theme.primaryColor``
-            configuration option.
+            The color to use for the badge. This defaults to ``"blue"``.
+
+            This can be one of the following supported colors: blue, green,
+            orange, red, violet, gray/grey, or primary. If you use
+            ``"primary"``, Streamlit will use the default primary accent color
+            unless you set the ``theme.primaryColor`` configuration option.
 
         Examples
         --------
+        Create standalone badges with ``st.badge`` (with or without icons). If
+        you want to have multiple, side-by-side badges, you can use the
+        Markdown directive in ``st.markdown``.
+
         >>> import streamlit as st
         >>>
-        >>> # Simple badge
-        >>> st.badge("Home")
-        >>>
-        >>> # Badge with icon and color
+        >>> st.badge("New")
         >>> st.badge("Success", icon=":material/check:", color="green")
         >>>
-        >>> # Multiple badges side by side in Markdown
         >>> st.markdown(
-        ...     "Here are some badges: :orange-badge[⭐️ Favorite] :blue-badge[🏠 Home] :green-badge[✅ Success]"
-        ... )
+        >>>     ":violet-badge[:material/star: Favorite] :orange-badge[⚠️ Needs review] :gray-badge[Deprecated]"
+        >>> )
+
+        .. output ::
+            https://doc-badge.streamlit.app/
+            height: 220px
+
         """
         if icon is not None:
             icon_str = validate_icon_or_emoji(icon) + " "

streamlit/elements/widgets/number_input.py

@@ -222,17 +222,22 @@ class NumberInputMixin:
 
         min_value : int, float, or None
             The minimum permitted value.
-            If None, there will be no minimum.
+            If this is ``None`` (default), there will be no minimum for float
+            values and a minimum of ``- (1<<53) + 1`` for integer values.
 
         max_value : int, float, or None
             The maximum permitted value.
-            If None, there will be no maximum.
+            If this is ``None`` (default), there will be no maximum for float
+            values and a maximum of ``(1<<53) - 1`` for integer values.
 
         value : int, float, "min" or None
-            The value of this widget when it first renders. If ``None``, will initialize
-            empty and return ``None`` until the user provides input.
-            If "min" (default), will initialize with min_value, or 0.0 if
-            min_value is None.
+            The value of this widget when it first renders. If this is
+            ``"min"`` (default), the initial value is ``min_value`` unless
+            ``min_value`` is ``None``. If ``min_value`` is ``None``, the widget
+            initializes with a value of ``0.0`` or ``0``.
+
+            If ``value`` is ``None``, the widget will initialize with no value
+            and return ``None`` until the user provides input.
 
         step : int, float, or None
             The stepping interval.

streamlit/elements/widgets/slider.py

@@ -398,20 +398,32 @@ class SliderMixin:
 
         min_value : a supported type or None
             The minimum permitted value.
-            Defaults to 0 if the value is an int, 0.0 if a float,
-            value - timedelta(days=14) if a date/datetime, time.min if a time
+            If this is ``None`` (default), the minimum value depends on the
+            type as follows:
+
+            - integer: ``0``
+            - float: ``0.0``
+            - date or datetime: ``value - timedelta(days=14)``
+            - time: ``time.min``
 
         max_value : a supported type or None
             The maximum permitted value.
-            Defaults to 100 if the value is an int, 1.0 if a float,
-            value + timedelta(days=14) if a date/datetime, time.max if a time
+            If this is ``None`` (default), the maximum value depends on the
+            type as follows:
+
+            - integer: ``100``
+            - float: ``1.0``
+            - date or datetime: ``value + timedelta(days=14)``
+            - time: ``time.max``
 
         value : a supported type or a tuple/list of supported types or None
             The value of the slider when it first renders. If a tuple/list
             of two values is passed here, then a range slider with those lower
             and upper bounds is rendered. For example, if set to `(1, 10)` the
             slider will have a selectable range between 1 and 10.
-            Defaults to min_value.
+            This defaults to ``min_value``. If the type is not otherwise
+            specified in any of the numeric parameters, the widget will have an
+            integer value.
 
         step : int, float, timedelta, or None
             The stepping interval.