@apollion-dsi/core 5.2.0 → 5.4.0

package/lib/containers/Notification/Notification.interface.d.ts

@@ -3,120 +3,120 @@ import { LinkInterface } from '../../elements/Link';
 import { MotionProps } from '../../vendors/FramerMotion';
 import { DefaultFlexInterface } from '../Flex';
 /**
- * Tipos visuais aceitos por `Notification`.
+ * Visual types accepted by `Notification`.
  *
- * - `'block'` (padrão): inline na árvore React.
- * - `'page'`: fixa no topo/rodapé via portal (controlada por
+ * - `'block'` (default): inline in the React tree.
+ * - `'page'`: fixed to the top/bottom via portal (controlled by
  *   `pagePosition`).
  *
- * Para toasts empilhados, use o hook `useNotification()`.
+ * For stacked toasts, use the `useNotification()` hook.
  */
 export type NotificationTypes = 'block' | 'page';
 /**
- * Variantes de cor — cada uma mapeia para uma paleta completa do tema
- * (`base`/`light`/`dark`/`action`/`active`) usada em background, borda,
- * ícone e botões filhos.
+ * Color variants — each maps to a full theme palette
+ * (`base`/`light`/`dark`/`action`/`active`) used for the background, border,
+ * icon, and child buttons.
  */
 export type NotificationVariants = 'primary' | 'success' | 'warning' | 'danger';
-/** Posição da notificação `type="page"` na viewport. */
+/** Position of the `type="page"` notification in the viewport. */
 export type NotificationPagePositionTypes = 'top' | 'bottom';
 /**
- * Props do componente `Notification`.
+ * Props of the `Notification` component.
  *
- * Aceita também todas as props de animação do `framer-motion`
- * ({@link MotionProps}) e as factory props do `Flex`
- * ({@link DefaultFlexInterface}) — `Notification` é renderizado sobre
- * um wrapper animado.
+ * Also accepts every `framer-motion` animation prop
+ * ({@link MotionProps}) and the `Flex` factory props
+ * ({@link DefaultFlexInterface}) — `Notification` is rendered on top of
+ * an animated wrapper.
  *
  * @example
  * ```tsx
  * <Notification
  *   type="block"
  *   variant="warning"
- *   title="Atenção"
- *   message="Sua sessão vai expirar em 1 minuto"
- *   action={({ close }) => <Button text="Renovar" onClick={() => { renew(); close(); }} />}
+ *   title="Attention"
+ *   message="Your session will expire in 1 minute"
+ *   action={({ close }) => <Button text="Renew" onClick={() => { renew(); close(); }} />}
  * />
  * ```
  */
 export type NotificationInterface = {
-    /** Título exibido em destaque. */
+    /** Title displayed prominently. */
     title?: string;
     /**
-     * Mensagem principal. Aceita `ReactNode` ou uma função
-     * `(p: { close }) => ReactNode` — útil para incluir um botão "fechar"
-     * inline.
+     * Main message. Accepts a `ReactNode` or a function
+     * `(p: { close }) => ReactNode` — useful for including an inline
+     * "close" button.
      */
     message?: React.ReactNode | ((p: {
         close: () => void;
     }) => React.ReactNode);
     /**
-     * Tipo de renderização.
+     * Rendering type.
      *
      * @default 'block'
      */
     type?: NotificationTypes;
-    /** Ícone exibido à esquerda do conteúdo. */
+    /** Icon displayed to the left of the content. */
     icon?: React.ReactNode;
     /**
-     * Variante de cor.
+     * Color variant.
      *
      * @default 'primary'
      */
     variant?: NotificationVariants;
     /**
-     * Nome acessível do botão de fechar. Sobrescreva para localizar ou para
-     * descrever o que está sendo fechado quando houver várias notificações.
+     * Accessible name of the close button. Override to localize or to
+     * describe what is being closed when there are multiple notifications.
      *
      * @default 'Fechar notificação'
      */
     closeLabel?: string;
-    /** Controla se a notificação está visível. */
+    /** Controls whether the notification is visible. */
     visible?: boolean;
     /**
-     * Posição na página quando `type="page"`.
+     * Position on the page when `type="page"`.
      *
      * @default 'bottom'
      */
     pagePosition?: NotificationPagePositionTypes;
-    /** Callback chamado quando a notificação é fechada. */
+    /** Callback fired when the notification is dismissed. */
     onDismiss?: () => void;
     /**
-     * Tempo em segundos para fechamento automático. Quando informado,
-     * exibe uma barra de progresso que pausa ao hover.
+     * Time in seconds for auto-dismissal. When provided, displays a
+     * progress bar that pauses on hover.
      */
     autoClose?: number;
     /**
-     * Mostra um botão de fechar no canto superior direito.
+     * Shows a close button in the top-right corner.
      *
      * @default true
      */
     closable?: boolean;
-    /** Link opcional exibido abaixo da mensagem. Abre em nova aba. */
+    /** Optional link displayed below the message. Opens in a new tab. */
     link?: {
         text: LinkInterface['text'];
         href?: LinkInterface['href'];
         to?: LinkInterface['to'];
     };
     /**
-     * Botão/ação à direita do conteúdo. Aceita um `ReactNode` ou uma
-     * função `(p: { close }) => ReactNode`. A cor da ação é forçada para
-     * a `variant` da notificação.
+     * Button/action to the right of the content. Accepts a `ReactNode` or a
+     * function `(p: { close }) => ReactNode`. The action color is forced to
+     * the notification's `variant`.
      */
     action?: React.ReactNode | ((p: {
         close: () => void;
     }) => React.ReactNode);
 } & MotionProps & DefaultFlexInterface;
 /**
- * Forma interna usada na fila de toasts. Adiciona o `id` gerado por
- * `nanoid()` para permitir remoção pontual.
+ * Internal shape used in the toast queue. Adds the `id` generated by
+ * `nanoid()` to allow targeted removal.
  */
 export type NotificationType = {
     id: string;
 } & NotificationInterface;
 /**
- * Action do reducer interno do {@link NotificationsProvider}. Não é
- * consumida fora do contexto.
+ * Action of the internal {@link NotificationsProvider} reducer. Not
+ * consumed outside the context.
  */
 export type Action = {
     payload: NotificationType;