Visão geral do componente Seletor de data do React

O Seletor de Data Ignite UI for React é um componente rico em recursos usado para inserir uma data por meio da entrada manual de texto ou escolher valores de data em uma caixa de diálogo de calendário que aparece. Leve e simples de usar, o Seletor de datas permite que os usuários naveguem até a data desejada com várias opções de visualização – mês, ano e década. Ele também oferece suporte a propriedades de validação comuns, como restrições de data mínima e máxima e campos obrigatórios.

O componente Seletor de data Ignite UI for React permite que os usuários escolham uma única data por meio de um menu suspenso de calendário de exibição mensal ou campo de entrada editável. O Seletor de Data React também oferece suporte a um modo de diálogo para seleção somente no calendário, formatação de data personalizável e com reconhecimento de localidade e integração de validação.

[!NOTE] The IgrDatePicker is a brand new component from Ignite UI for React version 18.7.0. The old IgrDatePicker prior to this version has been renamed to XDatePicker and its respective documentation page can be found under "Deprecated Components"

React Date Picker Example

Abaixo, você pode ver um exemplo que demonstra como o Seletor de Data funciona quando os usuários podem escolher uma data por meio de uma entrada de texto manual e clicar no ícone de calendário à esquerda para navegar até ela. Veja como renderizá-lo.

Getting Started with React Date Picker

Primeiro, você precisa instalar o Ignite UI for React executando o seguinte comando:

npm install igniteui-react

Você precisará importar o IgrDatePicker CSS necessário e registrar seu módulo, assim:

import { IgrDatePicker, IgrDatePickerModule } from 'igniteui-react';
import 'igniteui-webcomponents/themes/light/bootstrap.css';

IgrDatePickerModule.register();

Para obter uma introdução completa ao Ignite UI for React, leia o tópico Introdução.

Using the React Date Picker Component

Display Date Picker

Para instanciar um IgrDatePicker em seu estado padrão dropdown, use o seguinte código:

<IgrDatePicker></IgrDatePicker>

Options

O IgrDatePicker pode ser vinculado a um date.

const DatePicker = document.querySelector('igc-date-picker') as IgcDatePickerComponent;
const date = new Date();

DatePicker.value = date;

datePickerRef.current.value = new Date();

Projecting components

Com slots de prefixo e sufixo, podemos adicionar conteúdo diferente antes e depois do conteúdo principal da entrada.

<IgrDatePicker>
    <IgrIcon 
        slot="suffix" 
        name="arrow_upward" 
        collection="material" 
        class="small" 
        onClick={() => datePickerRef.current.stepUp(DatePart.Month)}>
    </IgrIcon>
</IgrDatePicker>

O snippet acima adicionará um ícone adicional no final da entrada, logo após o ícone de limpeza padrão. Isso não removerá o ícone de alternância padrão, pois prefixos e sufixos podem ser empilhados um após o outro.

Personalizando os ícones de alternância e limpeza

O calendário e o ícone de limpeza podem ser modelados usando os calendar slots e clear:

<IgrDatePicker>
    <IgrIcon slot="calendar" name="calendar" collection="material" class="small"></IgrIcon>
    <IgrIcon slot="clear" name="delete" collection="material" class="small"></IgrIcon>
</IgrDatePicker>

Botões de ação personalizados

Os botões de ação do seletor podem ser modelados usando o actions slot:

<IgrDatePicker>
    <IgrButton 
        slot='actions' 
        onClick={() => datePickerRef.current.showWeekNumbers = true}>
        <span>Show Week Numbers</span>
    </IgrButton>
</IgrDatePicker>

Possui IgrDatePicker navegação intuitiva pelo teclado que facilita incrementar, diminuir ou pular entre diferentes DateParts, entre outros, sem a necessidade de tocar no mouse.

