`gradio_calendar`

Gradio component for selecting dates with a calendar 📆

Installation

pip install gradio_calendar

Usage

import gradio as gr
from gradio_calendar import Calendar
import datetime

def is_weekday(date: datetime.datetime):
    return date.weekday() < 5

demo = gr.Interface(is_weekday, 
    [Calendar(type="datetime", label="Select a date", info="Click the calendar icon to bring up the calendar.")], 
    gr.Label(label="Is it a weekday?"),
    examples=["2023-01-01", "2023-12-11"],
    cache_examples=True,
    title="Is it a weekday?")

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

`Calendar`

Initialization

name	type	default	description
`value`	`str \| datetime.datetime`	`None`	None
`type`	`"string" \| "datetime"`	`"datetime"`	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`	`Callable[Ellipsis, Any] \| None`	`None`	None
`every`	`float \| None`	`None`	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.

def predict(
    value: str | datetime.datetime | None
) -> str | datetime.datetime | None:
    return value