predixdesignsystem / px-data-grid

Predix UI component which defines a data grid
https://www.predix-ui.com/#/elements/px-data-grid
Apache License 2.0
12 stars 20 forks source link

px-data-grid Build Status

Overview

Px-data-grid is a Predix UI component which defines a data grid, optionally using a sub-element for advanced column settings, filtering and pagination.

Usage

Prerequisites

  1. node.js
  2. npm
  3. bower
  4. webcomponents-lite.js polyfill

Node, npm and bower are necessary to install the component and dependencies. webcomponents.js adds support for web components and custom elements to your application.

Getting Started

First, install the component via bower on the command line.

bower install https://github.com/predixdesignsystem/px-data-grid.git --save

Second, import the component to your application with the following tag in your head.

<link rel="import" href="https://github.com/predixdesignsystem/px-data-grid/blob/master/bower_components/px-data-grid/px-data-grid.html">

Finally, use the component in your application:

<px-data-grid table-data="{{data}}">
</px-data-grid>

Local Development

From the component's directory...

$ npm install
$ bower install
$ gulp sass

From the component's directory, to start a local server run:

$ gulp serve

The root of that server (e.g. http://localhost:8080/) will automatically open in your default browser with the API documentation page and interactive working examples.

gulp serve also runs gulp watch concurrently so that when you make a change to your source files and save them, your preview will be updated in any browsers you have opened and turned on in LiveReload.

Running tests from the browser

http://localhost:8080/test

Running tests from the command line

In the px-data-grid directory, run wct

Cross browser testing via SauceLabs

In the px-data-grid directory, run wct --env=saucelabs