DataTableFooter
Pagination and items-per-page footer bar rendered below the DataTable body.
Structure
Anatomy
Visual breakdown of the component's internal structure with BEM class call-outs.
<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
All props accepted by this component, with their type, default value and 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
Content slots exposed by this component.
- #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
Exposed members
Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.
- <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.
Customisation
CSS variables
CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.
- 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
Accessibility
ARIA roles, keyboard navigation and focus management. Sourced from the real component template.
ARIA roles
Keyboard interactions
| Key | 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.
Interactive
Playground
Edit props live and see the component update in real time. The generated code snippet updates as you change values.
This is an internal sub-part: it is injected by its parent component and cannot render on its own. See the parent component page for a live example.
Rendering the live preview…
Usage
Examples
Ready-to-paste code snippets for your templates.
Usage inside DataTable
Ecosystem
Family
Components from the same folder that share conventions and often compose together.
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.