@tipolox/litgrid-core 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export { createGridEngine } from './core/createGridEngine.js';
2
2
  export type { GridEngine } from './core/GridEngine.js';
3
3
  export type { GridQuery, GridQueryFilter, GridQueryReason, GridQueryChangeDetail, GridQuerySnapshot, GridExternalTotal, GridExternalState } from './model/GridQuery.js';
4
- export type { GridConfig, GridPaginationConfig, ResolvedGridConfig, SelectionMode } from './model/GridConfig.js';
4
+ export type { GridConfig, GridQuickSearchConfig, GridPaginationConfig, ResolvedGridConfig, SelectionMode } from './model/GridConfig.js';
5
5
  export type { FilterOperator, GridFilter, GridPaginationState, GridSelection, GridRowKey, SelectedRowSnapshot, SelectionChangeDetail, SelectionIntent, SortDirection } from './model/GridState.js';
6
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACvK,YAAY,EAAE,UAAU,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAChH,YAAY,EACV,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,aAAa,EACd,MAAM,sBAAsB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACvK,YAAY,EAAE,UAAU,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACvI,YAAY,EACV,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,aAAa,EACd,MAAM,sBAAsB,CAAA"}
@@ -4,9 +4,22 @@ export type GridPaginationConfig = {
4
4
  pageSize?: number;
5
5
  pageIndex?: number;
6
6
  };
