Skip to content

Commit

Permalink
Merge pull request #1859 from swimlane/chore/deps
Browse files Browse the repository at this point in the history
Chore/deps
  • Loading branch information
Hypercubed authored Apr 9, 2020
2 parents 9b902a4 + 32ef0a4 commit f84f828
Show file tree
Hide file tree
Showing 101 changed files with 634 additions and 473 deletions.
16 changes: 11 additions & 5 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,41 @@
<!-- IF YOU DO NOT FILL THIS OUT, WE WILL CLOSE YOUR ISSUE! -->
<!-- IF YOU DO NOT FILL THIS OUT, WE WILL CLOSE YOUR ISSUE! -->

**I'm submitting a ...** (check one with "x")
**I'm submitting a ...** (check one with "x")

```
[ ] bug report => search github for a similar issue or PR before submitting
[ ] feature request
[ ] support request => Please do not submit support request here, post on Stackoverflow or Gitter
```

**Current behavior**

<!-- Describe how the bug manifests. -->

**Expected behavior**

<!-- Describe what the behavior would be without the bug. -->

**Reproduction of the problem**

<!-- If the current behavior is a bug or you can illustrate your feature request better with an example, please provide the steps to reproduce and if possible a minimal demo of the problem via https://plnkr.co or similar (you can use this template as a starting point: http://plnkr.co/edit/vtAo2zzWFn8kFOGRH88r). -->

**What is the motivation / use case for changing the behavior?**

<!-- Describe the motivation or the concrete use case -->

**Please tell us about your environment:**

<!-- Operating system, IDE, package manager, HTTP server, ... -->

* **Table version:**
- **Table version:**
<!-- Check whether this is still an issue in the most recent table version -->

* **Angular version:**
- **Angular version:**
<!-- Check whether this is still an issue in the most recent Angular version -->

