@lab-anssi/ui-kit 1.61.3 → 1.62.1

package/dist/dsfr/DsfrTable.svelte.d.ts

@@ -0,0 +1,202 @@
+import type { Size } from "../types";
+type TableSize = Extract<Size, "sm" | "md" | "lg">;
+type CellSize = Extract<Size, "xs" | "sm" | "md" | "lg">;
+type CellAlign = "left" | "center" | "right";
+type CellValign = "top" | "bottom";
+type FixedBreakpoint = "sm" | "md" | "lg";
+interface TheadCell {
+    /** Contenu textuel de la cellule */
+    content: string;
+    /** Largeur minimale de la colonne (fr-col--[size]) */
+    size?: CellSize;
+    /** Alignement horizontal du texte */
+    align?: CellAlign;
+    /** Alignement vertical du contenu */
+    valign?: CellValign;
+    /** Fixe la colonne en sticky. Passer un breakpoint pour l'activer uniquement à partir de celui-ci */
+    fixed?: boolean | FixedBreakpoint;
+    /** Indique que la colonne est triable (fr-cell--sort) */
+    sort?: boolean;
+    /** Affiche le contenu en flex inline (fr-cell--inline) */
+    inline?: boolean;
+    /** Autorise le retour à la ligne dans cette cellule (fr-cell--multiline) */
+    multiline?: boolean;
+}
+interface TbodyCell {
+    /** Contenu textuel de la cellule */
+    content: string;
+    /** Alignement horizontal du texte */
+    align?: CellAlign;
+    /** Alignement vertical du contenu */
+    valign?: CellValign;
+    /** Fixe la colonne en sticky. Passer un breakpoint pour l'activer uniquement à partir de celui-ci */
+    fixed?: boolean | FixedBreakpoint;
+    /** Affiche le contenu en flex inline (fr-cell--inline) */
+    inline?: boolean;
+    /** Autorise le retour à la ligne dans cette cellule (fr-cell--multiline) */
+    multiline?: boolean;
+}
+interface Table {
+    thead: TheadCell[][];
+    tbodies: TbodyCell[][][];
+}
+type Row = Record<string, unknown>;
+interface Column {
+    key: string;
+    label: string;
+    size?: CellSize;
+    align?: CellAlign;
+    valign?: CellValign;
+    fixed?: boolean | FixedBreakpoint;
+    sort?: boolean;
+    inline?: boolean;
+    multiline?: boolean;
+    /**
+     * Active le slot nommé `cell:<key>:<rowIndex>` uniquement sur les cellules de cette colonne.
+     * Permet une activation granulaire de la personnalisation par light DOM, sans payer le coût
+     * d'un `<slot>` par cellule sur les colonnes qui n'en ont pas besoin.
+     *
+     * Cumulatif avec la prop globale `rich` : si l'une des deux est `true`, le slot est activé.
+     */
+    rich?: boolean;
+}
+export interface Props {
+    /** Titre du tableau */
+    caption: string;
+    /** Id du tableau */
+    id?: string;
+    /** Description précise du tableau */
+    captionDetail?: string;
+    /** Cache le texte de la caption (reste présent pour l'accessibilité) */
+    noCaption?: boolean;
+    /** Positionne la caption en bas du tableau */
+    captionBottom?: boolean;
+    /** Ajoute des séparateurs verticaux entre chaque colonne */
+    bordered?: boolean;
+    /** Désactive le scroll horizontal */
+    noScroll?: boolean;
+    /** Active le retour à la ligne dans toutes les cellules du tableau */
+    multiline?: boolean;
+    /** Fixe la mise en page du tableau (table-layout: fixed) */
+    layoutFixed?: boolean;
+    /** Taille des espacements internes des cellules */
+    size?: TableSize;
+    /** Fixe la première cellule de l'en-tête en sticky */
+    fixedFirstCellHead?: boolean;
+    /** Affiche la section en-tête du tableau */
+    hasHeader?: boolean;
+    /** Affiche un contrôle segmenté dans l'en-tête */
+    hasHeaderSegmented?: boolean;
+    /** Affiche une barre de recherche dans l'en-tête */
+    hasHeaderSearch?: boolean;
+    /** Affiche un texte de détail dans l'en-tête */
+    hasHeaderDetails?: boolean;
+    /** Texte de détail affiché dans l'en-tête */
+    headerDetails?: string;
+    /** Affiche des boutons d'actions dans l'en-tête */
+    hasHeaderButtons?: boolean;
+    /** Affiche la section pied de page du tableau */
+    hasFooter?: boolean;
+    /** Affiche le sélecteur de nombre de lignes par page */
+    hasFooterSelect?: boolean;
+    /** Affiche la pagination */
+    hasFooterPagination?: boolean;
+    /** Affiche des boutons d'actions dans le pied de page */
+    hasFooterButtons?: boolean;
+    /** Données du tableau (source par défaut pour columns et rows) */
+    table?: Table;
+    /** Données des colonnes. Prends le pas sur `table.thead` si défini */
+    columns?: Column[];
+    /** Données des lignes. Prends le pas sur `table.tbodies` si défini */
+    rows?: Row[];
+    /** Options permettant de définir le nombre de lignes par page */
+    itemsPerPage?: number[];
+    /**
+     * Nombre total de lignes (mode pagination serveur).
+     * Si fourni, désactive le slicing interne : le composant affiche les `rows` telles quelles
+     * et délègue la gestion des données au parent via `onpagechanged` / `onrowsperpagechanged`.
+     */
+    totalRows?: number;
+    /**
+     * Callback appelé lors d'un changement de page.
+     * En mode web component, un `CustomEvent<number>` `pagechanged` est également dispatché
+     * sur l'élément (utilisable via `<dsfr-table onpagechanged={(e) => …}>`).
+     */
+    onpagechanged?: (page: number) => void;
+    /**
+     * Callback appelé lors d'un changement du nombre de lignes par page.
+     * En mode web component, un `CustomEvent<number>` `rowsperpagechanged` est également dispatché
+     * sur l'élément (utilisable via `<dsfr-table onrowsperpagechanged={(e) => …}>`).
+     */
+    onrowsperpagechanged?: (rowsPerPage: number) => void;
+    /**
+     * Active les slots nommés `cell:<colKey>:<rowIndex>` sur **toutes** les cellules du tableau,
+     * permettant d'injecter du contenu personnalisé via le light DOM
+     * (ex: `<div slot="cell:maColonne:0">…</div>`).
+     *
+     * Utile principalement en contexte web component.
+     * Le rendu standard sert de fallback si aucun slot n'est fourni.
+     *
+     * ⚠️ Coût non-négligeable sur les gros tableaux : un `<slot>` est créé par cellule.
+     * Pour une activation ciblée par colonne (sans payer le coût sur les autres),
+     * utiliser plutôt `Column.rich` au cas par cas.
+     */
+    rich?: boolean;
+    /**
+     * Active la variation sélectionnable : ajoute une colonne de cases à cocher en début de chaque ligne.
+     */
+    selectable?: boolean;
+    /**
+     * Affiche une case à cocher « tout sélectionner » dans l'en-tête du tableau.
+     * Permet de sélectionner/désélectionner toutes les lignes de la page courante.
+     * L'état indéterminé s'active automatiquement quand une partie des lignes est sélectionnée.
+     * Nécessite `selectable` pour être actif.
+     */
+    selectAll?: boolean;
+    /**
+     * Nom de la clé dans les objets `Row` à utiliser comme identifiant unique pour la sélection.
+     * Si absent, l'index de la ligne est utilisé.
+     */
+    rowKey?: string;
+    /**
+     * Clés des lignes sélectionnées (mode contrôlé).
+     * Si fourni, le composant utilise cette valeur ; sinon, il gère sa propre sélection en interne.
+     */
+    selectedRowKeys?: (string | number)[];
+    /**
+     * Clés des lignes désactivées.
+     * Les lignes désactivées ont leur case à cocher `disabled` et sont ignorées
+     * par la case « tout sélectionner ».
+     */
+    disabledRowKeys?: (string | number)[];
+    /** Callback appelé lorsque la sélection change */
+    onselectionchanged?: (selectedKeys: (string | number)[], selectedRows: Row[]) => void;
+}
+interface $$__sveltets_2_IsomorphicComponent<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any, Exports = {}, Bindings = string> {
+    new (options: import('svelte').ComponentConstructorOptions<Props>): import('svelte').SvelteComponent<Props, Events, Slots> & {
+        $$bindings?: Bindings;
+    } & Exports;
+    (internal: unknown, props: Props & {
+        $$events?: Events;
+        $$slots?: Slots;
+    }): Exports & {
+        $set?: any;
+        $on?: any;
+    };
+    z_$$bindings?: Bindings;
+}
+declare const DsfrTable: $$__sveltets_2_IsomorphicComponent<Props, {
+    [evt: string]: CustomEvent<any>;
+}, {
+    headersegmented: {};
+    headersearch: {};
+    headerbuttons: {};
+    tableheader: {};
+    tablecontent: {};
+    empty: {};
+    footerselect: {};
+    footerpagination: {};
+    footerbuttons: {};
+}, {}, "">;
+type DsfrTable = InstanceType<typeof DsfrTable>;
+export default DsfrTable;