7
+ /** Presentation-only quick-search options; server search scope remains consumer-owned. */
8
+ export type GridQuickSearchConfig = {
9
+ /** External mode only: false hides the built-in search field and toolbar. */
10
+ visible?: boolean;
11
+ /** Input accessible name. Defaults to 'Quick search'. */
12
+ label?: string;
13
+ /** Input placeholder. Defaults to 'Search all columns'. */
14
+ placeholder?: string;
15
+ /** Optional visible help, connected by aria-describedby. */
16
+ description?: string;
17
+ };
7
18
  export type GridConfig = {
8
19
  /** Opt in to atomic server page results and query intents. Defaults to local. */
9
20
  queryMode?: 'local' | 'external';
21
+ /** External visibility and shared quick-search wording; local Show/Hide remains unchanged. */
22
+ quickSearch?: GridQuickSearchConfig;
10
23
  selection?: {
11
24
  mode?: SelectionMode;
12
25
  checkboxes?: boolean;
@@ -23,6 +36,12 @@ export type GridConfig = {
23
36
  };
24
37
  export type ResolvedGridConfig = {
25
38
  queryMode: 'local' | 'external';
39
+ quickSearch: {
40
+ visible: boolean;
41
+ label: string;
42
+ placeholder: string;
43
+ description: string;
44
+ };
26
45
  selection: {
27
46
  mode: SelectionMode;
28
47
  checkboxes: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"GridConfig.d.ts","sourceRoot":"","sources":["../../src/model/GridConfig.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,MAAM,GAAG,YAAY,CAAA;AAEhF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,iFAAiF;IACjF,SAAS,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;IAChC,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,aAAa,CAAA;QACpB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,qEAAqE;QACrE,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,iFAAiF;QACjF,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;IACD,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IACD,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,OAAO,GAAG,UAAU,CAAA;IAC/B,SAAS,EAAE;QACT,IAAI,EAAE,aAAa,CAAA;QACnB,UAAU,EAAE,OAAO,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;IACD,SAAS,EAAE;QACT,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAUD,wBAAgB,eAAe,CAAC,MAAM,GAAE,UAAe,GAAG,kBAAkB,CAmB3E"}
1
+ {"version":3,"file":"GridConfig.d.ts","sourceRoot":"","sources":["../../src/model/GridConfig.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,WAAW,GAAG,MAAM,GAAG,YAAY,CAAA;AAEhF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,0FAA0F;AAC1F,MAAM,MAAM,qBAAqB,GAAG;IAClC,6EAA6E;IAC7E,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,iFAAiF;IACjF,SAAS,CAAC,EAAE,OAAO,GAAG,UAAU,CAAA;IAChC,8FAA8F;IAC9F,WAAW,CAAC,EAAE,qBAAqB,CAAA;IACnC,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,aAAa,CAAA;QACpB,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,qEAAqE;QACrE,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,iFAAiF;QACjF,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;IACD,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IACD,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,OAAO,GAAG,UAAU,CAAA;IAC/B,WAAW,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1F,SAAS,EAAE;QACT,IAAI,EAAE,aAAa,CAAA;QACnB,UAAU,EAAE,OAAO,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;IACD,SAAS,EAAE;QACT,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAUD,wBAAgB,eAAe,CAAC,MAAM,GAAE,UAAe,GAAG,kBAAkB,CAyB3E"}
@@ -7,6 +7,12 @@ function normalizePageIndex(value) {
7
7
  export function normalizeConfig(config = {}) {
8
8
  return {
9
9
  queryMode: config.queryMode === 'external' ? 'external' : 'local',
10
+ quickSearch: {
11
+ visible: config.quickSearch?.visible !== false,
12
+ label: typeof config.quickSearch?.label === 'string' && config.quickSearch.label.trim() ? config.quickSearch.label : 'Quick search',
13
+ placeholder: typeof config.quickSearch?.placeholder === 'string' ? config.quickSearch.placeholder : 'Search all columns',
14
+ description: typeof config.quickSearch?.description === 'string' ? config.quickSearch.description.trim() : ''
15
+ },
10
16
  selection: {
11
17
  mode: config.selection?.mode ?? 'none',
12
18
  checkboxes: config.selection?.checkboxes ?? false,
@@ -1 +1 @@
1
- {"version":3,"file":"GridConfig.js","sourceRoot":"","sources":["../../src/model/GridConfig.ts"],"names":[],"mappings":"AA6CA,SAAS,iBAAiB,CAAC,KAAyB;IAClD,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AACpF,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAyB;IACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,SAAqB,EAAE;IACrD,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;QACjE,SAAS,EAAE;YACT,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,MAAM;YACtC,UAAU,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,IAAI,KAAK;YACjD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM;YAChC,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ;SACrC;QACD,SAAS,EAAE;YACT,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,IAAI,KAAK;YAC3C,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;SACrC;QACD,UAAU,EAAE;YACV,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,OAAO,IAAI,KAAK;YAC5C,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC;YACxD,SAAS,EAAE,kBAAkB,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC;SAC5D;KACF,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"GridConfig.js","sourceRoot":"","sources":["../../src/model/GridConfig.ts"],"names":[],"mappings":"AA4DA,SAAS,iBAAiB,CAAC,KAAyB;IAClD,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AACpF,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAyB;IACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,SAAqB,EAAE;IACrD,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;QACjE,WAAW,EAAE;YACX,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,KAAK,KAAK;YAC9C,KAAK,EAAE,OAAO,MAAM,CAAC,WAAW,EAAE,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc;YACnI,WAAW,EAAE,OAAO,MAAM,CAAC,WAAW,EAAE,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,oBAAoB;YACxH,WAAW,EAAE,OAAO,MAAM,CAAC,WAAW,EAAE,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;SAC9G;QACD,SAAS,EAAE;YACT,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,IAAI,IAAI,MAAM;YACtC,UAAU,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,IAAI,KAAK;YACjD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM;YAChC,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,QAAQ;SACrC;QACD,SAAS,EAAE;YACT,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,IAAI,KAAK;YAC3C,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;SACrC;QACD,UAAU,EAAE;YACV,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,OAAO,IAAI,KAAK;YAC5C,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC;YACxD,SAAS,EAAE,kBAAkB,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC;SAC5D;KACF,CAAA;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tipolox/litgrid-core",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "description": "Framework-agnostic data engine for LitGrid.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
package/src/index.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  export { createGridEngine } from './core/createGridEngine.js'
2
2
  export type { GridEngine } from './core/GridEngine.js'
3
3
  export type { GridQuery, GridQueryFilter, GridQueryReason, GridQueryChangeDetail, GridQuerySnapshot, GridExternalTotal, GridExternalState } from './model/GridQuery.js'
4
- export type { GridConfig, GridPaginationConfig, ResolvedGridConfig, SelectionMode } from './model/GridConfig.js'
4
+ export type { GridConfig, GridQuickSearchConfig, GridPaginationConfig, ResolvedGridConfig, SelectionMode } from './model/GridConfig.js'
5
5
  export type {
6
6
  FilterOperator,
7
7
  GridFilter,
@@ -6,9 +6,23 @@ export type GridPaginationConfig = {
6
6
  pageIndex?: number
7
7
  }
8
8
 
9
+ /** Presentation-only quick-search options; server search scope remains consumer-owned. */
10
+ export type GridQuickSearchConfig = {
11
+ /** External mode only: false hides the built-in search field and toolbar. */
12
+ visible?: boolean
13
+ /** Input accessible name. Defaults to 'Quick search'. */
14
+ label?: string
15
+ /** Input placeholder. Defaults to 'Search all columns'. */
16
+ placeholder?: string
17
+ /** Optional visible help, connected by aria-describedby. */
18
+ description?: string
19
+ }
20
+
9
21
  export type GridConfig = {
10
22
  /** Opt in to atomic server page results and query intents. Defaults to local. */
11
23
  queryMode?: 'local' | 'external'
24
+ /** External visibility and shared quick-search wording; local Show/Hide remains unchanged. */
25
+ quickSearch?: GridQuickSearchConfig
12
26
  selection?: {
13
27
  mode?: SelectionMode
14
28
  checkboxes?: boolean
@@ -26,6 +40,7 @@ export type GridConfig = {
26
40
 
27
41
  export type ResolvedGridConfig = {
28
42
  queryMode: 'local' | 'external'
43
+ quickSearch: { visible: boolean; label: string; placeholder: string; description: string }
29
44
  selection: {
30
45
  mode: SelectionMode
31
46
  checkboxes: boolean
@@ -54,6 +69,12 @@ function normalizePageIndex(value: number | undefined) {
54
69
  export function normalizeConfig(config: GridConfig = {}): ResolvedGridConfig {
55
70
  return {
56
71
  queryMode: config.queryMode === 'external' ? 'external' : 'local',
72
+ quickSearch: {
73
+ visible: config.quickSearch?.visible !== false,
74
+ label: typeof config.quickSearch?.label === 'string' && config.quickSearch.label.trim() ? config.quickSearch.label : 'Quick search',
75
+ placeholder: typeof config.quickSearch?.placeholder === 'string' ? config.quickSearch.placeholder : 'Search all columns',
76
+ description: typeof config.quickSearch?.description === 'string' ? config.quickSearch.description.trim() : ''
77
+ },
57
78
  selection: {
58
79
  mode: config.selection?.mode ?? 'none',
59
80
  checkboxes: config.selection?.checkboxes ?? false,