o h:@sUddlmZddlmZmZmZmZddlmZ ddl m Z ddl m Z mZddlmZmZer;ddlZddlmZd Zd ed <Gd d d ZdS)) annotations) TYPE_CHECKINGFinalLiteralcast)Markdown)gather_metrics) clean_textvalidate_icon_or_emoji) SupportsStris_sympy_expressionN)DeltaGeneratorz---r#MARKDOWN_HORIZONTAL_RULE_EXPRESSIONc@seZdZed d%ddd&d dZed d%ddd&ddZedddd'ddZedd(ddZeddddd)d!d"Ze d(d#d$Z dS)* MarkdownMixinmarkdownFN)helpbodyr unsafe_allow_htmlboolr str | Nonereturnr cCs8t}t||_||_tjj|_|r||_|j d|S)uDisplay string formatted as Markdown. Parameters ---------- body : any The text to display as GitHub-flavored Markdown. Syntax information can be found at: https://github.github.com/gfm. If anything other than a string is passed, it will be converted into a string behind the scenes using ``str(body)``. This also supports: - Emoji shortcodes, such as ``:+1:`` and ``:sunglasses:``. For a list of all supported codes, see https://share.streamlit.io/streamlit/emoji-shortcodes. - Streamlit logo shortcode. Use ``:streamlit:`` to add a little Streamlit flair to your text. - A limited set of typographical symbols. ``"<- -> <-> -- >= <= ~="`` becomes "← → ↔ — ≥ ≤ ≈" when parsed as Markdown. - Google Material Symbols (rounded style), using the syntax ``:material/icon_name:``, where "icon_name" is the name of the icon in snake case. For a complete list of icons, see Google's `Material Symbols `_ font library. - LaTeX expressions, by wrapping them in "$" or "$$" (the "$$" must be on their own lines). Supported LaTeX functions are listed at https://katex.org/docs/supported.html. - Colored text and background colors for text, using the syntax ``:color[text to be colored]`` and ``:color-background[text to be colored]``, respectively. ``color`` must be replaced with any of the following supported colors: blue, green, orange, red, violet, gray/grey, rainbow, or primary. For example, you can use ``:orange[your text here]`` or ``:blue-background[your text here]``. If you use "primary" for color, Streamlit will use the default primary accent color unless you set the ``theme.primaryColor`` configuration option. - Colored badges, using the syntax ``:color-badge[text in the badge]``. ``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]``. unsafe_allow_html : bool Whether to render HTML within ``body``. If this is ``False`` (default), any HTML tags found in ``body`` will be escaped and therefore treated as raw text. If this is ``True``, any HTML expressions within ``body`` will be rendered. Adding custom HTML to your app impacts safety, styling, and maintainability. .. note:: If you only want to insert HTML or CSS without Markdown text, we recommend using ``st.html`` instead. help : str or None A tooltip that gets displayed next to the Markdown. If this is ``None`` (default), no tooltip is displayed. The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the ``body`` parameter of ``st.markdown``. Examples -------- >>> import streamlit as st >>> >>> st.markdown("*Streamlit* is **really** ***cool***.") >>> st.markdown(''' ... :red[Streamlit] :orange[can] :green[write] :blue[text] :violet[in] ... :gray[pretty] :rainbow[colors] and :blue-background[highlight] text.''') >>> st.markdown("Here's a bouquet —\ ... :tulip::cherry_blossom::rose::hibiscus::sunflower::blossom:") >>> >>> multi = '''If you end a line with two spaces, ... a soft return is used for the next line. ... ... Two (or more) newline characters in a row will result in a hard return. ... ''' >>> st.markdown(multi) .. output:: https://doc-markdown.streamlit.app/ height: 350px r) MarkdownProtor r allow_htmlTypeNATIVE element_typerdg_enqueue)selfrrrmarkdown_protor O/var/www/vscode/kcb/lib/python3.10/site-packages/streamlit/elements/markdown.pyr!sg  zMarkdownMixin.markdowncaptioncCs>t}t||_||_d|_tjj|_|r||_|j d|S)aDisplay text in small font. This should be used for captions, asides, footnotes, sidenotes, and other explanatory text. Parameters ---------- body : str The text to display as GitHub-flavored Markdown. Syntax information can be found at: https://github.github.com/gfm. See the ``body`` parameter of |st.markdown|_ for additional, supported Markdown directives. .. |st.markdown| replace:: ``st.markdown`` .. _st.markdown: https://docs.streamlit.io/develop/api-reference/text/st.markdown unsafe_allow_html : bool Whether to render HTML within ``body``. If this is ``False`` (default), any HTML tags found in ``body`` will be escaped and therefore treated as raw text. If this is ``True``, any HTML expressions within ``body`` will be rendered. Adding custom HTML to your app impacts safety, styling, and maintainability. .. note:: If you only want to insert HTML or CSS without Markdown text, we recommend using ``st.html`` instead. help : str or None A tooltip that gets displayed next to the caption. If this is ``None`` (default), no tooltip is displayed. The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the ``body`` parameter of ``st.markdown``. Examples -------- >>> import streamlit as st >>> >>> st.caption("This is a string that explains something above.") >>> st.caption("A caption with _italics_ :blue[colors] and emojis :sunglasses:") Tr) rr rr is_captionrCAPTIONrrrr)rrrr caption_protor r r!r"s6  zMarkdownMixin.captionlatexSupportsStr | sympy.ExprcCsPt|r ddl}||}t}dt||_tjj|_|r!||_ |j d|S)aDisplay mathematical expressions formatted as LaTeX. Supported LaTeX functions are listed at https://katex.org/docs/supported.html. Parameters ---------- body : str or SymPy expression The string or SymPy expression to display as LaTeX. If str, it's a good idea to use raw Python strings since LaTeX uses backslashes a lot. help : str or None A tooltip that gets displayed next to the LaTeX expression. If this is ``None`` (default), no tooltip is displayed. The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the ``body`` parameter of ``st.markdown``. Example ------- >>> import streamlit as st >>> >>> st.latex(r''' ... a + ar + a r^2 + a r^3 + \cdots + a r^{n-1} = ... \sum_{k=0}^{n-1} ar^k = ... a \left(\frac{1-r^{n}}{1-r}\right) ... ''') rNz$$ %s $$r) r sympyr&rr rrLATEXrrrr)rrrr( latex_protor r r!r&s(  zMarkdownMixin.latexdividercCs$t}t|_tjj|_|jd|S)aDisplay a horizontal rule. .. note:: You can achieve the same effect with st.write("---") or even just "---" in your script (via magic). Example ------- >>> import streamlit as st >>> >>> st.divider() r)rrrrDIVIDERrrr)r divider_protor r r!r+s zMarkdownMixin.dividerbadgeblue)iconcolorlabelstrr0r1YLiteral['blue', 'green', 'orange', 'red', 'violet', 'gray', 'grey', 'rainbow', 'primary']cCsd|dur t|d}nd}|dddd}t}d|d ||d|_tjj|_|jd |S) u Display a colored badge with an icon and label. 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 ---------- label : str The label to display in the badge. The label can optionally contain GitHub-flavored Markdown of the following types: Bold, Italics, Strikethroughs, Inline Code. See the ``body`` parameter of |st.markdown|_ for additional, 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 icon : str or None An optional emoji or icon to display next to the badge label. If ``icon`` is ``None`` (default), no icon is displayed. If ``icon`` is a string, the following options are valid: - A single-character emoji. For example, you can set ``icon="🚨"`` or ``icon="🔥"``. Emoji short codes are not supported. - An icon from the Material Symbols library (rounded style) in the format ``":material/icon_name:"`` where "icon_name" is the name of the icon in snake case. For example, ``icon=":material/thumb_up:"`` will display the Thumb Up icon. Find additional icons in the `Material Symbols `_ font library. color : str 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 >>> >>> st.badge("New") >>> st.badge("Success", icon=":material/check:", color="green") >>> >>> st.markdown( >>> ":violet-badge[:material/star: Favorite] :orange-badge[⚠️ Needs review] :gray-badge[Deprecated]" >>> ) .. output :: https://doc-badge.streamlit.app/ height: 220px N [z\[]z\]:z-badge[r) r replacerrrrrrr)rr2r0r1icon_str escaped_label badge_protor r r!r.s[ zMarkdownMixin.badgecCs td|S)zGet our DeltaGenerator.r )r)rr r r!rs zMarkdownMixin.dg)F)rr rrrrrr )rr'rrrr )rr )r2r3r0rr1r4rr ) __name__ __module__ __qualname__rrr"r&r+r.propertyrr r r r!r s,p>3  gr) __future__rtypingrrrrstreamlit.proto.Markdown_pb2rrstreamlit.runtime.metrics_utilrstreamlit.string_utilr r streamlit.type_utilr r r(streamlit.delta_generatorr r__annotations__rr r r r!s