Giter VIP home page Giter VIP logo

gradio-range-slider's Introduction

tags title short_description colorFrom colorTo sdk pinned app_file
gradio-custom-component
Slider
leaderboards
forms
filtering
slider
gradio_rangeslider
๐Ÿ› Slider component for selecting a range of values
blue
yellow
gradio
false
app.py

gradio_rangeslider

Static Badge

๐Ÿ› Slider component for selecting a range of values.

Installation

pip install gradio_rangeslider

Usage

The RangeSlider functions similarly to the core Gradio Slider except that it shows two draggable thumbtracks. The value of the component is a tuple of the two endpoints of the range.

import gradio as gr
from gradio_rangeslider import RangeSlider

text = "## The range is: {min} to {max}"

with gr.Blocks() as demo:
    gr.Markdown("""## ๐Ÿ› RangeSlider
    Drag either end and see the selected endpoints update in real-time.
    """) 
    range_slider = RangeSlider(minimum=0, maximum=100, value=(0, 100))
    range_ = gr.Markdown(value=text.format(min=0, max=100))
    range_slider.change(lambda s: text.format(min=s[0], max=s[1]), range_slider, range_,
                        show_progress="hide")



if __name__ == "__main__":
    demo.launch()

RangeSlider

Initialization

name type default description
minimum
float
0 minimum value for slider.
maximum
float
100 maximum value for slider.
value
tuple[float, float] | Callable | None
None default value. If callable, the function will be called whenever the app loads to set the initial value of the component. Ignored if randomized=True.
step
float | None
None increment between slider values.
label
str | None
None The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.
info
str | None
None additional component description.
every
float | None
None If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
show_label
bool | None
None if True, will display label.
container
bool
True If True, will place the component in a container - providing some extra padding around the border.
scale
int | None
None 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.
min_width
int
160 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.
interactive
bool | None
None if True, slider will be adjustable; if False, adjusting will be disabled. If not provided, this is inferred based on whether the component is used as an input or output.
visible
bool
True If False, component will be hidden.
elem_id
str | None
None An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes
list[str] | str | None
None 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.
render
bool
True 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.

Events

name description
change Triggered when the value of the RangeSlider changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.
input This listener is triggered when the user changes the value of the RangeSlider.

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, passes slider value as a {float} into the function.
  • As input: Should return, expects an {int} or {float} returned from function and sets slider value to it as long as it is within range (otherwise, sets to minimum value).
def predict(
    value: tuple[float, float]
) -> tuple[float, float] | None:
    return value

gradio-range-slider's People

Contributors

freddyaboulton avatar

Stargazers

Henry Ruhs avatar

Watchers

 avatar

gradio-range-slider's Issues

Gradio styling not respected

Please respect the Gradio styles and reuse their classes.

Screenshot from 2024-05-30 14-29-25

After our modifications at FF it looks worse, I only modify on a input=["range"] level:

Screenshot from 2024-05-30 14-29-32

Introduce release event

I think having a release event like the original sliders is a nice to have, those are needed for certain edge cases.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.