Pager - Documentation | www.HtmlElements.com

Overview

Smart.Pager represents an element, which is used for navigation between multiple pages, by clicking on its components.

Getting Started with Pager Web Component

Smart UI for Web Components is distributed as smart-webcomponents NPM package. You can also get the full download from our website with all demos from the Download page.

Setup the Pager

Smart UI for Web Components is distributed as smart-webcomponents NPM package

  1. Download and install the package.

    npm install smart-webcomponents

  2. Once installed, import the Pager module in your application.

    <script type="module" src="node_modules/smart-webcomponents/source/modules/smart.pager.js"></script>

  3. Adding CSS reference

    The smart.default.css CSS file should be referenced using following code.

    <link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />

  4. Add the Pager tag to your Web Page

    <smart-pager id="pager"></smart-pager>

  5. Create the Pager Component

    	<script type="module">
    		Smart('#pager', class {
    			get properties() {
    				return { disabled: true }
    			}
    		});
    	</script>	   
    		

    Another option is to create the Pager is by using the traditional Javascript way:
    	const pager = document.createElement('smart-pager');
    
    	pager.disabled = true;
    	document.body.appendChild(pager);
    		

    Smart framework provides a way to dynamically create a web component on demand from a DIV tag which is used as a host. The following imports the web component's module and creates it on demand, when the document is ready. The #pager is the ID of a DIV tag.

    	import "../../source/modules/smart.pager.js";
    
    	document.readyState === 'complete' ? init() : window.onload = init;
    
    	function init() { 
    		const pager = new Smart.Pager('#pager', { disabled: true });
    	}
    	

  6. Open the page in your web server.

Appearance

The total number of items and the number of visualized items are controlled by the following properties :

  • pagesCount - total number of items.
  • pageIndexSelectors - the number of items displayed on page.

The pager can have multiple navigation buttons, controlled by the following properties:

  • showFirstLastNavigationButtons - buttons for navigation to the firs and the last item.
  • showPrevNextNavigationButtons - buttons for navigation to the previous and the next item.
  • autoEllipsis - ellipsis buttons are displayed as indicators and additional help to navigate between pages. Available options are:
    • none - ellipsis are hidden.
    • before - ellipsis are shown as navigation to previous page only.
    • after - ellipsis are shown as navigation to next page only.
    • both - ellipsis are shown as navigation to both previous and next pages.
<!DOCTYPE html>
<html lang="en">
<head>
 <link rel="stylesheet" href="../../source/styles/smart.default.css" type="text/css" />
 <script type="text/javascript" src="../../source/smart.element.js"></script>
 <script type="text/javascript" src="../../source/smart.button.js"></script>
 <script type="text/javascript" src="../../source/smart.scrollbar.js"></script>
 <script type="text/javascript" src="../../source/smart.listbox.js"></script>
 <script type="text/javascript" src="../../source/smart.dropdownlist.js"></script>
 <script type="text/javascript" src="../../source/smart.pager.js"></script>
</head>
<body>
    <smart-pager show-prev-next-navigation-buttons show-first-last-navigation-buttons show-page-index-selectors pages-count="5" page-index-selectors="5" show-summary></smart-pager>
</body>
</html>

Demo

Additional options to control the element are :

  • showSummary - controls the visibility of segment that displays range of visible items.
  • showPageSizeSelector - Determines whether the page size selector is displayed.
  • showNavigationInput - Determines whether the navigation input is displayed.
 <smart-pager show-page-size-selector show-navigation-input show-prev-next-navigation-buttons pages-count="10" show-summary></smart-pager>

Demo

Instead arrows, navigation buttons can have text labels. To achieve this, showNavigationButtonLabels property must be set to true.
An element with shown text labels, could be localized. The user can define the text, wich is shown in for particular language. Setting of messages defines the text values of each button. Locale defines the language used at the moment.

 <smart-pager show-navigation-button-labels locale="fr" show-prev-next-navigation-buttons show-first-last-navigation-buttons how-page-index-selectors pages-count="300" page-index-selectors="10" ></smart-pager>

Demo

Methods

