@apollion-dsi/core 5.2.0 → 5.4.0

package/lib/form/Input/Input.interface.d.ts

@@ -3,16 +3,16 @@ import { Theme } from '../../themes/ThemeProvider';
 import { FieldVariants } from '../Field';
 type NativeInputProps = Omit<React.ComponentPropsWithoutRef<'input'>, 'size'>;
 /**
- * Props mínimas compartilhadas por todos os inputs nativos do Apollion
+ * Minimal props shared by all of Apollion's native inputs
  * (`Input`, `Checkbox`, `Radio`).
  *
- * Estende as props nativas de `<input>` (exceto `size`, que aqui é
- * sobrescrito pelo token de tamanho do design system) e padroniza a
- * assinatura de `onChange` e `value` para inputs controlados.
+ * Extends the native `<input>` props (except `size`, which here is
+ * overridden by the design system's size token) and standardizes the
+ * `onChange` and `value` signature for controlled inputs.
  */
 export interface DefaultInputInterface extends NativeInputProps {
     /**
-     * Variante visual do input — reflete o estado de validação.
+     * Visual variant of the input — reflects the validation state.
      *
      * @default 'default'
      */
@@ -21,42 +21,42 @@ export interface DefaultInputInterface extends NativeInputProps {
     value?: string;
 }
 /**
- * Token de tamanho do `Input` — controla altura, padding e tamanho da fonte.
+ * `Input` size token — controls height, padding and font size.
  */
 export type InputSize = 'expansive' | 'medium' | 'compact' | 'micro';
 /**
- * Props do componente `Input`.
+ * Props for the `Input` component.
  *
- * Estende {@link DefaultInputInterface} com slot de ícone e suporte a
- * `clearable` (botão de limpar o conteúdo). É a base sobre a qual outros
- * inputs do design system se constroem.
+ * Extends {@link DefaultInputInterface} with an icon slot and support for
+ * `clearable` (a button to clear the content). It is the base on which the
+ * design system's other inputs are built.
  *
  * @example
  * ```tsx
- * <Input size="medium" placeholder="Digite seu nome" />
+ * <Input size="medium" placeholder="Type your name" />
  * <Input variant="error" icon={<Icon icon={warning} />} />
  * <Input clearable value={value} onChange={setValue} reset={() => setValue('')} />
  * ```
  *
- * @see {@link InputSize} para os tokens de tamanho disponíveis.
+ * @see {@link InputSize} for the available size tokens.
  */
 export interface InputInterface extends DefaultInputInterface {
     /**
-     * Token de tamanho do input.
+     * Size token of the input.
      *
      * @default 'medium'
      */
     size?: InputSize;
     /**
-     * Lado em que o ícone (`icon` ou o botão de limpar) é renderizado.
+     * Side on which the icon (`icon` or the clear button) is rendered.
      *
      * @default 'right'
      */
     iconPosition?: 'right' | 'left';
     /**
-     * Elemento React renderizado dentro do input (geralmente um `<Icon />`).
-     * Quando definido, o input automaticamente abre espaço para evitar
-     * colisão com o texto digitado.
+     * React element rendered inside the input (usually an `<Icon />`).
+     * When set, the input automatically makes room to avoid collision
+     * with the typed text.
      *
      * @example
      * ```tsx
@@ -65,27 +65,27 @@ export interface InputInterface extends DefaultInputInterface {
      */
     icon?: React.Component | any;
     /**
-     * Exibe um botão de limpar (ícone "×") quando há valor. Requer `reset`
-     * para funcionar fora do `Form`.
+     * Shows a clear button ("×" icon) when there is a value. Requires `reset`
+     * to work outside a `Form`.
      */
     clearable?: boolean;
     /**
-     * Callback chamado quando o usuário clica no botão de limpar (`clearable`).
-     * Dentro de um `Form`, é injetado automaticamente; em uso isolado, deve
-     * limpar o estado controlado.
+     * Callback invoked when the user clicks the clear button (`clearable`).
+     * Inside a `Form`, it is injected automatically; in standalone use, it
+     * must clear the controlled state.
      */
     reset?: () => void;
 }
 /**
- * Props internas (não consumidas pelo usuário) que carregam os tokens
- * resolvidos do tamanho selecionado — espalhadas na fábrica `apollion.input`.
+ * Internal props (not consumed by the user) that carry the resolved tokens
+ * of the selected size — spread into the `apollion.input` factory.
  */
 export type InputTokenProps = {
     color?: string;
 } & FontFactoryProps & SpacingFactoryProps & BorderFactoryProps & SizeFactoryProps;
 /**
- * Props recebidas pelos styled-components do `Input`, incluindo o tema e
- * todos os tokens resolvidos.
+ * Props received by the `Input` styled-components, including the theme and
+ * all resolved tokens.
  */
 export type InputStyleProps = {
     theme: Theme;