about summary refs log tree commit diff
path: root/src/term/link.py
blob: cd75b1690006bde458113ff8af6c91ee4a164f35 (plain) (blame)
1
2
3
4
5
6
7
8
9
def link(text: str, url: str) -> str:
    """Link returns a formatted string that represents a hyperlink.
    The hyperlink is created using the escape sequence for terminal emulators.
    The text parameter represents the visible text of the hyperlink,
    and the url parameter represents the URL that the hyperlink points to.
For more information on the escape sequence, refer to:
    https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#the-escape-sequence
    """
    return f""\x1b]8;;{url}\x07{text}\x1b]8;;\x07\u001b[0m""