DateTime

The DateTime component allows users to select dates and optionally times.

Basic usage

import gradio as gr

def process_date(dt):
    return f"Selected: {dt}"

gr.Interface(
    fn=process_date,
    inputs=gr.DateTime(),
    outputs=gr.Textbox()
).launch()

Constructor

float | str | datetime | None

default:"None"

Default datetime value

bool

default:"True"

Whether to include time selection. If False, only date is selectable

Literal['timestamp', 'datetime', 'string']

default:"'timestamp'"

Return format:

"timestamp" - Unix timestamp (seconds since epoch)
"datetime" - Python datetime object
"string" - Formatted string

str | None

default:"None"

Timezone (e.g., “US/Pacific”, “Europe/Paris”). If None, uses local timezone

str | None

default:"None"

Label displayed above component

bool | None

default:"None"

Whether datetime can be changed

Events

change - Triggered when datetime changes
submit - Triggered when datetime is submitted

Examples

Date only

import gradio as gr

gr.DateTime(
    include_time=False,
    label="Select a date"
)

With timezone

import gradio as gr

gr.DateTime(
    include_time=True,
    timezone="US/Pacific",
    label="Pacific Time"
)

Return as datetime object

import gradio as gr
from datetime import datetime

def format_date(dt):
    return dt.strftime("%A, %B %d, %Y at %I:%M %p")

gr.Interface(
    fn=format_date,
    inputs=gr.DateTime(type="datetime"),
    outputs=gr.Textbox()
).launch()

Overview

Input Components

Output Components

Layout Components

Control Components

Special Components

Basic usage

Constructor

Events

Examples

Date only

With timezone

Return as datetime object

​Basic usage

​Constructor

​Events

​Examples

​Date only

​With timezone

​Return as datetime object

Basic usage

Constructor

Events

Examples

Date only

With timezone

Return as datetime object