Struct DatetimeLocaleProps 

pub struct DatetimeLocaleProps {
    pub locale: Signal<Locale>,
    pub default_format: Signal<DatetimeFormat>,
    pub default_timezone: Signal<DatetimeTimezone>,
    pub reference_date: Signal<OrbitalDateTime>,
    pub children: Children,
}

Props for the DatetimeLocale component.

Provides locale, format, timezone, and reference-date defaults to picker subtrees.

Timezone

default_timezone supplies the fallback wall-clock zone for child pickers that do not set appearance.timezone explicitly. Prefer explicit appearance.timezone on each picker when the zone is user-controlled (e.g. UTC vs local).

When to use

• Wrap date/time picker pages so child components share locale defaults
• Set a reference calendar day for time-only pickers
• Share defaults with SchedulerCalendar event dialogs in orbital-scheduler that compose DateTimePicker

Usage

Wrap picker content and read defaults via use_datetime_locale.

Best Practices

Do’s

• Mount the same DatetimeLocale on server and client with matching signals for SSR.

Don’ts

• Do not confuse Locale (format tag) with scheduler toolbar strings — those use SchedulerLocaleText in orbital-scheduler.

Examples

Default locale shell

Provides baseline locale context and a calendar using localized weekday headers.

use orbital_base_components::{DatetimeFormat, DatetimeTimezone, OrbitalDateTime, TryFromUnixSeconds};
use crate::preview::{PickerPreviewExample, PickerPreviewKnobs};
use crate::DateCalendar;
let locale = Signal::from(Locale::from("fr-FR"));
let default_format = Signal::from(DatetimeFormat::IsoDate);
let default_timezone = Signal::from(DatetimeTimezone::Local);
let reference_date = Signal::from(
    OrbitalDateTime::try_from_unix_seconds(1_735_689_600, DatetimeTimezone::Local).expect("valid"),
);
let value = RwSignal::new(None::<OrbitalDateTime>);
view! {
    <PickerPreviewExample data_testid="datetime-locale-preview">
        <PickerPreviewKnobs />
        <DatetimeLocale
            locale=locale
            default_format=default_format
            default_timezone=default_timezone
            reference_date=reference_date
        >
            <DateCalendar bind=value />
            <p data-testid="datetime-locale-weekday-sample">
                {move || use_datetime_locale_strings().weekday_header_labels()[0].clone()}
            </p>
        </DatetimeLocale>
    </PickerPreviewExample>
}

Required Props

• children: Children
  • Subtree that consumes locale defaults.

Optional Props

• locale: Signal<Locale>
  • BCP-47 or Orbital locale id for month names, weekday labels, first day of week.
• default_format: Signal<DatetimeFormat>
  • Default display/parse format when appearance does not override.
• default_timezone: Signal<DatetimeTimezone>
  • Default timezone for new values and parsing.
• reference_date: Signal<OrbitalDateTime>
  • Reference calendar day for time-only pickers.

Fields

locale: Signal<Locale>

BCP-47 or Orbital locale id for month names, weekday labels, first day of week.

default_format: Signal<DatetimeFormat>

Default display/parse format when appearance does not override.

default_timezone: Signal<DatetimeTimezone>

Default timezone for new values and parsing.

reference_date: Signal<OrbitalDateTime>

Reference calendar day for time-only pickers.

children: Children

Subtree that consumes locale defaults.

Implementations

impl DatetimeLocaleProps

pub fn builder() -> DatetimeLocalePropsBuilder<((), (), (), (), ())>

Create a builder for building DatetimeLocaleProps. On the builder, call .locale(...)(optional), .default_format(...)(optional), .default_timezone(...)(optional), .reference_date(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of DatetimeLocaleProps.

Trait Implementations

impl Props for DatetimeLocaleProps

type Builder = DatetimeLocalePropsBuilder

fn builder() -> Self::Builder