The element offers the following methods:

  • first - Selects first item.
     <script>
         window.onload = function () {
             var pager = document.querySelector('smart-pager');
             pager.first();
         }
     </script>
    
  • last - Selects last item.
     <script>
         window.onload = function () {
             var pager = document.querySelector('smart-pager');
             pager.last();
         }
     </script>
    
  • navigateTo - Navigates to an item with particular index.
     <script>
         window.onload = function () {
             var pager = document.querySelector('smart-pager');
             pager.navigateTo(5);
         }
     </script>
    
  • next - Navigates to the next item(if exists such an item).
     <script>
         window.onload = function () {
             var pager = document.querySelector('smart-pager');
             pager.next();
         }
     </script>
    
  • prev - Navigates to the previous item(if exists such an item).
     <script>
         window.onload = function () {
             var pager = document.querySelector('smart-pager');
             pager.prev();
         }
     </script>
    

Keyboard Support

User can navigate between the items via arrow keys. Arrow Up, Arrow Right and Page Up increase the page index, Arrow Down, Arrow Left and Page Down decrease it. Home moves the selection to the first item, End to the last.

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event


Create a new element:
	const pager = document.createElement('smart-pager');
	

Append it to the DOM:
	document.body.appendChild(pager);
	

Remove it from the DOM:
	pager.parentNode.removeChild(pager);
	

Set a property:
	pager.propertyName = propertyValue;
	

Get a property value:
	const propertyValue = pager.propertyName;
	

Invoke a method:
	pager.methodName(argument1, argument2);
	

Add Event Listener:
	const eventHandler = (event) => {
	   // your code here.
	};

	pager.addEventListener(eventName, eventHandler);
	

Remove Event Listener:
	pager.removeEventListener(eventName, eventHandler, true);
	

Using with Typescript

Smart Web Components package includes TypeScript definitions which enables strongly-typed access to the Smart UI Components and their configuration.

Inside the download package, the typescript directory contains .d.ts file for each web component and a smart.elements.d.ts typescript definitions file for all web components. Copy the typescript definitions file to your project and in your TypeScript file add a reference to smart.elements.d.ts

Read more about using Smart UI with Typescript.

Getting Started with Angular Pager Component

Setup Angular Environment

Angular provides the easiest way to set angular CLI projects using Angular CLI tool.

Install the CLI application globally to your machine.

npm install -g @angular/cli

Create a new Application

ng new smart-angular-pager

Navigate to the created project folder

cd smart-angular-pager

Setup the Pager

Smart UI for Angular is distributed as smart-webcomponents-angular NPM package

  1. Download and install the package.
    npm install smart-webcomponents-angular
  2. Once installed, import the PagerModule in your application root or feature module.

    app.module.ts

    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
    
    import { PagerModule } from 'smart-webcomponents-angular/pager';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, PagerModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ AppComponent ]
    })
    
    export class AppModule { }
    	

  3. Adding CSS reference

    The following CSS file is available in ../node_modules/smart-webcomponents-angular/ package folder. This can be referenced in [src/styles.css] using following code.

    	@import 'smart-webcomponents-angular/source/styles/smart.default.css';

    Another way to achieve the same is to edit the angular.json file and in the styles add the style.

    	"styles": [
    		"node_modules/smart-webcomponents-angular/source/styles/smart.default.css"
    	]
    	
  4. Example


    app.component.html

     
    <smart-pager #pager [showPrevNextNavigationButtons]="true" [showFirstLastNavigationButtons]="true"
        [showPageIndexSelectors]="true" [pagesCount]="5" [pageIndexSelectors]="5"></smart-pager>
    		

    app.component.ts

     
    import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
    import { PagerComponent } from 'smart-webcomponents-angular/pager';
    
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
    	styleUrls: ['./app.component.css']
    })
    
    export class AppComponent implements AfterViewInit, OnInit {	
    	@ViewChild('pager', { read: PagerComponent, static: false }) pager: PagerComponent;
    	
     
    	ngOnInit(): void {
    		// onInit code.
    	}
    
    	ngAfterViewInit(): void {
    		// afterViewInit code.
    		this.init();
        }
    		
    	init(): void {
    		// init code.
    	    
    
    	}	
    }
    		

    app.module.ts

     
    import { NgModule } from '@angular/core';
    import { BrowserModule } from '@angular/platform-browser';
    
    import { PagerModule } from 'smart-webcomponents-angular/pager';
    
    import { AppComponent } from './app.component';
    
    @NgModule({
        declarations: [ AppComponent ],
        imports: [ BrowserModule, PagerModule ],
        bootstrap: [ AppComponent ],
    	entryComponents: [ AppComponent ]
    })
    
    export class AppModule { }
    		


Running the Angular application

