---
tags: [gradio-custom-component, ]
title: gradio_buttontip_component
short_description: A gradio custom component
colorFrom: blue
colorTo: yellow
sdk: gradio
pinned: false
app_file: space.py
---
# `gradio_buttontip_component`
<a href="https://pypi.org/project/gradio_buttontip_component/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/gradio_buttontip_component"></a>
Python library for easily interacting with trained machine learning models
## Installation
```bash
pip install gradio_buttontip_component
```
## Usage
```python
import gradio as gr
from gradio_buttontip_component import buttontip_component
def button_click(a,b):
return "Button clicked!"
demo = gr.Interface(
title="Button with Tooltip",
description="This interface showcases a button with a tooltip.",
fn=button_click,
inputs=[
# If X and Y are not set, the tip will be center-top aligned with the button
buttontip_component(
tooltip="Tooltip Text",
tooltip_color="white", # Custom color
tooltip_background_color="red",
value="Top Button"
),
# Change X, Y values to position the tooltip
buttontip_component(
tooltip="Tooltip Text",
tooltip_color="white", # Custom color
tooltip_background_color="green",
x=50, # No horizontal offset
y=-20, # Below the button
value="Bottom Button"
)
],
outputs="text",
)
if __name__ == "__main__":
demo.launch()
```
## `buttontip_component`
### Initialization
<table>
<thead>
<tr>
<th align="left">name</th>
<th align="left" style="width: 25%;">type</th>
<th align="left">default</th>
<th align="left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
str | Callable
```
</td>
<td align="left"><code>"Run"</code></td>
<td align="left">Default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
Timer | float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>
</tr>
<tr>
<td align="left"><code>inputs</code></td>
<td align="left" style="width: 25%;">
```python
Component | Sequence[Component] | set[Component] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>
</tr>
<tr>
<td align="left"><code>variant</code></td>
<td align="left" style="width: 25%;">
```python
Literal["primary", "secondary", "stop"]
```
</td>
<td align="left"><code>"secondary"</code></td>
<td align="left">'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.</td>
</tr>
<tr>
<td align="left"><code>size</code></td>
<td align="left" style="width: 25%;">
```python
Literal["sm", "lg"] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Size of the button. Can be "sm" or "lg".</td>
</tr>
<tr>
<td align="left"><code>icon</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">URL or path to the icon file to display within the button. If None, no icon will be displayed.</td>
</tr>
<tr>
<td align="left"><code>link</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">URL to open when the button is clicked. If None, no link will be used.</td>
</tr>
<tr>
<td align="left"><code>visible</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will be hidden.</td>
</tr>
<tr>
<td align="left"><code>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, the ButtonTip will be in a disabled state.</td>
</tr>
<tr>
<td align="left"><code>elem_id</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>elem_classes</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>render</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
</tr>
<tr>
<td align="left"><code>key</code></td>
<td align="left" style="width: 25%;">
```python
int | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>
</tr>
<tr>
<td align="left"><code>scale</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>
</tr>
<tr>
<td align="left"><code>min_width</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>
</tr>
<tr>
<td align="left"><code>tooltip</code></td>
<td align="left" style="width: 25%;">
```python
str
```
</td>
<td align="left"><code>None</code></td>
<td align="left">None</td>
</tr>
<tr>
<td align="left"><code>tooltip_color</code></td>
<td align="left" style="width: 25%;">
```python
str
```
</td>
<td align="left"><code>"#fff"</code></td>
<td align="left">None</td>
</tr>
<tr>
<td align="left"><code>tooltip_background_color</code></td>
<td align="left" style="width: 25%;">
```python
str
```
</td>
<td align="left"><code>"#000"</code></td>
<td align="left">None</td>
</tr>
<tr>
<td align="left"><code>x</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Horizontal offset of the tooltip from the button.</td>
</tr>
<tr>
<td align="left"><code>y</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Vertical offset of the tooltip from the button.</td>
</tr>
</tbody></table>
### Events
| name | description |
|:-----|:------------|
| `click` | Triggered when the buttontip_component is clicked. |
### User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- **As output:** Is passed, (Rarely used) the `str` corresponding to the button label when the button is clicked.
- **As input:** Should return, string corresponding to the button label.
```python
def predict(
value: str | None
) -> str | None:
return value
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gradio-buttontip-component",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "gradio-custom-component, gradio-template-Fallback",
"author": null,
"author_email": "YOUR NAME <YOUREMAIL@domain.com>",
"download_url": "https://files.pythonhosted.org/packages/0c/b9/acc8ab70e34e56e312eaa2c89023362816fb6504318fe3a8808d60d49f12/gradio_buttontip_component-0.0.2.tar.gz",
"platform": null,
"description": "---\ntags: [gradio-custom-component, ]\ntitle: gradio_buttontip_component\nshort_description: A gradio custom component\ncolorFrom: blue\ncolorTo: yellow\nsdk: gradio\npinned: false\napp_file: space.py\n---\n\n# `gradio_buttontip_component`\n<a href=\"https://pypi.org/project/gradio_buttontip_component/\" target=\"_blank\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/gradio_buttontip_component\"></a> \n\nPython library for easily interacting with trained machine learning models\n\n## Installation\n\n```bash\npip install gradio_buttontip_component\n```\n\n## Usage\n\n```python\n\nimport gradio as gr\nfrom gradio_buttontip_component import buttontip_component\n\n\ndef button_click(a,b):\n return \"Button clicked!\"\n\ndemo = gr.Interface(\n title=\"Button with Tooltip\",\n description=\"This interface showcases a button with a tooltip.\",\n fn=button_click,\n inputs=[\n # If X and Y are not set, the tip will be center-top aligned with the button\n buttontip_component(\n tooltip=\"Tooltip Text\",\n tooltip_color=\"white\", # Custom color\n tooltip_background_color=\"red\",\n value=\"Top Button\"\n ),\n # Change X, Y values to position the tooltip\n buttontip_component(\n tooltip=\"Tooltip Text\",\n tooltip_color=\"white\", # Custom color\n tooltip_background_color=\"green\",\n x=50, # No horizontal offset\n y=-20, # Below the button\n value=\"Bottom Button\"\n )\n ],\n outputs=\"text\",\n)\n\n\nif __name__ == \"__main__\":\n demo.launch()\n\n```\n\n## `buttontip_component`\n\n### Initialization\n\n<table>\n<thead>\n<tr>\n<th align=\"left\">name</th>\n<th align=\"left\" style=\"width: 25%;\">type</th>\n<th align=\"left\">default</th>\n<th align=\"left\">description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | Callable\n```\n\n</td>\n<td align=\"left\"><code>\"Run\"</code></td>\n<td align=\"left\">Default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nTimer | float | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>inputs</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nComponent | Sequence[Component] | set[Component] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>variant</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"primary\", \"secondary\", \"stop\"]\n```\n\n</td>\n<td align=\"left\"><code>\"secondary\"</code></td>\n<td align=\"left\">'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>size</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\"sm\", \"lg\"] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Size of the button. Can be \"sm\" or \"lg\".</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>icon</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">URL or path to the icon file to display within the button. If None, no icon will be displayed.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>link</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">URL to open when the button is clicked. If None, no link will be used.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>visible</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will be hidden.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>interactive</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, the ButtonTip will be in a disabled state.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_id</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_classes</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>render</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>key</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>scale</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>min_width</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>tooltip</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">None</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>tooltip_color</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr\n```\n\n</td>\n<td align=\"left\"><code>\"#fff\"</code></td>\n<td align=\"left\">None</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>tooltip_background_color</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr\n```\n\n</td>\n<td align=\"left\"><code>\"#000\"</code></td>\n<td align=\"left\">None</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>x</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Horizontal offset of the tooltip from the button.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>y</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Vertical offset of the tooltip from the button.</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `click` | Triggered when the buttontip_component is clicked. |\n\n\n\n### User function\n\nThe impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).\n\n- When used as an Input, the component only impacts the input signature of the user function.\n- When used as an output, the component only impacts the return signature of the user function.\n\nThe code snippet below is accurate in cases where the component is used as both an input and an output.\n\n- **As output:** Is passed, (Rarely used) the `str` corresponding to the button label when the button is clicked.\n- **As input:** Should return, string corresponding to the button label.\n\n ```python\n def predict(\n value: str | None\n ) -> str | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for easily interacting with trained machine learning models",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"gradio-custom-component",
" gradio-template-fallback"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4336bcca7668f4a8de43a7d9d24788f21aa3c1dc52a4b1c9f85b367bf958f86b",
"md5": "1f2393abf76b66f332e4125155545c0d",
"sha256": "e991c5cbccffae381a181400ff77d7948257bfa7f84a2fd2e2870dfb1c8996e1"
},
"downloads": -1,
"filename": "gradio_buttontip_component-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f2393abf76b66f332e4125155545c0d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14636,
"upload_time": "2024-10-07T02:01:27",
"upload_time_iso_8601": "2024-10-07T02:01:27.168745Z",
"url": "https://files.pythonhosted.org/packages/43/36/bcca7668f4a8de43a7d9d24788f21aa3c1dc52a4b1c9f85b367bf958f86b/gradio_buttontip_component-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0cb9acc8ab70e34e56e312eaa2c89023362816fb6504318fe3a8808d60d49f12",
"md5": "5729e166cd83fabfccde180500ca62e1",
"sha256": "ff0147e23cc713af315d55bd355a908210a294c8f3e26068b146cb899eaf4bc4"
},
"downloads": -1,
"filename": "gradio_buttontip_component-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5729e166cd83fabfccde180500ca62e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 61936,
"upload_time": "2024-10-07T02:01:29",
"upload_time_iso_8601": "2024-10-07T02:01:29.313402Z",
"url": "https://files.pythonhosted.org/packages/0c/b9/acc8ab70e34e56e312eaa2c89023362816fb6504318fe3a8808d60d49f12/gradio_buttontip_component-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 02:01:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gradio-buttontip-component"
}
JSON