[material_ui] Properly document alwaysUse24HourFormat in MediaQuery

Use case

The showTimePicker API accepts a boolean input called alwaysUse24HourFormat that is used to control the input time clock being displayed in 12 hour (am/pm) or 24 hour format.

Expected behaviour

When time picker is invoked with alwaysUse24HourFormat set to false, the input time clock should "not always have 24 hour format", and therefore should obey the locale (if locale uses 24 hour clock, so should the clock even when alwaysUse24HourFormat=false ).

Actual behaviour

When time picker is invoked with alwaysUse24HourFormat set to false, the input time clock "always has 12 hour format", regardless of the locale.

Proposal

Rename alwaysUse24HourFormat to use24HourFormat to avoid confusion. In that way, it is clear that use24HourFormat=false means that 12h format is always used / enforced.

If that is not possible, the current behaviour of alwaysUse24HourFormat should at least be documented.

@TodorGinchev

Hi @TodorGinchev, thanks for the proposal.

I can't seem to find the alwaysUse24HourFormat property on the showTimePicker. Do you mind pointing that out for me in the docs?

Thank you

Apologies, it is not directly supported through the showTimePicker API, this is how you can set the value of alwaysUse24HourFormat:

await showTimePicker(
      context: context,
      initialTime: TimeOfDay.now(),
      builder: (BuildContext context, Widget? child) {
        return MediaQuery(
          data: MediaQuery.of(context).copyWith(
            alwaysUse24HourFormat: false,
          ),
          child: child!,
        );
      },
    );

@TodorGinchev

Hi @TodorGinchev, I am new to the community and I would like to contribute to this issue. According to your proposal, I could Rename alwaysUse24HourFormat to use24HourFormat to avoid confusion.

This issue is missing a priority label. Please set a priority label when adding the triaged-design label.

I agree with @/goderbauer 's comment:

I don't think the API churn that falls out of this rename is worth it. If necessary, we can update the doc on the property to make it clearer what this means.

Feel free to send a PR to better document this property. Thanks!

Navigation Menu

Repository navigation

[material_ui] Properly document alwaysUse24HourFormat in MediaQuery #89744

Use case

Expected behaviour

Actual behaviour

Proposal

2 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

[material_ui] Properly document alwaysUse24HourFormat in MediaQuery #89744

Description

Use case

Expected behaviour

Actual behaviour

Proposal

Activity

danagbemava-nc commented on Sep 9, 2021

TodorGinchev commented on Sep 9, 2021

arq0017 commented on Sep 15, 2021

2 remaining items

flutter-triage-bot commented on Sep 20, 2026

dkwingsmt commented on Sep 22, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions