Sélecteur d'heure
Un cadran d'horloge en ligne, le pendant de VDatePicker pour les heures et les minutes. Sa valeur est toujours une chaîne HH:mm sur 24 heures, quelle que soit l'horloge affichée.
Utilisation
Exemples
Pas des minutes
minuteStep est l'intervalle auquel l'aiguille s'aligne et le pas des flèches du clavier, sur les minutes seules. Le cadran n'imprime que les minutes que le pas atteint.
Ce que l’on peut choisir
min et max sont deux bornes inclusives écrites en chaînes canoniques HH:mm, et allowedHours et allowedMinutes acceptent chacune la liste des valeurs autorisées ou une règle répondant pour une valeur. Ce qu'elles écartent est absent du cadran, et une heure n'est fermée que lorsqu'il n'y reste plus rien.
Nine o'clock stays open, and it is its first thirty minutes that go
The face keeps only the five minute marks a rule leaves standing
Format horaire
format choisit entre un cadran sur 12 heures, un anneau de chiffres avec la paire AM et PM à côté, et un cadran sur 24 heures, deux anneaux et aucune paire. Sans lui, la langue du lecteur décide. La valeur est la même dans les deux cas.
Localisation
locale décide ici de l'horloge : une langue qui compte en douze heures reçoit l'anneau simple, une qui compte en vingt-quatre l'anneau double. Elle l'emporte sur la locale globale et s'y rabat. Les mots, eux, viennent du dictionnaire.
API
Props
| Prop | Type | Défaut |
|---|---|---|
format | TimePickerFormat'12h' | '24h' | aucune |
| Si le cadran montre une horloge sur 12 ou sur 24 heures. Omise, la langue du lecteur décide, ce qui est presque toujours ce que l'on veut. | ||
locale | string | aucune |
| Une locale BCP 47, qui décide de l'horloge. Elle l'emporte sur la locale globale du design system et retombe dessus, ce pourquoi elle n'a pas de valeur par défaut littérale. | ||
minuteStep | number | 1 |
| L'intervalle sur lequel les minutes s'alignent, au glissement comme aux flèches. Le cadran n'affiche que les minutes qu'il peut atteindre : un pas d'un quart d'heure en marque quatre. | ||
min | string | aucune |
| L'heure la plus tôt que l'on puisse choisir, incluse, en chaîne canonique sur 24 heures. Le cadran laisse de côté ce qui tombe en dehors, comme il laisse de côté les minutes que le pas n'atteint pas. | ||
max | string | aucune |
| L'heure la plus tard que l'on puisse choisir, incluse, écrite comme min. | ||
allowedHours | TimePickerAllowed | aucune |
| Les heures que l'on peut choisir : leur liste, ou une règle qui répond pour l'une d'elles. L'heure passée à une règle est toujours celle sur 24 heures, quelle que soit l'horloge affichée. Les heures qu'elle écarte ne sont pas affichées. | ||
allowedMinutes | TimePickerAllowed | aucune |
| Les minutes que l'on peut choisir : leur liste, ou une règle qui répond pour l'une d'elles. Les minutes qu'elle écarte ne sont pas affichées. | ||
disabled | boolean | false |
| Rend toute l'horloge inutilisable : l'aiguille ne bouge plus, la demi-journée ne change plus, et tout se grise par les jetons de couleur. | ||
readonly | boolean | false |
| Montre l'heure sans permettre de la changer. Le cadran garde son focus et les deux grands chiffres basculent toujours entre heure et minutes, de sorte que la valeur reste lisible en entier. | ||
label | string | aucune |
Le nom accessible de l'horloge entière, ses deux chiffres et son cadran ensemble. Il retombe sur le dictionnaire, et un aria-label du consommateur l'emporte. Le cadran garde son propre nom, qui dit si l'aiguille est sur les heures ou sur les minutes. | ||
v-model | string | null | null |
| L'heure, toujours en chaîne sur 24 heures quelle que soit l'horloge affichée : vous n'avez donc jamais à savoir laquelle la langue utilise. Sans valeur, le cadran affiche minuit plutôt que l'heure courante : lire l'horloge pendant le rendu ferait diverger une page dessinée sur un serveur de la même page dans le navigateur. | ||
Événements
| Événement | Type |
|---|---|
confirm | [value: string | null] |
Le lecteur a terminé, avec l'heure telle qu'elle est : les minutes ont été arrêtées AU CLAVIER. Relâcher un pointeur est la façon de cesser d'ajuster l'aiguille, pas de confirmer : cet événement ne part donc pas. Là où select de VDatePicker dit qu'une date a été choisie, celui-ci dit que le choix est fini. | |
Slots
| Slot | Type |
|---|---|
footer | {} |
| Une bande au pied de l'horloge, la place des actions comme Annuler et OK. | |
Types
Les types que les tables ci-dessus nomment, écrits comme la librairie les déclare. Ceux qui portent export s'importent depuis vectis-ui pour typer votre propre code ; les autres décrivent la forme de ce qu'un slot fournit.
export type TimePickerAllowed = number[] | ((value: number) => boolean)
Variables CSS
| Token | Valeur |
|---|---|
--vectis-control-size-time-picker-dial | 16rem |
--vectis-control-size-time-picker-number | 3rem |
--vectis-control-size-time-picker-center | 0.5rem |
--vectis-control-size-time-picker-hand | 2px |
--vectis-control-size-time-picker-hand-minor | 1rem |