|
1 | 1 |
|
2 |
| -ag-Grid |
3 |
| -============== |
| 2 | + |
| 3 | + |
4 | 4 | [](https://cdnjs.com/libraries/ag-grid)
|
5 | 5 | [](https://www.npmjs.com/package/ag-grid)
|
6 | 6 | [](https://www.npmjs.com/package/ag-grid)
|
7 | 7 |
|
8 |
| -"ag" stands for AGnostic |
| 8 | +ag-Grid |
| 9 | +------ |
| 10 | + |
| 11 | +ag-Grid is a fully-featured and highly customizable JavaScript data grid. |
| 12 | +It delivers [outstanding performance](https://www.ag-grid.com/example.php?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github#/performance/1), has no 3rd party dependencies and [integrates smoothly with all major JavaScript frameworks](https://www.ag-grid.com/javascript-grid-getting-started?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github). Here's how our grid looks like with multiple filters and grouping enabled: |
9 | 13 |
|
10 |
| -This project contains all of the core projects for ag-Grid. |
| 14 | + |
11 | 15 |
|
12 |
| -Please refer to each of the respective sub-projects for more information on each: |
13 | 16 |
|
14 |
| -[ag-grid: Core ag-Grid Project](./packages/ag-grid/README.md) |
15 |
| -[ag-grid-enterprise: ag-Grid Enterprise Project](./packages/ag-grid-enterprise/README.md) |
16 |
| -[ag-grid-angular: ag-Grid Angular Project](./packages/ag-grid-angular/README.md) |
17 |
| -[ag-grid-react: ag-Grid React Project](./packages/ag-grid-react/README.md) |
18 |
| -[ag-grid-vue: ag-Grid Vue Project](./packages/ag-grid-vue/README.md) |
19 |
| -[ag-grid-aurelia: ag-Grid Aurelia Project](./packages/ag-grid-aurelia/README.md) |
| 17 | +Features |
| 18 | +-------------- |
20 | 19 |
|
21 |
| -For full working examples (including Polymer and Webcomponents) please refer to [www.ag-grid.com](https://www.ag-grid.com) |
| 20 | +Besides the standard set of features you'd expect from any grid: |
22 | 21 |
|
23 |
| -For example projects, please refer to the following repositories: |
| 22 | +* Column Interactions (resize, reorder, and pin columns) |
| 23 | +* Pagination |
| 24 | +* Sorting |
| 25 | +* Row Selection |
24 | 26 |
|
25 |
| -[ag-Grid Angular CLI Example](https://github.com/ag-grid/ag-grid-angular-cli-example/) |
26 |
| -[ag-Grid React Example](https://github.com/ag-grid/ag-grid-react-example/) |
27 |
| -[ag-Grid Vue Example](https://github.com/ag-grid/ag-grid-vue-example/) |
28 |
| -[ag-Grid Aurelia Example](https://github.com/ag-grid/ag-grid-aurelia-example/) |
| 27 | +Here are some of the features that make ag-Grid stand out: |
29 | 28 |
|
30 |
| -Asking Questions |
31 |
| -============== |
| 29 | +* Grouping / Aggregation* |
| 30 | +* Custom Filtering |
| 31 | +* In-place Cell Editing |
| 32 | +* Records Lazy Loading * |
| 33 | +* Server-Side Records Operations * |
| 34 | +* Live Stream Updates |
| 35 | +* Hierarchical Data Support & Tree View * |
| 36 | +* Customizable Appearance |
| 37 | +* Customizable Cell Contents |
| 38 | +* Excel-like Pivoting * |
| 39 | +* State Persistence |
| 40 | +* Keyboard navigation |
| 41 | +* Data Export to CSV |
| 42 | +* Data Export to Excel * |
| 43 | +* Row Reordering |
| 44 | +* Copy / Paste |
| 45 | +* Column Spanning |
| 46 | +* Pinned Rows |
| 47 | +* Full Width Rows |
32 | 48 |
|
33 |
| -+Please do not use GitHub issues to ask questions. Ask questions in the |
34 |
| -+[Stack Overflow ag-grid channel](https://stackoverflow.com/questions/tagged/ag-grid). |
| 49 | +\* The features marked with an asterisk are available in the [enterprise version](https://www.ag-grid.com/license-pricing.php?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) only. |
35 | 50 |
|
36 |
| -Contributing |
37 |
| -============== |
| 51 | +Check out [developers documentation](https://www.ag-grid.com/documentation-main/documentation.php?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) for a complete list of features or visit [our official docs](https://www.ag-grid.com/features-overview?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) for tutorials and feature demos. |
| 52 | + |
| 53 | +Looking for a framework specific solution? |
| 54 | +-------------- |
| 55 | +* [Get Started with AngularJS](https://www.ag-grid.com/best-angularjs-data-grid?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) |
| 56 | +* [Get Started with Angular](https://www.ag-grid.com/angular-getting-started?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) |
| 57 | +* [Get Started with React](https://www.ag-grid.com/react-getting-started?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) |
| 58 | +* [Get Started with Vue](https://www.ag-grid.com/vue-getting-started?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) |
| 59 | +* [Get Started with WebComponents](https://www.ag-grid.com/best-web-component-data-grid?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) |
| 60 | + |
| 61 | +Usage Overview |
| 62 | +-------------- |
| 63 | + |
| 64 | +#### Install dependencies |
| 65 | + |
| 66 | + $ npm i --save ag-grid |
| 67 | + |
| 68 | +### Add a placeholder to HTML |
| 69 | + |
| 70 | + <div id="myGrid" style="height: 150px;width: 600px" class="ag-theme-balham"></div> |
38 | 71 |
|
39 |
| -ag-Grid is not looking for contributors. It is not intended to be developed by an online community. |
40 |
| -However suggestion on change and raising bugs are appreciated. |
41 | 72 |
|
42 |
| -If you are doing a Pull Request: |
43 |
| -- Make your code changes in `src/` files only, don't update dist files |
44 |
| -- Discard all changes to `dist/` |
45 |
| -- Create Pull Request |
| 73 | +#### Import the grid and styles |
46 | 74 |
|
47 |
| -For large changes: |
48 |
| -- Make your doc changes in project [ag-grid-docs](https://github.com/ag-grid/ag-grid-docs), a feature is not complete unless it's documented! |
49 |
| -- Do manual end to end testing off all examples in documentation |
| 75 | + import {Grid} from "ag-grid/main"; |
50 | 76 |
|
51 |
| -PR's on new features **are not** generally accepted. |
| 77 | + import "ag-grid/dist/styles/ag-grid.css"; |
| 78 | + import "ag-grid/dist/styles/ag-theme-balham.css"; |
52 | 79 |
|
53 |
| -PR's on small bug fixes **are** generally accepted. |
| 80 | +### Set configuration |
| 81 | + |
| 82 | + const gridOptions = { |
| 83 | + columnDefs: [ |
| 84 | + {headerName: 'Make', field: 'make'}, |
| 85 | + {headerName: 'Model', field: 'model'}, |
| 86 | + {headerName: 'Price', field: 'price'} |
| 87 | + ], |
| 88 | + rowData: [ |
| 89 | + {make: 'Toyota', model: 'Celica', price: 35000}, |
| 90 | + {make: 'Ford', model: 'Mondeo', price: 32000}, |
| 91 | + {make: 'Porsche', model: 'Boxter', price: 72000} |
| 92 | + ] |
| 93 | + }; |
| 94 | + |
| 95 | +### Initialize the grid |
| 96 | + |
| 97 | + let eGridDiv = document.querySelector('#myGrid'); |
| 98 | + new Grid(eGridDiv, this.gridOptions); |
| 99 | + |
| 100 | +For more information on how to integrate the grid into your project see [TypeScript - Building with Webpack 2](https://www.ag-grid.com/ag-grid-typescript-webpack-2?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github). |
| 101 | + |
| 102 | +Issue Reporting |
| 103 | +---------- |
| 104 | +If you have found a bug, please report them at this repository `issues` section. If you're using Enterprise version please use the private ticketing system to do that. For more information on support check out our [dedicated page](https://www.ag-grid.com/support.php?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github). |
| 105 | + |
| 106 | + |
| 107 | +Asking Questions |
| 108 | +------------- |
| 109 | + |
| 110 | +Look for similar problems on [StackOverflow](https://stackoverflow.com/questions/tagged/ag-grid) using the `ag-grid` tag. If nothing seems related, post a new message there. Do not use GitHub issues to ask questions. |
| 111 | + |
| 112 | +Contributing |
| 113 | +------------ |
| 114 | +ag-Grid is developed by a team of co-located developers in London. If you want to join the team check out our [jobs listing ](https://www.ag-grid.com/ag-grid-jobs-board?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) or send your application to [email protected]. |
54 | 115 |
|
55 |
| -If a PR for a large request is submitted, the typical action is the author will take influence from the |
56 |
| -code to implement the feature, either in ag-grid or [ag-grid-enterprise](https://github.com/ag-grid/ag-grid-enterprise). |
| 116 | +License |
| 117 | +------------------ |
| 118 | +This project is licensed under the MIT license. See the [LICENSE file](./LICENSE.txt) for more info. |
0 commit comments