@giro-ds/react 3.0.6 → 4.0.0

package/dist/components/Tooltip/Tooltip.types.d.ts

@@ -1,34 +1,9 @@
 import React from 'react';
-import { Side, Align, BaseProps } from '../../types/common.types';
-/**
- * Props do componente Tooltip
- * @example
- * ```tsx
- * <Tooltip text="Informação adicional">
- *   <Button>Hover me</Button>
- * </Tooltip>
- * ```
- * @example
- * ```tsx
- * <Tooltip
- *   text="Clique para mais detalhes"
- *   side="top"
- *   align="center"
- *   sideOffset={10}
- *   maxWidth={300}
- * >
- *   <IconButton icon={<InfoIcon />} />
- * </Tooltip>
- * ```
- */
+import { BaseProps, Side, Align } from '@/types';
 export interface TooltipProps extends BaseProps {
-    /** Conteúdo do tooltip */
     text: React.ReactNode;
-    /** Lado onde o tooltip aparece em relação ao elemento */
     side?: Side;
-    /** Alinhamento do tooltip */
     align?: Align;
-    /** Distância em pixels do lado do elemento */
     sideOffset?: number;
     /** Deslocamento em pixels no eixo de alinhamento */
     alignOffset?: number;

package/dist/components/index.d.ts

@@ -5,14 +5,14 @@ export { type BadgeProps } from './Badge/Badge.types';
 export { default as Button } from './Button';
 export { type ButtonProps } from './Button/Button.types';
 export { default as Calendar } from './Calendar';
-export { type CalendarProps, type DateFormat, type DayItem, type EmptyItem, type CalendarItem, type YearItem } from './Calendar/Calendar.types';
+export { type CalendarProps } from './Calendar/Calendar.types';
 export { default as Callout } from './Callout';
 export { type CalloutProps } from './Callout/Callout.types';
 export { default as Checkbox } from './Checkbox';
 export { type CheckboxProps } from './Checkbox/Checkbox.types';
 export { default as Chips } from './Chips';
 export { type ChipsProps } from './Chips/Chips.types';
-export { default as Container } from './Container';
+export { default as Container } from './Container/Container';
 export { type ContainerProps } from './Container/Container.types';
 export { default as DatePicker } from './DatePicker';
 export { type DatePickerProps } from './DatePicker/DatePicker.types';
@@ -28,6 +28,8 @@ export { default as ListItem } from './ListItem';
 export { type ListItemProps } from './ListItem/ListItem.types';
 export { default as Menu } from './Menu';
 export { type MenuProps } from './Menu/Menu.types';
+export { default as Popover } from './Popover';
+export { type PopoverProps } from './Popover/Popover.types';
 export { default as Quantity } from './Quantity';
 export { type QuantityProps } from './Quantity/Quantity.types';
 export { default as Radio } from './Radio';
@@ -44,8 +46,8 @@ export { type TablePaginationProps } from './Table/TablePagination';
 export { type TableHeaderProps, type FilterItem } from './Table/TableHeader';
 export { default as TextField } from './TextField';
 export { type TextFieldProps } from './TextField/TextField.types';
-export { default as Toast, ToastProvider, useToast } from './Toast';
-export { type ToastType, type ToastMessage, type ToastOptions, type ToastContextType } from './Toast/Toast.types';
+export { Toast, ToastProvider, ToastContainer, useToast } from './Toast';
+export { type ToastProps } from './Toast/Toast.types';
 export { default as Tooltip } from './Tooltip';
 export { type TooltipProps } from './Tooltip/Tooltip.types';
 export { default as Switch } from './Switch';

package/dist/contexts/ToastContext.d.ts

@@ -0,0 +1,43 @@
+import * as React from 'react';
+import { ToastProps } from '../components/Toast/Toast.types';
+/**
+ * Valor disponibilizado pelo contexto do sistema de Toast.
+ *
+ * Acessível via `useToast()` em componentes filhos do `ToastProvider`.
+ *
+ * @see {@link useToast}
+ */
+export interface ToastContextValue {
+    /** Lista de toasts atualmente visíveis na tela. */
+    toasts: ToastProps[];
+    /**
+     * Exibe um novo toast na tela.
+     *
+     * Gera um `id` único automaticamente e adiciona o toast à fila.
+     * Quando o limite de `maxToasts` é atingido, o toast mais antigo é removido.
+     *
+     * @param toast - Propriedades do toast a ser exibido (sem `id`).
+     */
+    showToast: (toast: Omit<ToastProps, 'id'>) => void;
+    /**
+     * Remove um toast específico da tela pelo seu `id`.
+     *
+     * @remarks
+     * Geralmente não é necessário chamar este método manualmente, pois os toasts
+     * se fecham automaticamente (via `duration`) ou pelo botão de fechar do usuário.
+     *
+     * @param id - ID único do toast a ser removido.
+     */
+    dismissToast: (id: string) => void;
+}
+/**
+ * Contexto React que armazena o estado e as ações do sistema de Toast.
+ *
+ * @remarks
+ * Não consuma este contexto diretamente. Utilize o hook `useToast()` para
+ * acessar as funcionalidades de forma segura e com verificação de provider.
+ *
+ * @see {@link ToastContextValue}
+ * @see {@link useToast}
+ */
+export declare const ToastContext: React.Context<ToastContextValue | undefined>;

package/dist/hooks/useToast.d.ts

@@ -0,0 +1,46 @@
+import { ToastProps } from '../components/Toast/Toast.types';
+/**
+ * Hook interno que acessa o `ToastContext` diretamente.
+ *
+ * @throws {Error} Lança um erro se utilizado fora de um `ToastProvider`:
+ * *"useToastContext deve ser usado dentro de ToastProvider"*
+ *
+ * @returns O valor completo do contexto — `toasts`, `showToast` e `dismissToast`.
+ *
+ * @internal
+ */
+export declare const useToastContext: () => import("../contexts/ToastContext").ToastContextValue;
+/**
+ * Hook para exibir e remover toasts na aplicação.
+ *
+ * O componente que usa este hook deve ser filho de um `ToastProvider`.
+ *
+ * @throws {Error} Lança um erro se utilizado fora de um `ToastProvider`:
+ * *"useToastContext deve ser usado dentro de ToastProvider"*
+ *
+ * @returns Objeto com os métodos `showToast` e `dismissToast`.
+ *
+ * @example
+ * ```tsx
+ * import { useToast } from '@giro-ds/react';
+ *
+ * function MeuComponente() {
+ *   const { showToast } = useToast();
+ *
+ *   const handleSalvar = async () => {
+ *     try {
+ *       await salvarDados();
+ *       showToast({ title: 'Sucesso!', iconType: 'Success', duration: 3000 });
+ *     } catch (err) {
+ *       showToast({ title: 'Erro ao salvar', iconType: 'Alert', automaticClose: false });
+ *     }
+ *   };
+ *
+ *   return <button onClick={handleSalvar}>Salvar</button>;
+ * }
+ * ```
+ */
+export declare const useToast: () => {
+    showToast: (toast: Omit<ToastProps, "id">) => void;
+    dismissToast: (id: string) => void;
+};