Skip to content

☕  Buy Me a Coffee Button

Submitted by Zachary Blackwood

Summary

Adds a floating button which links to your Buy Me a Coffee page

Functions

button

Display a button which links to your Buy Me a Coffee page.

Parameters:

Name Type Description Default
username str

Buy Me a Coffee username

 required
floating bool

Whether the button should be floating. Defaults to True.

 True
text str

Text to show on the button. Defaults to "Buy me a coffee".

 'Buy me a coffee'
emoji str

Emoji to show on the button. Defaults to "".

 ''
bg_color str

Background of the button. Defaults to "#FFDD00".

 '#FFDD00'
font Font

Font of the button. Defaults to "Cookie".

 'Cookie'
font_color str

Font color. Defaults to "#000000".

 '#000000'
coffee_color str

Coffee icon color. Defaults to "#000000".

 '#000000'
width int

Width of the button. Defaults to 220.

 220
Source code in src/streamlit_extras/buy_me_a_coffee/__init__.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
@extra
def button(
    username: str,
    floating: bool = True,
    text: str = "Buy me a coffee",
    emoji: str = "",
    bg_color: str = "#FFDD00",
    font: Font = "Cookie",
    font_color: str = "#000000",
    coffee_color: str = "#000000",
    width: int = 220,
):
    """
    Display a button which links to your Buy Me a Coffee page.

    Args:
        username (str): Buy Me a Coffee username
        floating (bool, optional): Whether the button should be floating. Defaults to True.
        text (str, optional): Text to show on the button. Defaults to "Buy me a coffee".
        emoji (str, optional): Emoji to show on the button. Defaults to "".
        bg_color (str, optional): Background of the button. Defaults to "#FFDD00".
        font (Font, optional): Font of the button. Defaults to "Cookie".
        font_color (str, optional): Font color. Defaults to "#000000".
        coffee_color (str, optional): Coffee icon color. Defaults to "#000000".
        width (int, optional): Width of the button. Defaults to 220.
    """ """"""
    button = f"""
        <script type="text/javascript"
            src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js"
            data-name="bmc-button"
            data-slug="{username}"
            data-color="{bg_color}"
            data-emoji="{emoji}"
            data-font="{font}"
            data-text="{text}"
            data-outline-color="#000000"
            data-font-color="{font_color}"
            data-coffee-color="{coffee_color}" >
        </script>
    """

    html(button, height=70, width=width)

    if floating:
        st.markdown(
            f"""
            <style>
                iframe[width="{width}"] {{
                    position: fixed;
                    bottom: 60px;
                    right: 40px;
                }}
            </style>
            """,
            unsafe_allow_html=True,
        )

Import:

from streamlit_extras.buy_me_a_coffee import button # (1)!
  1. You should add this to the top of your .py file 🛠

Examples

example

def example():
    button(username="fake-username", floating=False, width=221)
Output (beta)