Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ui-grid/core

angular-ui745MIT4.12.7

A data grid for Angular

angular, ng-grid, nggrid, grid, angularjs, slickgrid, kogrid, ui-grid, ui grid, data grid, ui-grid/core

readme

UI-Grid Core

UI-Grid (formerly ng-grid), is a 100% angularJS grid written with no dependencies other than AngularJS. It is designed around a core grid module and plugins are layered on as angular modules and directives. This keeps the core small and focused while executing very complex features only when you need them.

In the core module, you get:

  • Virtualized rows and columns - only the rows and columns visible in the viewport (+ some extra margin) are actually rendered
  • Bind cells to complex properties and functions
  • Column sorting with three states: Asc, Desc, None
  • Column filtering
  • Ability to change header and cell contents with custom templates
  • i18nService that allows label translations, with the english translations already loaded.

Getting Started

You can install @ui-grid/core via:

npm i --save @ui-grid/core

Once you install you need to load the respective JS and CSS files as seen bellow:

<link rel="stylesheet" href="/node_modules/@ui-grid/core/css/ui-grid.min.css" type="text/css">
<script src="/node_modules/@ui-grid/core/js/ui-grid.core.min.js">

Alternatively, if you are using Webpack or RequireJS to load your dependencies, you can do the following at the top of the file that needs it:

require('@ui-grid/core');

Once you load the file, you need to include 'ui.grid' module in your angularJS app's dependencies, and add the ui-grid directive to your page.

angular.module('myApp', [
    'ui.grid'
]);
<div ui-grid="$ctrl.gridOptions">

And don't forget to load your data:

this.gridOptions = {
    data: [
        {name: 'Hobie Brown', company: 'Parker Industries', position: 'Head of Security'},
        {name: 'Jacob Fury', company: 'Stark Industries', position: 'Research Scientist'},
        {name: 'Max Dillon', company: 'Oscorp', position: 'Elitrical Engineer'}
    ]
};

Example

You can find an example of this component in action on our website

API Documentation

Documentation for the grid is provided in the api documentation, but we recommend that you pay special attention to the following:

Issues

You can find issues that are specific to the core UI-Grid by looking for the label grid-core in the ui-grid github issues page.

License

MIT

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

4.12.7 (2024-04-12)

Bug Fixes

  • core: remove upper limit for AngularJs (5517031)

4.12.5 (2024-04-11)

Bug Fixes

  • core: make scrollToIfNecessary bottom scroll work with bottom pixel of the row. (c8405a7)

4.12.4 (2023-08-17)

Bug Fixes

  • 🐛 update the index accordingly when modifying existing rows (945d4f8)

4.12.2 (2023-01-23)

Bug Fixes

  • 🐛 support custom interpolation symbols on defaultColumnBuilder (7630fd3), closes #6963

4.12.0 (2023-01-12)

Bug Fixes

  • pinning: blank space between pinnedRight column and the last unpinned column (7687192), closes #4949 #6284

Features

  • 🎸 option to disable GridMenu close on scrolling (6d3f006)

4.11.1 (2022-02-23)

Bug Fixes

  • Find or Select by Row Entity's 'ID' (7a0a6c6)
  • exchanged filter() with every() (583940f)

4.11.0 (2021-08-12)

Bug Fixes

  • 🐛 ensure viewport height cannot be negative (a7111a1), closes #3034

Features

  • 🎸 option to disable multi-column sorting (c9abb8b), closes #2913
  • 🎸 the ability to disable hide columns on a grid level (2dd1688), closes #1604

4.10.3 (2021-08-01)

Bug Fixes

  • 🐛 address linting issues and unit test failures (a9cf59f)
  • export filter with time part ('date:"MM-dd-YYYY HH:mm'). (29d4803)
  • canvas now has a minimum height of 1px, which renders it even if it has no data (07c26d5)
  • adjustColumns now calculates the colIndex instead of guessing it scrollpercentage (ed76f02)

4.10.2 (2021-06-14)

Bug Fixes

  • 🐛 improve accessibility in the grid menus and selection (e5ae7c0)
  • core: use allowFloatWidth property to allow float calculations for width (bb28b2f)
  • core: use allowFloatWidth property to allow float calculations for width (f4d3e22)

4.10.1 (2021-05-28)

Bug Fixes

  • 🐛 ensure select all checkbox is announced correctly (3b478fa)
  • 🐛 remove extra $applyAsync from header-cell (f9a84ff)

4.9.1 (2020-10-26)

Bug Fixes

  • 🐛 update rtl support function to fix rtl support (75580b8), closes #7126

4.9.0 (2020-09-27)

Bug Fixes

  • 🐛 replace missing string with empty string (f7d48ee), closes #7063

BREAKING CHANGES

  • MISSING string will no longer be displayed.

4.8.5 (2020-09-14)

Note: Add support for angular 1.8.0

4.8.4 (2020-09-14)

Note: Version bump only for package @ui-grid/core

4.8.2 (2019-10-07)

Bug Fixes

  • core: scrollToIfNecessary not properly including rowHeight on downward scrolls (7a0e1dc)
  • scrolling: column footers misaligned with data #6909 (74f9107)

4.8.1 (2019-06-27)

Bug Fixes

4.8.0 (2019-05-02)

Bug Fixes

  • less: improve less compilation (2ab139e)

Features

  • filterChanged: pass the changed column as first argument to filterChanged function (13eacc3), closes #4775

4.7.0 (2019-02-01)

Features

  • css: add feature based CSS files (9e1c042)