Chaves	Descrição
`←`	Mover um caractere para o início
`→`	Mover um caractere para o final
`Casa`	Mover para o início
`Fim`	Mover para o final
`Ctrl` / `Comando` + `←`	Mover para o início da seção de data/hora - atual ou esquerda
`Ctrl` / `Comando` + `→`	Mover para o final da seção de data/hora - atual ou à direita
Foco em uma parte de data/hora + `↓`	Decrementa uma parte de data/hora
Foco em uma parte de data/hora + `↑`	Incrementa uma parte de data/hora
`Ctrl` / `Comando` +`;`	Define a data/hora atual como o valor do editor
`Esc`	Fecha o pop-up do calendário e foca o campo de entrada

Examples

Dialog Mode

O IgrDatePicker também suporta um dialog modo:

<IgrDatePicker mode="dialog"></IgrDatePicker>

Display and input format

inputFormat e displayFormat são propriedades que podem ser definidas para fazer com que o editor do seletor siga um formato especificado. O inputFormat é baseado em localidade, portanto, se nenhum for fornecido, o seletor será padronizado para o usado pelo navegador.

Uma boa coisa a notar é que o componente Seletor de data sempre adicionará um zero à esquerda nas date partes e month se elas forem fornecidas em um formato que não o tenha, por exemplo d/M/yy, torna-se dd/MM/yy. Isso se aplica apenas durante a edição.

displayFormat is used to format the picker's input when it is not focused. If no displayFormat is provided, the picker will use the inputFormat as its displayFormat.

Mais informações sobre eles podem ser encontradas na seção de IgrDateTimeInput formato.

Increment and decrement

As IgrDatePicker exposições stepUp e stepDown métodos. Ambos vêm do IgrDateTimeInput e podem ser usados para incrementar e diminuir um específico DatePart da data definida no momento.

<IgrDatePicker>
    <IgrIcon 
        slot="prefix" 
        name="arrow_upward" 
        collection="material" 
        onClick={() => datePickerRef.current.stepUp(DatePart.Month)}>
    </IgrIcon>
    <IgrIcon 
        slot="suffix" 
        name="arrow_downward" 
        collection="material" 
        onClick={() => datePickerRef.current.stepDown(DatePart.Month)}>
    </IgrIcon>
</IgrDatePicker>

In Forms

O IgrDatePicker pode ser usado em um elemento de formulário, o componente e max as propriedades atuam como validadores de min formulário.

Nos formulários, podemos lidar com o change evento do componente e atualizar o valor do rótulo.

Calendar Specific settings

Eles IgrDatePicker podem modificar algumas das configurações do calendário por meio das propriedades que o Seletor de Data expõe. Alguns deles incluem visibleMonths o que permite que mais de um calendário seja exibido quando o seletor se expande, weekStart que determina o dia de início da semana, showWeekNumbers que mostra o número de cada semana do ano e muito mais.

Internationalization

A localização do IgrDatePicker pode ser controlada por meio de sua locale entrada.

Aqui está como uma definição de IgrDatePicker localidade com japonês seria:

<IgrDatePicker locale="ja-JP"></IgrDatePicker>

Styling

O IgrDatePicker componente deriva do IgrInput componente e IgrCalendar, portanto, expõe todas as partes CSS disponíveis. Consulte Estilo de entrada e Estilo de calendário para referência.

igc-date-picker::part(header) {
  background-color: var(--ig-primary-500);
  color: var(--ig-primary-500-contrast);
}
igc-date-picker::part(calendar-content) {
  background-color: var(--ig-surface-300);
}
igc-date-picker::part(date-inner current) {
  color: var(--ig-info-300);
  background-color: var(--ig-surface-300);
}
igc-date-picker::part(navigation-button):hover,
igc-date-picker::part(months-navigation):hover,
igc-date-picker::part(years-navigation):hover {
  color: var(--ig-secondary-500);
}
igc-date-picker::part(month-inner current),
igc-date-picker::part(year-inner current),
igc-date-picker::part(navigation-button),
igc-date-picker::part(months-navigation),
igc-date-picker::part(years-navigation) {
  color: var(--ig-info-300);
}
igc-date-picker::part(date-inner selected),
igc-date-picker::part(month-inner selected),
igc-date-picker::part(year-inner selected) {
  color: var(--ig-secondary-500-contrast);
  background-color: var(--ig-secondary-500);
}