After completing the steps required to render a Pager, run the following command to display the output in your web browser

ng serve
and open localhost:4200 in your favorite web browser.

Read more about using Smart UI for Angular: https://www.htmlelements.com/docs/angular-cli/.

Getting Started with React Pager Component

Setup React Environment

The easiest way to start with React is to use create-react-app. To scaffold your project structure, follow the installation instructions.

	npm install -g create-react-app
	create-react-app my-app
	cd my-app
	npm start
	

Preparation

Open src/App.js andsrc/App.css

  1. Remove everything inside the App div tag in src/App.js:
    <div className="App"> </div>
  2. Remove the logo.svg import
  3. Remove the contents of src/App.css
  4. Remove src/logo.svg

Setup the Pager

Smart UI for React is distributed as smart-webcomponents-react NPM package

  1. Download and install the package.
    npm install smart-webcomponents-react
  2. Once installed, import the React Pager Component and CSS files in your application and render it app.js

    import 'smart-webcomponents-react/source/styles/smart.default.css';
    import React from "react";
    import ReactDOM from "react-dom";
    import { Pager } from 'smart-webcomponents-react/pager';
    
    class App extends React.Component {
    
    	componentDidMount() {
    
    	}
    
    	render() {
    		return (
    			<div>
    			    <Pager showPrevNextNavigationButtons showFirstLastNavigationButtons
    			    showPageIndexSelectors pagesCount={5} pageIndexSelectors={5}></Pager>
    			</div>
    		);
    	}
    }
    
    ReactDOM.render(<App />, document.querySelector("#root"));
    
    export default App;
    	

Running the React application

Start the app with
npm start
and open localhost:3000 in your favorite web browser to see the output.

Read more about using Smart UI for React: https://www.htmlelements.com/docs/react/.

Getting Started with Vue Pager Component


Setup Vue Environment

We will use vue-cli to get started. Let's install vue-cli

npm install -g @vue/cli

Then we can start creating our Vue.js projects with:

vue create my-project

Setup the Pager

Open the "my-project" folder and run:

npm install smart-webcomponents

Setup with Vue 3.x

  • Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

    Open src/main.js in your favorite text editor and change its contents to the following:

    main.js

    import { createApp } from 'vue'
    import App from './App.vue'
    
    const app = createApp(App)
    
    app.config.isCustomElement = tag => tag.startsWith('smart-');
    app.mount('#app')
    		
  • Open src/App.vue in your favorite text editor and change its contents to the following:

    App.vue

    <template>
      <div class="vue-root">
        <smart-pager
          show-prev-next-navigation-buttons
          show-first-last-navigation-buttons
          show-page-index-selectors
          pages-count="5"
          page-index-selectors="5"
        ></smart-pager>
      </div>
    </template>
    
    <script>
    import { onMounted } from "vue";
    import "smart-webcomponents/source/styles/smart.default.css";
    import "smart-webcomponents/source/modules/smart.pager.js";
    
    export default {
      name: "app",
      setup() {
        onMounted(() => {});
      }
    };
    </script>
    
    <style>
    </style>
    		
    We can now use the smart-pager with Vue 3. Data binding and event handlers will just work right out of the box.

Setup with Vue 2.x

  • Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

    Open src/main.js in your favorite text editor and change its contents to the following:

    main.js

    import Vue from 'vue'
    import App from './App.vue'
    
    Vue.config.productionTip = false
    Vue.config.ignoredElements = [
    'smart-pager'
    ]
    
    new Vue({
      render: h => h(App),
    }).$mount('#app')
  • Open src/App.vue in your favorite text editor and change its contents to the following:

    App.vue

    <template>
      <smart-pager show-prev-next-navigation-buttons show-first-last-navigation-buttons show-page-index-selectors pages-count="5" page-index-selectors="5"></smart-pager>
    </template> 
    
    <script>
    import 'smart-webcomponents/source/modules/smart.pager.js';
    import "smart-webcomponents/source/styles/smart.default.css";
    
    export default {
      name: "app"
    };
    </script>
    
    <style>
    </style>
    		
    We can now use the smart-pager with Vue. Data binding and event handlers will just work right out of the box.
    We have bound the properties of the smart-pager to values in our Vue component.

Running the Vue application

Start the app with
npm run serve
and open localhost:8080 in your favorite web browser to see the output below:

Read more about using Smart UI for Vue: https://www.htmlelements.com/docs/vue/.