Skip to content

Add alignment options for title and caption (#110) #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add alignment options for title and caption (#110) #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions src/rich_cli/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,9 +377,13 @@ class OptionHighlighter(RegexHighlighter):
@click.option(
"--title", metavar="TEXT", default="", help="Set panel title to [b]TEXT[/]."
)
@click.option("--title-left", is_flag=True, help="Align title to left.")
@click.option("--title-right", is_flag=True, help="Align title to right.")
@click.option(
"--caption", metavar="TEXT", default="", help="Set panel caption to [b]TEXT[/]."
)
@click.option("--caption-left", is_flag=True, help="Align caption to left.")
@click.option("--caption-right", is_flag=True, help="Align caption to right.")
@click.option(
"--force-terminal",
is_flag=True,
Expand Down Expand Up @@ -431,7 +435,11 @@ def main(
panel: str = "",
panel_style: str = "",
title: str = "",
title_left: bool = False,
title_right: bool = False,
caption: str = "",
caption_left: bool = False,
caption_right: bool = False,
theme: str = "",
line_numbers: bool = False,
guides: bool = False,
Expand Down Expand Up @@ -664,15 +672,29 @@ def print_usage() -> None:
except Exception as error:
on_error("unable to parse panel style", error)

renderable = Panel(
renderable,
getattr(box, panel.upper()),
panel_kwargs = dict(
expand=expand,
title=title,
subtitle=caption,
border_style=render_border_style,
)

if title_left or title_right:
if title_left and title_right:
on_error("cannot specify left and right title alignment")
panel_kwargs["title_align"] = "left" if title_left else "right"

if caption_left or caption_right:
if caption_left and caption_right:
on_error("cannot specify left and right caption alignment")
panel_kwargs["subtitle_align"] = "left" if caption_left else "right"

renderable = Panel(
renderable,
getattr(box, panel.upper()),
**panel_kwargs,
)

if style:
from rich.style import Style
from rich.styled import Styled
Expand Down