st.code

Display a code block with optional syntax highlighting.

Function signature[source]

st.code(body, language="python", *, line_numbers=False, wrap_lines=False, height="content", width="stretch")

Parameters

body (str)

The string to display as code or monospace text.

language (str or None)

The language that the code is written in, for syntax highlighting. This defaults to "python". If this is None, the code will be plain, monospace text.

For a list of available language values, see react-syntax-highlighter on GitHub.

line_numbers (bool)

An optional boolean indicating whether to show line numbers to the left of the code block. This defaults to False.

wrap_lines (bool)

An optional boolean indicating whether to wrap lines. This defaults to False.

height ("content" or int)

The height of the code block element. This can be one of the following:

  • "content" (default): The height of the element matches the height of its content.
  • An integer specifying the height in pixels: The element has a fixed height. If the content is larger than the specified height, scrolling is enabled.

Note

Use scrolling containers sparingly. If you use scrolling containers, avoid heights that exceed 500 pixels. Otherwise, the scroll surface of the container might cover the majority of the screen on mobile devices, which makes it hard to scroll the rest of the app.

width ("stretch" or int)

The width of the code block element. This can be one of the following:

  • "stretch" (default): The width of the element matches the width of the parent container.
  • An integer specifying the width in pixels: The element has a fixed width. If the specified width is greater than the width of the parent container, the width of the element matches the width of the parent container.

Examples

import streamlit as st

code = '''def hello():
    print("Hello, Streamlit!")'''
st.code(code, language="python")
Built with Streamlit 🎈
import streamlit as st
code = '''Is it a crown or boat?
                        ii
                      iiiiii
WWw                 .iiiiiiii.                ...:
 WWWWWWw          .iiiiiiiiiiii.         ........
  WWWWWWWWWWw    iiiiiiiiiiiiiiii    ...........
   WWWWWWWWWWWWWWwiiiiiiiiiiiiiiiii............
    WWWWWWWWWWWWWWWWWWwiiiiiiiiiiiiii.........
     WWWWWWWWWWWWWWWWWWWWWWwiiiiiiiiii.......
      WWWWWWWWWWWWWWWWWWWWWWWWWWwiiiiiii....
       WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWwiiii.
          -MMMWWWWWWWWWWWWWWWWWWWWWWMMM-
'''
st.code(code, language=None)
Built with Streamlit 🎈
Previous: st.captionNext: st.divider
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.