DataTableFooter
Pagination and items-per-page footer bar rendered below the DataTable body.
Structure
Anatomie
Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.
<origam-data-table-footer> — 3 internal parts: items-per-page, page info label and pagination.- 1.origam-data-table-footer__items-per-page
- Items-per-page label + OrigamSelect dropdown. Fires setItemsPerPage() on change.
- 2.origam-data-table-footer__info
- Localised page range label: "start–stop of total". Driven by usePagination().
- 3.origam-data-table-footer__pagination
- OrigamPagination with density="compact", showFirstLastPage and rounded. Syncs currentPage with the shared pagination context.
API
Props
Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et description.
- prevIcon
- Icon for the previous-page button forwarded to the embedded OrigamPagination.
- nextIcon
- Icon for the next-page button forwarded to the embedded OrigamPagination.
- firstIcon
- Icon for the first-page button forwarded to the embedded OrigamPagination.
- lastIcon
- Icon for the last-page button forwarded to the embedded OrigamPagination.
- itemsPerPageTextstring'origam.dataFooter.itemsPerPageText'
- Label text displayed before the items-per-page select. Resolved via useLocale().
- pageTextstring'origam.dataFooter.pageText'
- Template string for the current page range info (e.g. "1-10 of 50"). Resolved via useLocale().
- firstPageLabelstring'origam.dataFooter.firstPage'
- Aria-label for the first-page pagination button.
- prevPageLabelstring'origam.dataFooter.prevPage'
- Aria-label for the previous-page pagination button.
- nextPageLabelstring'origam.dataFooter.nextPage'
- Aria-label for the next-page pagination button.
- lastPageLabelstring'origam.dataFooter.lastPage'
- Aria-label for the last-page pagination button.
- itemsPerPageOptionsArray<number | { title: string, value: number }>[10, 25, 50, 100, { value: -1, title: "All" }]
- List of selectable page sizes. Pass -1 as value to show all items.
- showCurrentPagebooleantrue
- When true, the current page number is shown in the pagination. When false, only prev/next arrows are rendered.
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- colorTColor
- paddingboolean | number | string
- paddingTopboolean | number | string
- paddingLeftboolean | number | string
- paddingBottomboolean | number | string
- paddingRightboolean | number | string
- paddingBlockboolean | number | string
- paddingInlineboolean | number | string
- paddingInlineStartboolean | number | string
- paddingInlineEndboolean | number | string
- paddingBlockStartboolean | number | string
- paddingBlockEndboolean | number | string
- alignTAlign
- alignSmTAlign
- alignMdTAlign
- alignLgTAlign
- alignXlTAlign
- alignXxlTAlign
API
Slots
Emplacements de contenu exposés par ce composant.
- #prepend
- Content inserted before the items-per-page selector inside the row.
- #append
- Content inserted after the pagination control at the end of the row.
API
Membres exposés
Propriétés et méthodes accessibles via ref template (defineExpose). Utilisés pour le contrôle programmatique.
- <T extends object>(props: T, exclude?: string[]) => Partial<T>
- Utility to forward a filtered subset of props to a child component.
- Ref<string>
- Reactive CSS string from useStyle, injected as a scoped style sheet.
- string
- Unique style-sheet ID for this instance.
- () => void
- Injects the computed style sheet. Called automatically on mount.
- () => void
- Removes the injected style sheet. Called automatically on unmount.
- Ref<boolean>
- True once the style sheet has been injected into the DOM.
Personnalisation
Variables CSS
Propriétés CSS personnalisées exposées par ce composant. Surchargez-les pour personnaliser sans perdre la compatibilité avec le thème.
- Vertical alignment of footer row items.
- Footer background color.
- Footer text color.
- Top and bottom padding of the footer.
- Left and right padding of the footer.
- Minimum width of the page info label area.
Inclusion
Accessibilité
Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.
Rôles ARIA
Interactions clavier
| Touche | Action |
|---|---|
| Tab | Moves focus through the items-per-page select and pagination buttons. |
Notes
- The embedded OrigamPagination provides aria-label attributes on first/prev/next/last buttons via firstPageLabel, prevPageLabel, nextPageLabel and lastPageLabel props.
Interactif
Playground
Modifiez les props en direct et observez le composant se mettre à jour. Le snippet de code généré suit vos changements.
Sous-partie interne : elle est injectée par son composant parent et ne peut pas se rendre seule. Voir la fiche du composant parent pour un exemple vivant.
Rendu de l’aperçu en cours…
Usage
Exemples
Extraits de code prêts à coller dans vos templates.
Usage inside DataTable
Écosystème
Famille
Composants du même dossier qui partagent les conventions et se composent souvent ensemble.
DataTableHeaderCell
Single column header cell with sort icon and sort badge.
DataTableHeaders
Header row renderer — iterates over column definitions to produce <th> cells.
DataTableRow
Body row (<tr>) with hover, selected and striped state support.
DataTableRows
Rows container — renders loading, empty, group and data rows.