Tabview widget that provides a tabbed interface using a segmented button for tab navigation. Each tab is a CTkFrame where you can add widgets.
Constructor
CTkTabview(master, width, height, corner_radius, border_width, bg_color,
fg_color, border_color, segmented_button_fg_color,
segmented_button_selected_color, segmented_button_selected_hover_color,
segmented_button_unselected_color, segmented_button_unselected_hover_color,
text_color, text_color_disabled, command, anchor, state)
Width of the tabview in pixels
Height of the tabview in pixels
bg_color
str | tuple[str, str]
default:"transparent"
Background color
fg_color
str | tuple[str, str]
default:"theme"
Foreground color of the tab content area
border_color
str | tuple[str, str]
default:"theme"
Border color
segmented_button_fg_color
str | tuple[str, str]
default:"theme"
Background color of the segmented button
segmented_button_selected_color
str | tuple[str, str]
default:"theme"
Color of the selected tab button
segmented_button_selected_hover_color
str | tuple[str, str]
default:"theme"
Hover color of the selected tab button
segmented_button_unselected_color
str | tuple[str, str]
default:"theme"
Color of unselected tab buttons
segmented_button_unselected_hover_color
str | tuple[str, str]
default:"theme"
Hover color of unselected tab buttons
text_color
str | tuple[str, str]
default:"theme"
Text color of tab buttons
text_color_disabled
str | tuple[str, str]
default:"theme"
Text color when tab buttons are disabled
Callback function called when tab is changed
Position of the tab buttons: “n” (top), “s” (bottom), “w”, “e”, “nw”, “ne”, “sw”, “se”, “center”
State of the tab buttons: “normal” or “disabled”
Methods
add
Add a new tab at the end of the tab list.
Unique name for the tab. Raises ValueError if name already exists
insert
.insert(index, name) -> CTkFrame
Position to insert the tab (0-based)
delete
Delete a tab by name.
Name of the tab to delete. Raises ValueError if tab doesn’t exist
set
Programmatically select a tab by name.
Name of the tab to select. Raises ValueError if tab doesn’t exist
get
Get the name of the currently selected tab. Returns empty string if no tab is selected.
tab
Get a reference to a specific tab’s frame.
Name of the tab. Raises ValueError if tab doesn’t exist
index
Get the index position of a tab.
move
Move a tab to a new position.
rename
.rename(old_name, new_name)
New name for the tab. Raises ValueError if new_name already exists
cget
.cget(attribute_name) -> any
Usage Examples
Basic Tabview
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=400, height=300)
tabview.pack(pady=20, padx=20)
# Add tabs
tab1 = tabview.add("Tab 1")
tab2 = tabview.add("Tab 2")
tab3 = tabview.add("Tab 3")
# Add widgets to tabs
label1 = ctk.CTkLabel(tab1, text="Content of Tab 1")
label1.pack(pady=20)
label2 = ctk.CTkLabel(tab2, text="Content of Tab 2")
label2.pack(pady=20)
label3 = ctk.CTkLabel(tab3, text="Content of Tab 3")
label3.pack(pady=20)
app.mainloop()
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=500, height=400)
tabview.pack(pady=20, padx=20)
# Create tabs
settings_tab = tabview.add("Settings")
about_tab = tabview.add("About")
# Add content to Settings tab
ctk.CTkLabel(settings_tab, text="Application Settings", font=("Arial", 16, "bold")).pack(pady=10)
ctk.CTkLabel(settings_tab, text="Theme:").pack(pady=5)
ctk.CTkOptionMenu(settings_tab, values=["Dark", "Light"]).pack(pady=5)
# Add content to About tab
ctk.CTkLabel(about_tab, text="About This App", font=("Arial", 16, "bold")).pack(pady=10)
ctk.CTkLabel(about_tab, text="Version 1.0.0").pack(pady=5)
ctk.CTkButton(about_tab, text="Visit Website").pack(pady=10)
app.mainloop()
Programmatic Tab Selection
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=400, height=300)
tabview.pack(pady=20, padx=20)
tabview.add("Home")
tabview.add("Profile")
tabview.add("Settings")
# Set default tab
tabview.set("Profile")
# Add button to switch tabs
def go_to_settings():
tabview.set("Settings")
button = ctk.CTkButton(app, text="Go to Settings", command=go_to_settings)
button.pack(pady=10)
app.mainloop()
Tab Change Callback
import customtkinter as ctk
app = ctk.CTk()
def on_tab_change():
current = tabview.get()
print(f"Switched to: {current}")
status_label.configure(text=f"Current tab: {current}")
tabview = ctk.CTkTabview(
app,
width=400,
height=300,
command=on_tab_change
)
tabview.pack(pady=20, padx=20)
tabview.add("Tab 1")
tabview.add("Tab 2")
tabview.add("Tab 3")
status_label = ctk.CTkLabel(app, text="Current tab: Tab 1")
status_label.pack(pady=10)
app.mainloop()
Dynamic Tab Management
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=500, height=350)
tabview.pack(pady=20, padx=20, fill="both", expand=True)
# Initial tabs
tabview.add("Tab 1")
tabview.add("Tab 2")
# Control frame
control_frame = ctk.CTkFrame(app)
control_frame.pack(pady=10, padx=20, fill="x")
tab_counter = [3] # Using list to allow modification in nested function
def add_tab():
tabview.add(f"Tab {tab_counter[0]}")
tab_counter[0] += 1
def delete_current_tab():
current = tabview.get()
if current:
tabview.delete(current)
ctk.CTkButton(control_frame, text="Add Tab", command=add_tab).pack(side="left", padx=5)
ctk.CTkButton(control_frame, text="Delete Current", command=delete_current_tab).pack(side="left", padx=5)
app.mainloop()
Tabs at Bottom
import customtkinter as ctk
app = ctk.CTk()
# Place tab buttons at the bottom
tabview = ctk.CTkTabview(
app,
width=400,
height=300,
anchor="s" # South = bottom
)
tabview.pack(pady=20, padx=20)
tabview.add("Home")
tabview.add("Search")
tabview.add("Profile")
app.mainloop()
Custom Tab Colors
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(
app,
width=400,
height=300,
segmented_button_selected_color="#0066cc",
segmented_button_selected_hover_color="#0052a3",
segmented_button_unselected_color="#333333",
segmented_button_unselected_hover_color="#444444",
text_color="white"
)
tabview.pack(pady=20, padx=20)
tabview.add("Tab 1")
tabview.add("Tab 2")
tabview.add("Tab 3")
app.mainloop()
Accessing Tab Frames Later
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=400, height=300)
tabview.pack(pady=20, padx=20)
tabview.add("Dashboard")
tabview.add("Reports")
tabview.add("Settings")
# Access tab frame later to add widgets
dashboard_frame = tabview.tab("Dashboard")
ctk.CTkLabel(dashboard_frame, text="Welcome to Dashboard").pack(pady=20)
reports_frame = tabview.tab("Reports")
ctk.CTkButton(reports_frame, text="Generate Report").pack(pady=20)
app.mainloop()
Insert Tab at Specific Position
import customtkinter as ctk
app = ctk.CTk()
tabview = ctk.CTkTabview(app, width=400, height=300)
tabview.pack(pady=20, padx=20)
tabview.add("First")
tabview.add("Third")
# Insert tab at index 1 (between First and Third)
middle_tab = tabview.insert(1, "Second")
ctk.CTkLabel(middle_tab, text="This is the second tab").pack(pady=20)
app.mainloop()
Tab Management Notes
- Tab names must be unique within a tabview
- When the last tab is deleted, the segmented button is hidden
- When only one tab exists, it is automatically selected
- The first tab added is automatically selected
- Deleting the current tab automatically selects the first remaining tab
- All tab frames have
border_width=0 and corner_radius=0 by default