@dk-grid-community/angular
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

DkGrid Community Edition

An Angular Data Grid for Angular Developers

DkGrid is a component engineered and built using the Angular Framework and some CDK behavior primitives to display and manipulate tabular data. You can provide data from an array of JSON objects or a REST API.

DkGrid has ready-to-use features such as filtering, editing, selection, sorting, paging, and column grouping, to mention a few. Apart from the key features, the DkGrid component is highly customizable. For instance, you can change the size of the column headers or the height of the content rows and customize many more properties.

The following image shows our grid with some filters and edition actions enabled.

Compatibility

DkGrid and Angular versions

DkGrid doesn't follow Angular's versioning. Instead, we try to maintain compatibility with Angular majors for as long as possible, only breaking when we need to support a new major version.

Angular DkGrid
14 ^2.0
13 ^1.0
12 ^1.0

License

Creative Commons Licence
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License

Key Features

  • Column definitions ‐ To start using the DkGrid, you may define the columns that comprise your tabular data. There are four types of columns depending on the data they hold. Apart from column definitions, you can group columns with no limit on nesting groups.
  • Customization ‐ You can customize the height of the column headers or the pagination row. In addition, you can make the DkGrid shows a mat-elevation and the value of this elevation. You can also make vertical lines visible and customize many more properties.
  • Column Operations (resizing, moving, locking) ‐ Once you have defined which columns will comprise your DkGrid instance, you can change their size or move them to any of the existing panels. In addition, you can freeze any column in any panel.
  • Cell Formatting ‐ By default, the DkGrid shows every field value with predefined templates depending on the column types. Nevertheless, you can provide your custom templates for each defined column.
  • In-Memory DataSource ‐ The DkGrid uses the In-Memory DataSource when you provide your data from a REST API or simply an array.
  • Filtering ‐ The easiest way to allow the user to filter rows is by displaying a dedicated filter row that shows a textbox for each visible column. Or any column could show a context menu where the user can type their values for each filter condition. You can tell DkGrid which filter conditions to display and define each condition implementation.
  • Editing ‐ You can define which columns the user can edit. By default, the DkGrid offers templates for fields edition, but you can provide your custom templates using the well-known ng-template. Furthermore, the user can toggle the edition mode at runtime.
  • Sorting ‐ The DkGrid allows the user to order the rows by any column. Just tell DkGrid which columns are sortable.
  • Paging ‐ With paging implemented, the DkGrid will only load the number of rows you specify in the DkGrid's pageSize property.
  • Selection ‐ The DkGrid allows the user to select one or more rows through a column of checkboxes. You can specify which rows are selectable, defining the criteria the rows must meet.
  • Theming ‐ The DkGrid bases its theming process on the Angular Material's Theming System, allowing you to apply the same structure the Angular Material components use.

Resources

Getting Started with DkGrid

DkGrid product page

DkGrid product docs

Demos

You can visit our complete demo, which contains 22 columns. Moreover, you can generate up to 100K rows.

Furthermore, we have created one live example for each section in the documentation.

Support

For any issues you might encounter while working with the DkGrid component, please email support@dikesoft.com

Copyright © 2022 Dikesoft. All rights reserved.

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @dk-grid-community/angular

    Weekly Downloads

    4

    Version

    2.0.1

    License

    CC BY-ND 4.0

    Unpacked Size

    9.66 MB

    Total Files

    370

    Last publish

    Collaborators

    • admin-dikesoft