⭐Please star this project if you find it useful!
Tubular is a set of AngularJS directives and C# classes designed to rapidly build modern web applications. The centerpiece of Tubular is its fully templateable grid with lots of features such as server-side pagination, multi-column sorting and filtering, built-in export to CSV (client-side), and in-line editing of rows via templates.
Please visit the Tubular GitHub Page to learn how quickly you can start coding. Don't forget to check out the Tubular Generator which quickly turns models into an awesome UIs!
PM> Install-Package Tubular
PM> Install-Package Tubular.ServerSide
# install Tubular package and add it to bower.json $ bower install tubular --save
The npm package only contains the Tubular Template Generator Module, if you want to use all of Tubular's features, please install the Bower package instead.
# install Tubular package and add it to package.json $ npm install tubular --save
You will need to reference the following JS libraries in order to use Tubular in your HTML:
- jQuery - 2.1.4
- Twitter Bootstrap
- AngularJS (optionally Animate and Route)
- AngularJS UI Bootstrap - 1.3
- AngularJS Local Storage
- Font Awesome
- FileSaver.js and Blob.js
Also, if you use the Visual Studio you will need the excellent Web Essentials if you are running VS2013 or Bundler & Minifier plug-in for VS2015 in order to generate the Tubular bundles.
An experimental support to chart is running with Tubular and you can choose between ChartJS or Highcharts. If you want to use any of them, be sure to load the library before Tubular and check Tubular Sample with easy to understand code on how to start using charts.
Tubular Reporting, another experimental module, enables to query and design in runtime any grid joining all your tables and allowing to aggregate data. All this using a .NET Proxy in your REST service. Check the Sample in code or the online Reporting page connecting to an Azure Website.
You can get all the dependencies using the following links in your master HTML page. jsDelivr provides almost everything you need to import.
<link rel="stylesheet" href="//cdn.jsdelivr.net/bootstrap/latest/css/bootstrap.min.css" />
<link rel="stylesheet" href="//cdn.jsdelivr.net/fontawesome/latest/css/font-awesome.min.css" />
<script src="//cdn.jsdelivr.net/g/jquery@2.1.4,bootstrap,angularjs(angular.min.js+angular-animate.min.js+angular-route.min.js),filesaver.js,angular.bootstrap@1.3(ui-bootstrap.min.js+ui-bootstrap-tpls.min.js),blob.js(Blob.js),filesaver.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/angular-local-storage/0.1.5/angular-local-storage.min.js"></script>
Then you will need to either grab your own copy of Tubular or you use jsDelivr to reference Tubular CSS and JS files.
<link rel="stylesheet" href="//cdn.jsdelivr.net/tubular/latest/tubular-bundle.min.css" />
<script src="//cdn.jsdelivr.net/tubular/latest/tubular-bundle.min.js"></script>
Finally update your modules to include Tubular, for example if your module is called app, then you will need to add Tubular as a dependency as follows:
angular.module('app', ['ngRoute','tubular']);
You can access to global settings by using the static object TubularDefaultSettings and setup common behavior in Tubular. The settings included are:
Setting | Default value | Notes |
---|---|---|
AdjustTimezoneOffset | True | Determines if the DateTime from a Response should adjust the timezone offset send by within the Request. |
##Boilerplate
We have a basic Boilerplate with everything that you need to start your own tubular project. If you are working with .NET WebAPI you can check our C# Boilerplate too.
A Yeoman Generator can be found at generator-tubular but it's not longer in maintenance.
You can check out the Tubular GitHub Page to get a few examples. We still need to work on more samples and better documentation, but we feel what we have now will get you up to speed very quickly :).
The following HTML represents a basic grid. You don't need to add anything else to your controller! Everything you need is to create your markup.
<div class="container">
<tb-grid server-url="/data/customers.json" page-size="20"
class="row" grid-name="mygrid">
<div class="col-md-12">
<div class="panel panel-default panel-rounded">
<tb-grid-table class="table-bordered">
<tb-column-definitions>
<tb-column name="CustomerName">
<tb-column-header>
<span>{{label}}</span>
</tb-column-header>
</tb-column>
<tb-column name="Invoices">
<tb-column-header>
<span>{{label}}</span>
</tb-column-header>
</tb-column>
</tb-column-definitions>
<tb-row-set>
<tb-row-template ng-repeat="row in $component.rows"
row-model="row" selectable="true">
<tb-cell-template>
{{row.CustomerName}}
</tb-cell-template>
<tb-cell-template>
{{row.Invoices}}
</tb-cell-template>
</tb-row-template>
</tb-row-set>
</tb-grid-table>
</div>
</div>
</tb-grid>
</div>
Tubular works directly with either your own OData service or a custom RESTful call. You can simplify your RESTful API significantly by using our .NET Tubular.ServerSide library which handles IQueryables easily.