README

Angular Smart Table Component

ng2-smart-table component made with :heart: by Akveo team. Follow us on Twitter to get latest news about this component first!

Demo

Live Demo

alt tag

Installation

The library is available as npm package, so all you need to do is to run the following command:

npm install --save @vamidicreations/ng2-smart-table

This command will create a record in your package.json file and install the package into the npm modules folder.

Minimal Setup Example

First thing you need to do is to import the ng2-smart-table directives into your component.


import { Ng2SmartTableModule } from '@vamidicreations/ng2-smart-table';

Then register it by adding to the list of directives of your module:

// ...

@NgModule({
  imports: [
    // ...
    
    Ng2SmartTableModule,
    
    // ...
  ],
  declarations: [ ... ]
})
// ...

Now, we need to configure the table and add it into the template. The only required setting for the component to start working is a columns configuration. Let's register settings property inside of the component where we want to have the table and configure some columns Settings documentation:

Edited by Arno van den Brink and Valencio Hoffman

Changes are:

Option to re-oder columns from the table
Option to add tooltip to a column from the table You will still get the columns value when retrieving the row

Usage:

  settings = {
    columns: {
      id: {
        title: 'ID',
        hide: true // new @akveo/ng2-smart-table method
      }
  }

Demo expandable row

Usage:

  settings = {
    expandedRowComponent: YOUR_CUSTOM_ENTRY_COMPONENT,
    columns: {
      id: {
        title: 'ID',
      },
      fullname: {
        title: 'Full Name',
      },
            username: {
                title: 'User Name',
            },
            email: {
                title: 'Email',
            }
    }
  }

Demo reordering

Usage:

  settings = {
    columns: {
      id: {
        title: 'ID',
        index: 1,
      },
      fullname:
      {
        title: 'Full Name',
        index: 0,
      }
    }
  }

This demo will put full name at the beginning of the table, even though ID is placed first.

Note that the index should be defined in the right sequence in order to make it work.

Demo tooltip

Usage:

  settings = {
    columns: {
      id: {
        title: 'ID',
        tooltip: { enabled: true, text: 'This is a tooltip of column ID' },
      },
      fullname:
      {
        title: 'Full Name',
      }
    }
  }

Minimal example

settings = {
  columns: {
    id: {
      title: 'ID'
    },
    name: {
      title: 'Full Name'
    },
    username: {
      title: 'User Name'
    },
    email: {
      title: 'Email'
    }
  }
};

Finally let's put the ng2-smart-table component inside of the template:

// ...

@Component({
  template: `
    <ng2-smart-table [settings]="settings"></ng2-smart-table>
  `
})
// ...

At this step you will have a minimal configured table. All functions are available by default and you don't need to configure them anyhow, so now you can add/edit/delete rows, sort or filter the table, etc.

Still it seems like something is missing... Right, there is no data in the table by default. To add some, let's create an array property with a list of objects in the component. Please note that object keys are the same as in the columns configuration.

data = [
  {
    id: 1,
    name: "Leanne Graham",
    username: "Bret",
    email: "Sincere@april.biz"
  },
  {
    id: 2,
    name: "Ervin Howell",
    username: "Antonette",
    email: "Shanna@melissa.tv"
  },
  
  // ... list of items
  
  {
    id: 11,
    name: "Nicholas DuBuque",
    username: "Nicholas.Stanton",
    email: "Rey.Padberg@rosamond.biz"
  }
];

And pass the data to the table:

// ...

@Component({
  template: `
    <ng2-smart-table [settings]="settings" [source]="data"></ng2-smart-table>
  `
})
// ...

Now you have some data in the table.

Further Documentation

Installation, customization and other useful articles: https://akveo.github.io/ng2-smart-table/

How can I support developers?

Star our GitHub repo :star:
Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
Follow us on Twitter :feet:
Like our page on Facebook :thumbsup: