Textbox widget with automatic x and y scrollbars, rounded corners, and all text features of the tkinter.Text widget. Scrollbars only appear when needed. Text wraps at line end by default.
Constructor
CTkTextbox(master, width, height, corner_radius, border_width, border_spacing,
bg_color, fg_color, border_color, text_color, scrollbar_button_color,
scrollbar_button_hover_color, font, activate_scrollbars, **kwargs)
Width of the textbox in pixels
Height of the textbox in pixels
Spacing between border and inner text widget
bg_color
str | tuple[str, str]
default:"transparent"
Background color
fg_color
str | tuple[str, str]
default:"theme"
Foreground color of the textbox area
border_color
str | tuple[str, str]
default:"theme"
Border color
text_color
str | tuple[str, str]
default:"theme"
Color of the text
scrollbar_button_color
str | tuple[str, str]
default:"theme"
Color of the scrollbar button
scrollbar_button_hover_color
str | tuple[str, str]
default:"theme"
Hover color of the scrollbar button
font
tuple | CTkFont
default:"default font"
Font of the text
Enable automatic scrollbars when content overflows
Additional tkinter.Text arguments: autoseparators, cursor, exportselection, insertborderwidth, insertofftime, insertontime, insertwidth, maxundo, padx, pady, selectborderwidth, spacing1, spacing2, spacing3, state, tabs, takefocus, undo, wrap, xscrollcommand, yscrollcommand
Methods
CTkTextbox inherits all methods from tkinter.Text. Below are the most commonly used methods:
insert
.insert(index, text, tags=None)
Position to insert text (e.g., “1.0” for beginning, “end” for end)
tags
str | tuple
default:"None"
Optional tags to apply to the inserted text
get
.get(index1, index2=None) -> str
Starting position (e.g., “1.0”)
Ending position (defaults to one character after index1)
delete
.delete(index1, index2=None)
Tag Methods
The following tag methods are inherited from tkinter.Text:
.tag_add(tagName, index1, index2) - Add a tag to text range.tag_config(tagName, **kwargs) - Configure tag appearance (note: font option is forbidden).tag_delete(*tagName) - Delete tags.tag_remove(tagName, index1, index2) - Remove tag from text range.tag_bind(tagName, sequence, func, add=None) - Bind event to tagged text.tag_names(index=None) - Get tag names
Search and Navigation
.search(pattern, index, **kwargs) - Search for text pattern.see(index) - Scroll to make index visible.index(i) - Get canonical index
Edit Methods
.edit_undo() - Undo last change.edit_redo() - Redo last undone change.edit_modified(arg=None) - Get/set modified flag.edit_separator() - Insert undo separator
View Methods
.xview(*args) - Query/modify horizontal view.yview(*args) - Query/modify vertical view
CTkTextbox automatically manages two CTkScrollbar widgets:
- Vertical scrollbar: Appears when content height exceeds widget height
- Horizontal scrollbar: Appears when content width exceeds widget width (requires
wrap="none")
Scrollbars are automatically hidden when not needed and update every 200ms.
Usage Examples
Basic Text Input
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(app, width=400, height=200)
textbox.pack(pady=20, padx=20)
# Insert some text
textbox.insert("1.0", "This is a textbox\nwith multiple lines")
app.mainloop()
Get Text Content
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(app, width=400, height=200)
textbox.pack(pady=20, padx=20)
def get_text():
# Get all text from beginning to end
content = textbox.get("1.0", "end")
print(content)
button = ctk.CTkButton(app, text="Get Text", command=get_text)
button.pack(pady=10)
app.mainloop()
Disable Text Wrapping
import customtkinter as ctk
app = ctk.CTk()
# Set wrap="none" to enable horizontal scrollbar
textbox = ctk.CTkTextbox(app, width=400, height=200, wrap="none")
textbox.pack(pady=20, padx=20)
textbox.insert("1.0", "This is a very long line that will require horizontal scrolling when wrap is disabled")
app.mainloop()
Using Text Tags for Styling
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(app, width=400, height=200)
textbox.pack(pady=20, padx=20)
# Insert text
textbox.insert("1.0", "Normal text\n")
textbox.insert("end", "Bold text\n", "bold")
textbox.insert("end", "Red text\n", "red")
# Configure tags
textbox.tag_config("bold", foreground="white", background="blue")
textbox.tag_config("red", foreground="red")
app.mainloop()
Read-Only Textbox
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(app, width=400, height=200, state="disabled")
textbox.pack(pady=20, padx=20)
# To insert text in disabled state:
textbox.configure(state="normal")
textbox.insert("1.0", "This text cannot be edited")
textbox.configure(state="disabled")
app.mainloop()
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(
app,
width=400,
height=200,
scrollbar_button_color="#0066cc",
scrollbar_button_hover_color="#0052a3"
)
textbox.pack(pady=20, padx=20)
# Add enough text to trigger scrollbar
for i in range(30):
textbox.insert("end", f"Line {i+1}\n")
app.mainloop()
Undo/Redo Support
import customtkinter as ctk
app = ctk.CTk()
textbox = ctk.CTkTextbox(app, width=400, height=200, undo=True)
textbox.pack(pady=20, padx=20)
undo_btn = ctk.CTkButton(app, text="Undo", command=textbox.edit_undo)
undo_btn.pack(side="left", padx=5)
redo_btn = ctk.CTkButton(app, text="Redo", command=textbox.edit_redo)
redo_btn.pack(side="left", padx=5)
app.mainloop()
Text Widget Indices
When working with text methods, indices use the format "line.column":
"1.0" - Beginning of the first line"end" - End of all text"insert" - Current cursor position"2.5" - Line 2, column 5
For detailed tkinter.Text documentation, see: https://anzeljg.github.io/rin2/book2/2405/docs/tkinter/text.html