@apollion-dsi/core 5.3.0 → 5.5.0

package/lib/elements/Modal/Modal.d.ts

@@ -1,45 +1,45 @@
 import React from 'react';
 import { ModalComponentProps, ModalDialogProps } from './Modal.interface';
 /**
- * Variante "controlada" do Modal — usa `isOpen`/`onDismiss` informados pelo
- * pai. O componente é montado/desmontado via portal no `document.body` para
- * escapar do `stacking context` do componente pai.
+ * "Controlled" variant of the Modal — uses the `isOpen`/`onDismiss` provided
+ * by the parent. The component is mounted/unmounted via a portal on
+ * `document.body` to escape the parent component's stacking context.
  *
- * O `mounted` state é necessário para evitar problemas de SSR: o portal só
- * pode ser criado após hidratar.
+ * The `mounted` state is needed to avoid SSR issues: the portal can only be
+ * created after hydration.
  */
 export declare const ModalBaseComponent: ({ isOpen, onDismiss, ...props }: ModalDialogProps) => React.ReactPortal;
 /**
- * Variante "uncontrolled" — recebe um `trigger` (elemento ou função-render) e
- * gerencia o estado internamente via `useToggle`. Loga aviso se o consumidor
- * misturar `isOpen`/`onDismiss` com `trigger`.
+ * "Uncontrolled" variant — receives a `trigger` (element or render function)
+ * and manages state internally via `useToggle`. Logs a warning if the
+ * consumer mixes `isOpen`/`onDismiss` with `trigger`.
  */
 export declare const ModalTriggerVariant: ({ defaultOpen, trigger, isOpen, onDismiss, onModalOpen, ...props }: ModalComponentProps) => React.JSX.Element;
 /**
- * Diálogo modal sobreposto à página.
+ * Modal dialog overlaid on the page.
  *
- * Aceita uso "controlado" (`isOpen`/`onDismiss` no pai) ou "uncontrolled"
- * (`trigger` interno via `useToggle`). Renderiza via portal no
- * `document.body` para escapar do `stacking context` do pai.
+ * Accepts "controlled" usage (`isOpen`/`onDismiss` on the parent) or
+ * "uncontrolled" (internal `trigger` via `useToggle`). Renders via a portal
+ * on `document.body` to escape the parent's stacking context.
  *
- * O header inclui ícone, título, tagline e botão de fechar; o body tem scroll
- * customizado; o footer (opcional) tem layout `right`/`expanded`/`full` e se
- * adapta em mobile para `column-reverse`.
+ * The header includes an icon, title, tagline, and close button; the body
+ * has custom scroll; the (optional) footer has `right`/`expanded`/`full`
+ * layouts and adapts to `column-reverse` on mobile.
  *
  * @example
  * ```tsx
- * // Controlado
- * <Modal isOpen={open} onDismiss={close} title="Título">
- *   <Text text="Conteúdo" />
+ * // Controlled
+ * <Modal isOpen={open} onDismiss={close} title="Title">
+ *   <Text text="Content" />
  * </Modal>
  *
- * // Uncontrolled — usa um trigger
- * <Modal trigger={<Button text="Abrir" />} title="Modal Title">
- *   <Text text="Conteúdo" />
+ * // Uncontrolled — uses a trigger
+ * <Modal trigger={<Button text="Open" />} title="Modal Title">
+ *   <Text text="Content" />
  * </Modal>
  * ```
  *
- * @see {@link ModalComponentProps} para o detalhamento das props.
+ * @see {@link ModalComponentProps} for the detailed props.
  */
 export declare const ModalComponent: {
     ({ noCloseButton, secondaryText, primaryText, variant, footer, ...rest }: ModalComponentProps): React.JSX.Element;

package/lib/elements/Modal/Modal.interface.d.ts

@@ -1,117 +1,117 @@
 import React from 'react';
 import { NotificationVariants } from '../../containers/Notification';
 import { Theme } from '../../themes';
-/** Largura semântica do modal. Cada valor mapeia para min/max-width em `Modal.style`. */
+/** Semantic width of the modal. Each value maps to min/max-width in `Modal.style`. */
 type ModalSizeType = 'small' | 'base' | 'medium' | 'large';
 /**
- * Props do diálogo modal (sem o `trigger`).
+ * Props for the modal dialog (without the `trigger`).
  *
- * Usada na variante "controlada" — quando o estado de abertura é gerenciado
- * pelo pai via `isOpen`/`onDismiss`.
+ * Used in the "controlled" variant — when the open state is managed by the
+ * parent via `isOpen`/`onDismiss`.
  */
 export type ModalDialogProps = {
-    /** Ícone exibido à esquerda do título no header. */
+    /** Icon displayed to the left of the title in the header. */
     icon?: React.ReactNode;
-    /** Controla a abertura quando NÃO está usando `trigger`. */
+    /** Controls the open state when NOT using `trigger`. */
     isOpen?: boolean;
-    /** Chamado ao clicar no overlay ou no botão de fechar. */
+    /** Called when clicking the overlay or the close button. */
     onDismiss?: () => void;
     /**
-     * Callback do botão primário do footer. Receber `{ close }` permite
-     * disparar a ação e fechar o modal na mesma função.
+     * Callback for the footer's primary button. Receiving `{ close }` lets you
+     * trigger the action and close the modal in the same function.
      */
     primaryAction?: (props: {
         close: () => void;
     }) => void;
-    /** Callback do botão secundário do footer. */
+    /** Callback for the footer's secondary button. */
     secondaryAction?: (props: {
         close: () => void;
     }) => void;
-    /** Substitui o botão primário padrão. Recebe `onClick` e `fullWidth` injetados. */
+    /** Replaces the default primary button. Receives injected `onClick` and `fullWidth`. */
     primaryButton?: React.ReactNode;
-    /** Substitui o botão secundário padrão (aceita render-prop). */
+    /** Replaces the default secondary button (accepts a render prop). */
     secondaryButton?: React.ReactNode | ((p: {
         close: () => void;
     }) => React.ReactNode);
     /**
-     * Texto do botão primário (ignorado se `primaryButton` for informado).
+     * Primary button text (ignored when `primaryButton` is provided).
      *
      * @default 'Confirmar'
      */
     primaryText?: string;
     /**
-     * Texto do botão secundário (ignorado se `secondaryButton` for informado).
+     * Secondary button text (ignored when `secondaryButton` is provided).
      *
      * @default 'Cancelar'
      */
     secondaryText?: string;
     /**
-     * Disposição dos botões do footer.
-     * - `right`: ambos à direita (padrão).
-     * - `expanded`: secundário à esquerda, primário à direita.
-     * - `full`: apenas o primário, ocupando toda a largura.
+     * Layout of the footer buttons.
+     * - `right`: both on the right (default).
+     * - `expanded`: secondary on the left, primary on the right.
+     * - `full`: primary only, spanning the full width.
      *
      * @default 'right'
      */
     footer?: 'expanded' | 'right' | 'full';
-    /** Texto auxiliar exibido abaixo do título. */
+    /** Supporting text displayed below the title. */
     tagline?: string;
-    /** Corpo do modal. */
+    /** Modal body content. */
     children?: React.ReactNode;
     /**
-     * Cor temática (usada no ícone e no botão primário).
+     * Theme color (used on the icon and the primary button).
      *
      * @default 'primary'
      */
     variant?: NotificationVariants;
     /**
-     * Largura semântica do modal.
+     * Semantic width of the modal.
      *
      * @default 'base'
      */
     size?: ModalSizeType;
-    /** Título exibido no header. */
+    /** Title displayed in the header. */
     title?: string;
     /**
-     * Esconde o botão de fechar do header. Reservado para fluxos onde o modal
-     * só pode sair via ação confirmada (ex.: aceitar termos).
+     * Hides the header's close button. Reserved for flows where the modal can
+     * only be exited through a confirmed action (e.g. accepting terms).
      *
      * @default false
      */
     noCloseButton?: boolean;
     /**
-     * Nome acessível do botão de fechar. Botão só-ícone não tem nome próprio:
-     * sem isto, um leitor de tela anuncia apenas "botão".
+     * Accessible name for the close button. An icon-only button has no name of
+     * its own: without this, a screen reader announces just "button".
      *
      * @default 'Fechar'
      */
     closeLabel?: string;
-    /** Callback disparado quando o modal abre — útil para tracking. */
+    /** Callback fired when the modal opens — useful for tracking. */
     onModalOpen?: () => void;
-    /** `aria-role` customizado (ex.: `alertdialog`). */
+    /** Custom `aria-role` (e.g. `alertdialog`). */
     role?: React.AriaRole;
 };
 /**
- * Props completas do `Modal`.
+ * Full props for the `Modal`.
  *
- * Estende {@link ModalDialogProps} adicionando `trigger` e `defaultOpen` para
- * a variante "uncontrolled". Se `trigger` for informado, `isOpen`/`onDismiss`
- * são ignorados (com aviso no console).
+ * Extends {@link ModalDialogProps}, adding `trigger` and `defaultOpen` for
+ * the "uncontrolled" variant. When `trigger` is provided, `isOpen`/`onDismiss`
+ * are ignored (with a console warning).
  *
  * @example
  * ```tsx
- * <Modal trigger={<Button text="Abrir" />} title="Confirmação">
- *   <Text text="Tem certeza?" />
+ * <Modal trigger={<Button text="Open" />} title="Confirmation">
+ *   <Text text="Are you sure?" />
  * </Modal>
  * ```
  */
 export type ModalComponentProps = {
-    /** Estado inicial do modal na variante uncontrolled. */
+    /** Initial modal state in the uncontrolled variant. */
     defaultOpen?: boolean;
     /**
-     * Elemento ou função-render que abre o modal. Quando função, recebe
-     * `{ isOpen, open }`. Sua presença chaveia o componente para a variante
-     * "uncontrolled" — `isOpen`/`onDismiss` deixam de ter efeito.
+     * Element or render function that opens the modal. When a function, it
+     * receives `{ isOpen, open }`. Its presence switches the component to the
+     * "uncontrolled" variant — `isOpen`/`onDismiss` no longer have any effect.
      */
     trigger?: React.ReactNode | ((props: {
         isOpen: boolean;
@@ -119,8 +119,8 @@ export type ModalComponentProps = {
     }) => React.ReactNode);
 } & ModalDialogProps;
 /**
- * Props recebidas pelos styled-components. Combina {@link ModalComponentProps}
- * com o `theme` injetado pelo `ThemeProvider`.
+ * Props received by the styled-components. Combines {@link ModalComponentProps}
+ * with the `theme` injected by the `ThemeProvider`.
  */
 export type ModalStyleProps = {
     theme: Theme;