Skip to content

Commit

Permalink
chore: add DataView options descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding committed Dec 29, 2023
1 parent af82208 commit a15405b
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions packages/common/src/core/slickDataview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,19 @@ import {
import type { SlickGrid } from './slickGrid';

export interface DataViewOption {
/** Defaults to false, use with great care as this will break built-in filters */
/**
* Defaults to false, are we using inline filters?
* Note: please use with great care as this will break built-in filters
*/
inlineFilters: boolean;

/** Optionally provide a Group Item Metatadata Provider when using Grouping/DraggableGrouping feature */
/** Optionally provide a GroupItemMetadataProvider in order to use Grouping/DraggableGrouping features */
groupItemMetadataProvider: SlickGroupItemMetadataProvider | null;

/** Defaults to false, should we use CSP Safe filter method? The CSP safe is slighly slower compare to dynamic function default */
/**
* defaults to false, option to use CSP Safe approach,
* Note: it is an opt-in option because it is slightly slower (perf impact) when compared to the non-CSP safe approach.
*/
useCSPSafeFilter: boolean;
}

Expand Down

0 comments on commit a15405b

Please sign in to comment.