angular / angular/components

feat(date/timepicker): Enhance DateAdapter to accept diffetent types for date and time

Ouverte
#33,276 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
area: material/datepicker feature gemini-triaged P3
Langage dominant
TypeScript
Étoiles
25k
Forks
6.8k
Merge moyen
1 j 8 h
PR mergées (30 j)
91

Description

### Feature Description

Currently `DateAdapter` is designed to work with instances of the same time for date and time, this is how JavaScript Date works and many other replacement libraries do too. Many libraries have noticed this is not always desirable. Java got the external Joda-Time library that became the model for the modern java.time replacement. On the JavaScript side I use js-joda, a port of the original Java Joda-Time library

Much like the new Temporal API, these libraries have aditional split representations of a date and a time, `LocalDate` and `LocalTime` and `LocalDateTime` when you need both without a timezone attached to it.

The Temporal API, brings these kind of types to JavaScript with `PlainDate`, `PlainTime` and `PlainDateTime` (better naming than the Local prefix).

`DateAdapter` is not designed to have a date picker with a LocalDate/PlainDate and a time picker with a LocalTime/PlainTime. Yes you can make it work but it requires a few hacks, for example the time parts on my js-joda adapter.

```ts
isDateInstance(obj: unknown): boolean {
return obj instanceof LocalDate || obj instanceof LocalTime;
}

isValid(date: LocalDate): boolean {
return date !== INVALID_VALUE;
}

invalid(): LocalDate {
return INVALID_VALUE;
}

override compareDate(first: LocalDate, second: LocalDate): number {
return first.compareTo(second);
}

override sameDate(first: LocalDate | null, second: LocalDate | null): boolean {
if (first != null && second != null) {
// WORKAROUND to allow generating the list of times in the time picker
if (first instanceof LocalTime && second instanceof LocalTime) {
return true;
}
return first.equals(second);
}
return (first ?? null) === (second ?? null);
}

override setTime(_target: LocalDate, hours: number, minutes: number, seconds: number): LocalDate {
return LocalTime.of(hours, minutes, seconds) as unknown as LocalDate;
}

override getHours(date: LocalDate): number {
return (date as unknown as LocalTime).hour();
}

override getMinutes(date: LocalDate): number {
return (date as unknown as LocalTime).minute();
}

override getSeconds(date: LocalDate): number {
return (date as unknown as LocalTime).second();
}

override addSeconds(date: LocalDate, amount: number): LocalDate {
const time = date as unknown as LocalTime;

const remainingSeconds = SECONDS_PER_DAY - time.toSecondOfDay();
if (remainingSeconds < amount) {
return INVALID_VALUE;
}

return time.plusSeconds(amount) as unknown as LocalDate;
}
```

Notice there is a lot of unsafe casting because the subclass extends `DateAdapter`, it will have less casting if it was `DateAdapter` but that would need more type checks on methods exclusively used by the date picker.

The API changes required are resumed in:

- The adapter should be split in two or have a different type for the time. I prefer to split the adapter, because that way there could be multiple combinations of adapters for PlainDate, PlainTime, Instant (for date and for time pickers) in Temporal API for example.
- js-joda/Temporal API has no concept of an invalid Local/Plain object, their constructors throw exceptions, So I have to hack a fake date `INVALID_VALUE` as an specific instance with a very big year, to use as an invalid value. So the logic that requires an invalid value should change, for example the time picker uses `isValid()` to stop the loop that builds the times to show.
- `addSeconds()`and `setTime()` should not tie a time to date ever, if possible start with a start time.

Making these changes backward compatible will be a challenge, but I think it is needed to make usable the Temporal API Plain classes with the pickers.

### Use Case

_No response_

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par suivre l’API DateAdapter jusqu’aux points d’entrée de date picker et time picker. Comparez les hypothèses actuelles partagées concernant la date et l’heure avec les types de date et d’heure séparés demandés, la gestion des valeurs invalides et le comportement de addSeconds/setTime. Le travail est considéré comme terminé lorsqu’un design d’API rétrocompatible et un plan d’implémentation prennent en charge LocalDate/PlainDate avec LocalTime/PlainTime sans casts non sûrs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
angular, typescript
Domaine
frontend
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.