gradio-flatpickr-calendar 0.0.4

Gradio component for selecting dates or ranges of dates with a Flatpickr calendar 📆

gradio_flatpickr_calendar

Gradio component for selecting dates or ranges of dates with a Flatpickr calendar 📆

Installation

pip install gradio_flatpickr_calendar

Usage

import gradio as gr
from gradio_flatpickr_calendar import Calendar
import datetime


def predict(date: datetime.datetime | tuple[datetime.datetime, datetime.datetime]) \
        -> datetime.datetime | tuple[datetime.datetime, datetime.datetime]:
    print("prediction")
    return date


demo = gr.Interface(fn=predict,
                    inputs=[Calendar(label="Select a date or a range of dates",
                                     info="Click to bring up the calendar.",
                                     mode="range", type="datetime")],
                    outputs=Calendar(label="Selected date(s)", info="Here are the date(s) you selected:"),
                    examples=["2023-01-01", ("2023-01-01", "2023-12-11")],
                    cache_examples=True,
                    title="Choose a date")

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

Calendar

Initialization

name	type	default	description
value	str | datetime.datetime	None	None
type	"string" | "datetime"	"datetime"	None
mode	"date" | "range"	"date"	None
label	str | None	None	None
info	str | None	None	None
show_label	bool | None	None	None
container	bool	True	None
scale	int | None	None	None
min_width	int | None	None	None
interactive	bool | None	None	None
visible	bool	True	None
elem_id	str | None	None	None
elem_classes	list[str] | str | None	None	None
render	bool	True	None
load_fn	typing.Optional[typing.Callable[..., typing.Any]][ typing.Callable[..., typing.Any][Ellipsis, typing.Any], None, ]	None	None
every	float | None	None	None
date_format	str	"%Y-%m-%d"	None

Events

name	description
change
input
submit

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, the preprocessed input data sent to the user's function in the backend.
• As input: Should return, the output data received by the component from the user's function in the backend.

def predict(
    value: str
   | datetime.datetime
   | tuple[str, str]
   | tuple[datetime.datetime, datetime.datetime]
   | None
) -> str
   | datetime.datetime
   | tuple[str, str]
   | tuple[datetime.datetime, datetime.datetime]
   | None:
    return value