From 1e43e5b0a77e9148a1e100bdb940d3854f66cefe Mon Sep 17 00:00:00 2001 From: Aron Graham Date: Mon, 22 Oct 2018 23:49:46 +1100 Subject: [PATCH] Update PredixDev references to predixdesignsystem --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2b1e6d6..4a8535e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# px-data-table [![Build Status](https://travis-ci.org/PredixDev/px-data-table.svg?branch=master)](https://travis-ci.org/PredixDev/px-data-table) +# px-data-table [![Build Status](https://travis-ci.org/predixdesignsystem​/px-data-table.svg?branch=master)](https://travis-ci.org/predixdesignsystem/px-data-table) ## Overview @@ -20,7 +20,7 @@ Node, npm and bower are necessary to install the component and dependencies. web First, install the component via bower on the command line. ``` -bower install https://github.com/PredixDev/px-data-table.git --save +bower install https://github.com/predixdesignsystem​/px-data-table.git --save ``` Second, import the component to your application with the following tag in your head. @@ -48,37 +48,33 @@ Minimum - Server-Side Sort/Filter/Pagination: remote-data="true" > - ``` ### Client-Side VS Server-Side Data Paradigms There are two main paradigms for the source of data in a table. -In a *Client-Side* model, the browser makes one request for the _complete set_ of data. +In a _Client-Side_ model, the browser makes one request for the _complete set_ of data. This means that sorting, filtering, and pagination all happen in memory on the client. While this produces snappy tables with reasonably sized data sets, it can lead to a sluggish UI for larger data sets. This works great with data sets that don't change frequently, since the full payload would have to be resent for every update. -In a *Server-Side* model, the browser makes a request for a _subset_ of data for a particular page. +In a _Server-Side_ model, the browser makes a request for a _subset_ of data for a particular page. Sorting, filtering, and pagination requests will have to be made to a service for a new _subset_ of data that matches the user's intended criteria. This prevents the browser from being overwhelmed with excessively large data sets by only exposing one page's worth of data at a time. This is ideal for larger data sets or where it is preferable to make multiple small requests instead of fewer larger requests. Due to the increased frequency of requests, the UI is more likely to display data in sync with the server. - ### Client Side Sort/Filter/Pagination For more details and complex examples: [Client-Side Data Reference](docs/client-side-data.md) - ### Server Side Sort/Filter/Pagination For more details and complex examples: [Server-Side Data Reference](docs/server-side-data.md) - ### Integrating with other frameworks (ex: Angular): You may not be able to use 2-way binding with the objects/arrays in other frameworks such as Angular. @@ -101,10 +97,9 @@ $scope.doSomethingWithSelectedRows = function() { You may also want to prevent your data from auto-synching with your model. If so, we've written up a [little explanation] to help you with that. - ## Documentation -Read the full API and view the demo [here](https://predixdev.github.io/px-data-table). +Read the full API and view the demo [here](https://www.predix-ui.com/#/elements/data-table/px-data-table). ## Local Development @@ -127,8 +122,9 @@ The root of that server (e.g. http://localhost:8080/) will automatically open in `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. ### GE Coding Style Guide + [GE JS Developer's Guide](https://github.com/GeneralElectric/javascript) ## Known Issues -Please use [Github Issues](https://github.com/PredixDev/px-data-table/issues) to submit any bugs you might find. +Please use [Github Issues](https://github.com/predixdesignsystem/px-data-table/issues) to submit any bugs you might find.