@brightspace-ui-labs/pagination

A component to indicate the existence of multiple pages of content, and to provide a mechanism to navigate them.

Usage no npm install needed!

<script type="module">
  import brightspaceUiLabsPagination from 'https://cdn.skypack.dev/@brightspace-ui-labs/pagination';
</script>

README

d2l-labs-pagination

NPM version

Note: this is a "labs" component. While functional, these tasks are prerequisites to promotion to BrightspaceUI "official" status:

animated screenshot of pagination component

A component to indicate the existence of, and provide navigation for, multiple pages of content.

Installation

To install from NPM:

npm install @brightspace-ui-labs/pagination

Usage

<script type="module">
    import '@brightspace-ui-labs/pagination/pagination.js';
</script>
<d2l-labs-pagination></d2l-labs-pagination>

Properties:

  • page-number (required, Number): The current page number
  • max-page-number (required, Number): The highest page number the user could navigate to
  • show-item-count-select (Boolean, default:False): Determines whether or not to show the Results Per Page select component.
  • item-count-options (Array, default:[10,20,30,40]): The options available in the Results Per Page select component.
  • selected-count-option(Number): The starting item-count-options option to display in the Results Per Page select component.

Events: The d2l-labs-pagination dispatches the pagination-page-change event when either the navigation buttons are pressed, or the page number is modified to point to a valid page number. It will return the number of the requested page:

pagination.addEventListener('pagination-page-change', (e) => {
  console.log(e.detail.page);
});

The d2l-labs-pagination dispatches the pagination-item-counter-change event when the item count selector is value is changed. It will return the number of items requested per page:

pagination.addEventListener('pagination-item-counter-change', (e) => {
  console.log(e.detail.itemCount);
});

Developing, Testing and Contributing

After cloning the repo, run npm install to install dependencies.

Running the demos

To start an es-dev-server that hosts the demo page and tests:

npm start

Linting

# eslint and lit-analyzer
npm run lint

# eslint only
npm run lint:eslint

# lit-analyzer only
npm run lint:lit

Testing

# lint, unit test and visual-diff test
npm test

# lint only
npm run lint

# unit tests only
npm run test:headless

# debug or run a subset of local unit tests
# then navigate to `http://localhost:9876/debug.html`
npm run test:headless:watch

Versioning & Releasing

TL;DR: Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to master. Read on for more details...

The sematic-release GitHub Action is called from the release.yml GitHub Action workflow to handle version changes and releasing.

Version Changes

All version changes should obey semantic versioning rules:

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards compatible manner, and
  3. PATCH version when you make backwards compatible bug fixes.

The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the Angular convention when analyzing commits:

  • Commits which are prefixed with fix: or perf: will trigger a patch release. Example: fix: validate input before using
  • Commits which are prefixed with feat: will trigger a minor release. Example: feat: add toggle() method
  • To trigger a MAJOR release, include BREAKING CHANGE: with a space or two newlines in the footer of the commit message
  • Other suggested prefixes which will NOT trigger a release: build:, ci:, docs:, style:, refactor: and test:. Example: docs: adding README for new component

To revert a change, add the revert: prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: revert: fix: validate input before using.

Releases

When a release is triggered, it will:

  • Update the version in package.json
  • Tag the commit
  • Create a GitHub release (including release notes)
  • Deploy a new package to NPM

Releasing from Maintenance Branches

Occasionally you'll want to backport a feature or bug fix to an older release. semantic-release refers to these as maintenance branches.

Maintenance branch names should be of the form: +([0-9])?(.{+([0-9]),x}).x.

Regular expressions are complicated, but this essentially means branch names should look like:

  • 1.15.x for patch releases on top of the 1.15 release (after version 1.16 exists)
  • 2.x for feature releases on top of the 2 release (after version 3 exists)