* **Browser:** [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
- **Browser:** [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
<!-- All browsers where this could be reproduced -->

* **Language:** [all | TypeScript X.X | ES6/7 | ES5]
- **Language:** [all | TypeScript X.X | ES6/7 | ES5]
7 changes: 2 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
**What kind of change does this PR introduce?** (check one with "x")

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
Expand All @@ -9,17 +10,13 @@

**What is the current behavior?** (You can also link to an open issue here)



**What is the new behavior?**



**Does this PR introduce a breaking change?** (check one with "x")

- [ ] Yes
- [ ] No

If this PR contains a breaking change, please describe the impact and migration path for existing applications: ...


**Other information**:
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ install:
- npm ci
- npm install codeclimate-test-reporter
- npm run build
- npm run build:lib:prod

script:
- npm run ci
Expand Down
9 changes: 5 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# ngx-datatable

`ngx-datatable` is a Angular component for presenting large and complex data.
It has all the features you would expect from any other table but in a light package
with _no external dependencies_. The table was designed to be extremely flexible and light;
It has all the features you would expect from any other table but in a light package
with _no external dependencies_. The table was designed to be extremely flexible and light;
it doesn't make any assumptions about your data or how you: filter, sort or page it.

It was built for modern browsers using _TypeScript, CSS3 and HTML5_ and Angular `>=4.0.0`.
This is the sister project of the [angular-data-table](https://github.com/swimlane/angular-data-table)
It was built for modern browsers using _TypeScript, CSS3 and HTML5_ and Angular `>=4.0.0`.
This is the sister project of the [angular-data-table](https://github.com/swimlane/angular-data-table)
that is designed for Angular 1.x.

## In The News

### AngularAir Esp 76

{% youtube %}https://www.youtube.com/watch?v=Pj4orsvIp8c{% endyoutube %}

The project was featured on [AngularAir](https://angularair.com/) where [@amcdnl](https://github.com/amcdnl)
Expand Down
58 changes: 29 additions & 29 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# Summary

* [Introduction](README.md)
* [Features](introduction/features.md)
* [Architecture](introduction/architecture.md)
* [Installing](introduction/installing.md)
* [Themeing](introduction/themes.md)
* [Getting Started](introduction/getting-started.md)
* [Change Detection](introduction/cd.md)
* API
* Table
* [Inputs](api/table/inputs.md)
* [Outputs](api/table/outputs.md)
* [Methods](api/table/methods.md)
* [Internals](api/table/internals.md)
* Column
* [Inputs](api/column/inputs.md)
* [Modes](api/column/modes.md)
* [Internals](api/column/internals.md)
* Row Detail
* [Inputs](api/detail/inputs.md)
* [Outputs](api/detail/outputs.md)
* Demos
* [Online](http://swimlane.github.io/ngx-datatable/)
* [Source Code](https://github.com/swimlane/ngx-datatable/tree/master/src/app)
* Contributing
* [Building](contributing/building.md)
* [Guidelines](contributing/guidelines.md)
* [Community](contributing/community.md)
* [Credits](contributing/credits.md)
* [Changelog](changelog.md)
- [Introduction](README.md)
- [Features](introduction/features.md)
- [Architecture](introduction/architecture.md)
- [Installing](introduction/installing.md)
- [Themeing](introduction/themes.md)
- [Getting Started](introduction/getting-started.md)
- [Change Detection](introduction/cd.md)
- API
- Table
- [Inputs](api/table/inputs.md)
- [Outputs](api/table/outputs.md)
- [Methods](api/table/methods.md)
- [Internals](api/table/internals.md)
- Column
- [Inputs](api/column/inputs.md)
- [Modes](api/column/modes.md)
- [Internals](api/column/internals.md)
- Row Detail
- [Inputs](api/detail/inputs.md)
- [Outputs](api/detail/outputs.md)
- Demos
- [Online](http://swimlane.github.io/ngx-datatable/)
- [Source Code](https://github.com/swimlane/ngx-datatable/tree/master/src/app)
- Contributing
- [Building](contributing/building.md)
- [Guidelines](contributing/guidelines.md)
- [Community](contributing/community.md)
- [Credits](contributing/credits.md)
- [Changelog](changelog.md)
24 changes: 23 additions & 1 deletion docs/api/column/inputs.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,92 @@
# Table Column Options

### `name`: `string`

Column label. If none specified, it will use the prop value and decamelize it.

### `prop`: `string`

The property to bind the row values to. If `undefined`, it will camelcase the name value.

### `flexGrow`: `number`
The grow factor relative to other columns. Same as the [flex-grow API](https://www.w3.org/TR/css3-flexbox/).

The grow factor relative to other columns. Same as the [flex-grow API](https://www.w3.org/TR/css3-flexbox/).
It will any available extra width and distribute it proportionally according to all columns' flexGrow values. Default value: `0`

### `minWidth`: `number`

Minimum width of the column in pixels. Default value: `100`

### `maxWidth`: `number`

Maximum width of the column in pixels. Default value: `undefined`

### `width`: `number`

The width of the column by default in pixels. Default value: `150`

### `resizeable`: `boolean`

The column can be resized manually by the user. Default value: `true`

### `comparator`

Custom sort comparator, used to apply custom sorting via client-side.
Function receives five parameters, namely values and rows of items to be sorted as well as direction of the sort ('asc'|'desc'):

```
(valueA, valueB, rowA, rowB, sortDirection) => -1|0|1
```

NOTE: Compare can be a standard JS comparison function (a,b) => -1|0|1 as additional parameters are silently ignored.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) for more info.

### `sortable`: `boolean`

Sorting of the row values by this column. Default value: `true`

### `draggable`: `boolean`

The column can be dragged to re-order. Default value: `true`

### `canAutoResize`: `boolean`

Whether the column can automatically resize to fill extra space. Default value: `true`

### `cellTemplate`: `TemplateRef`

Angular TemplateRef allowing you to author custom body cell templates

### `headerTemplate`: `TemplateRef`

Angular TemplateRef allowing you to author custom header cell templates

### `checkboxable`: `boolean`

Indicates whether the column should show a checkbox component for selection. Only
applicable when the selection mode is `checkbox`.

### `headerCheckboxable`: `boolean`

Indicates whether the column should show a checkbox component in the header cell.
Only applicable when the selection mode is `checkbox`.

### `headerClass`: `string|Function`

Header CSS classes to apply to the header cell

### `cellClass`: `string|Function`

Cell classes to apply to the body cell

### `frozenLeft`: `boolean`

Determines if the column is frozen to the left. Default value: `false`

### `frozenRight`: `boolean`

Determines if the column is frozen to the right. Default value: `false`

### `pipe`: `PipeTransform`

Custom pipe transforms. Default value: `undefined`
1 change: 1 addition & 0 deletions docs/api/column/internals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Column Internals

## Ids

Each row is decorated with a `$$id` attribute. This allows us to track the column
for faster change detection/etc.
4 changes: 4 additions & 0 deletions docs/api/column/modes.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Column Modes

Column modes allow you to have a variety of different ways to apply column width distribution
to the columns. The table comes with 3 modes; `standard`, `flex`, `force`.

## Standard

Columns are distributed given the width's defined in the column options.

## Flex

Flex mode distributes the width's grow factor relative to other columns.
It works the same as the [flex-grow API](http =//www.w3.org/TR/css3-flexbox/) in CSS.
Basically it takes any available extra width and distribute it proportionally
Expand All @@ -14,6 +17,7 @@ according to each column's `flexGrow` value.
Flex is **not** suggested for when using `scrollH`.

## Force

Force mode forces the widths of the columns to distribute equally but overflowing when
the min-width of each column is reached. The rules are:

Expand Down
4 changes: 4 additions & 0 deletions docs/api/detail/inputs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Row Detail Options

### `template`: `TemplateRef`

Template to use in the detail row. Example:

```
Expand All @@ -13,9 +14,11 @@ Template to use in the detail row. Example:
```

### `rowHeight`: `Number|Function`

Height of the detail row.

**Template**

```html
<ngx-datatable-row-detail [rowHeight]="getHeight" #myDetailRow (toggle)="onDetailToggle($event)">
<ng-template let-row="row" ngx-datatable-row-detail-template>
Expand All @@ -26,6 +29,7 @@ Height of the detail row.
```

**Typescript**

```javascript
getHeight(row: any, index: number): number {
return row.someHeight;
Expand Down
5 changes: 4 additions & 1 deletion docs/api/detail/methods.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
## Row Detail Methods

### `collapseAllRows()`

Collapse all row details when using row detail templates.

### `expandAllRows()`

Expand all row details when using row detail templates.

### `toggleExpandRow(row)`
Toggle expand/collapse a row detail when using row detail templates.

Toggle expand/collapse a row detail when using row detail templates.
Loading

0 comments on commit f84f828

Please sign in to comment.