Skip to content

A Hugo module to enhance tables powered by simple-datatables to your Hinode site

License

Notifications You must be signed in to change notification settings

gethinode/mod-simple-datatables

Repository files navigation

Hinode Module - Simple Datatables

A Hugo module to enhance tables powered by simple-datatables to your Hinode site

About

Logo

Hinode is a clean blog theme for Hugo, an open-source static site generator. Hinode is available as a template, and a main theme. This repository maintains a Hugo module to add simple-datatables to a Hinode site. Visit the Hinode documentation site for installation instructions.

Contributing

This module uses semantic-release to automate the release of new versions. The package uses husky and commitlint to ensure commit messages adhere to the Conventional Commits specification. You can run npx git-cz from the terminal to help prepare the commit message.

Usage

Simple datatables is compatible with Bootstrap tables. It uses Hugo's i18n folder for the translation tables of multilingual sites. Add the attribute data-table to the class of any table. The following arguments are supported:

Argument Default Description
data-table-sortable true Toggle the ability to sort the columns.
data-table-paging true Whether paging is enabled for the table.
data-table-paging-option-perPage 10 Paging option: Sets the maximum number of rows to display on each page. Type: int
data-table-paging-option-perPageSelect [5, 10, 20, 50, ["{{ T "tablePerPageSelectAll" }}", -1]] Paging option: Sets the per page options in the dropdown. i18 translation id for all: tablePerPageSelectAll
data-table-searchable true Toggle the ability to search the dataset.