Skip to content

Commit 8b33b23

Browse files
author
Konstantin Dinev
committed
chore(*): fixing table with conditions
1 parent e3f7876 commit 8b33b23

File tree

1 file changed

+13
-9
lines changed
  • projects/igniteui-angular/grids/grid

1 file changed

+13
-9
lines changed

projects/igniteui-angular/grids/grid/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -399,23 +399,27 @@ this.grid.filter('Quantity', 10, IgxNumberFilteringOperand.instance().condition(
399399
this.grid.clearFilter('Name');
400400
```
401401

402-
### Available condition names (common examples)
402+
### String types
403403

404-
- String: `contains`, `startsWith`, `endsWith`, `doesNotContain`, `equals`, `doesNotEqual`, `empty`, `notEmpty`
405-
- Number: `equals`, `doesNotEqual`, `greaterThan`, `greaterThanOrEqualTo`, `lessThan`, `lessThanOrEqualTo`, `between`
406-
- Date: `equals`, `doesNotEqual`, `before`, `after`, `today`, `yesterday`, `thisMonth`
407-
- Boolean: `true`, `false`
404+
|Name|Signature|Description|
405+
|--- |--- |--- |
406+
|`contains`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if the `target` contains the `searchVal`.|
407+
|`startsWith`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if the `target` starts with the `searchVal`.|
408+
|`endsWith`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if the `target` ends with the `searchVal`.|
409+
|`doesNotContain`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if `searchVal` is not in `target`.|
410+
|`equals`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if `searchVal` matches `target`.|
411+
|`doesNotEqual`|`(target: string, searchVal: string, ignoreCase?: boolean)`|Returns true if `searchVal` does not match `target`.|
412+
|`null`|`(target: any)`|Returns true if `target` is `null`.|
413+
|`notNull`|`(target: any)`|Returns true if `target` is not `null`.|
414+
|`empty`|`(target: any)`|Returns true if `target` is either `null`, `undefined` or a string of length 0.|
415+
|`notEmpty`|`(target: any)`|Returns true if `target` is not `null`, `undefined` or a string of length 0.|
408416

409417
Use them via the corresponding operand, for example:
410418

411419
```typescript
412420
const contains = IgxStringFilteringOperand.instance().condition('contains');
413421
this.grid.filter('Name', 'Ann', contains);
414422
```
415-
|`null`|`(target: any)`|Returns true if `target` is `null`.|
416-
|`notNull`|`(target: any)`|Returns true if `target` is not `null`.|
417-
|`empty`|`(target: any)`|Returns true if `target` is either `null`, `undefined` or a string of length 0.|
418-
|`notEmpty`|`(target: any)`|Returns true if `target` is not `null`, `undefined` or a string of length 0.|
419423

420424

421425
### Number types

0 commit comments

Comments
 (0)