@genesislcap/grid-pro 15.49.0 → 15.50.0

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.
Files changed (2) hide show
  1. package/dist/custom-elements.json +970 -970
  2. package/package.json +12 -12
@@ -22774,7 +22774,7 @@
22774
22774
  },
22775
22775
  {
22776
22776
  "kind": "javascript-module",
22777
- "path": "src/row-alert/index.ts",
22777
+ "path": "src/multicolumn-dropdown/index.ts",
22778
22778
  "declarations": [],
22779
22779
  "exports": [
22780
22780
  {
@@ -22782,7 +22782,7 @@
22782
22782
  "name": "*",
22783
22783
  "declaration": {
22784
22784
  "name": "*",
22785
- "package": "./row-alert"
22785
+ "package": "./multicolumn-dropdown"
22786
22786
  }
22787
22787
  },
22788
22788
  {
@@ -22790,532 +22790,810 @@
22790
22790
  "name": "*",
22791
22791
  "declaration": {
22792
22792
  "name": "*",
22793
- "package": "./row-alert.types"
22793
+ "package": "./multicolumn-dropdown.styles"
22794
22794
  }
22795
- }
22796
- ]
22797
- },
22798
- {
22799
- "kind": "javascript-module",
22800
- "path": "src/row-alert/row-alert.ts",
22801
- "declarations": [
22802
- {
22803
- "kind": "function",
22804
- "name": "createRowAlert",
22805
- "return": {
22806
- "type": {
22807
- "text": "RowAlert"
22808
- }
22809
- },
22810
- "parameters": [
22811
- {
22812
- "name": "criteria",
22813
- "type": {
22814
- "text": "RowMatchCriteria"
22815
- }
22816
- },
22817
- {
22818
- "name": "options",
22819
- "default": "{}",
22820
- "type": {
22821
- "text": "RowAlertOptions"
22822
- }
22823
- }
22824
- ],
22825
- "description": "Builds the class rules that flash rows matching `criteria`, together with the context menu\nthat lets a user recolor, retime, or narrow that flash to a single cell.\n\nThe rules are created once and never replaced, because a grid backed by a Genesis datasource\nkeeps the options it was created with — handing it new rules later would change nothing. Each\nrule instead asks, as it runs, whether its scope is the one currently selected, so switching\ntarget only needs the rows redrawn.\n\n```ts\nconst alert = createRowAlert(criteria, { persistPreferencesKey: 'orders.row-alert' });\ngridOptions = {\n rowClassRules: alert.rowClassRules,\n defaultColDef: alert.defaultColDef,\n getContextMenuItems: alert.getContextMenuItems,\n};\n```\n\nAlerts sharing a `persistPreferencesKey` share their preferences, so a page of grids that each\nwatch for something different still answers to one setting.\n\nPairs with DatasourceRowMatchTracker: give both the same criteria and a tab can say\nthere is work to do while the grid shows which rows it meant.",
22826
- "privacy": "public"
22827
- }
22828
- ],
22829
- "exports": [
22795
+ },
22830
22796
  {
22831
22797
  "kind": "js",
22832
- "name": "createRowAlert",
22798
+ "name": "*",
22833
22799
  "declaration": {
22834
- "name": "createRowAlert",
22835
- "module": "src/row-alert/row-alert.ts"
22800
+ "name": "*",
22801
+ "package": "./multicolumn-dropdown.template"
22836
22802
  }
22837
22803
  }
22838
22804
  ]
22839
22805
  },
22840
22806
  {
22841
22807
  "kind": "javascript-module",
22842
- "path": "src/row-alert/row-alert.types.ts",
22808
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
22843
22809
  "declarations": [
22844
22810
  {
22845
22811
  "kind": "variable",
22846
- "name": "defaultRowAlertColorPresets",
22812
+ "name": "dropdownWidthVar",
22847
22813
  "type": {
22848
- "text": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]"
22814
+ "text": "string"
22849
22815
  },
22850
- "default": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]",
22851
- "description": "Colors offered by default. Each resolves a design token so the menu follows the host\napplication's theme, falling back to a fixed color for design systems that lack the token.",
22852
- "privacy": "public"
22816
+ "default": "'--dropdown-width'",
22817
+ "description": "The CSS variable to use for specifying the dropdown's width"
22853
22818
  },
22854
22819
  {
22855
22820
  "kind": "variable",
22856
- "name": "defaultRowAlertRatePresets",
22821
+ "name": "optionsClass",
22857
22822
  "type": {
22858
- "text": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]"
22823
+ "text": "string"
22859
22824
  },
22860
- "default": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]",
22861
- "description": "Flash rates offered by default.",
22862
- "privacy": "public"
22825
+ "default": "'options'",
22826
+ "description": "The CSS class to use for the options element's class in the dropdown"
22863
22827
  },
22864
22828
  {
22865
22829
  "kind": "variable",
22866
- "name": "defaultRowAlertScopePresets",
22830
+ "name": "DISPLAY_NONE_CLASS",
22867
22831
  "type": {
22868
- "text": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]"
22832
+ "text": "string"
22869
22833
  },
22870
- "default": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]",
22871
- "description": "Flash targets offered by default. Cell scope only has an effect when the criteria name a\n`flashField`.",
22872
- "privacy": "public"
22834
+ "default": "'dnone'",
22835
+ "description": "Class name used to hide elements with display:none"
22873
22836
  },
22874
22837
  {
22875
22838
  "kind": "variable",
22876
- "name": "defaultRowAlertPreferences",
22877
- "type": {
22878
- "text": "RowAlertPreferences"
22879
- },
22880
- "default": "{\n color: defaultRowAlertColorPresets[0].value,\n durationMs: defaultRowAlertRatePresets[1].value,\n scope: 'row',\n}",
22881
- "description": "Where preferences start before a user changes anything.",
22839
+ "name": "multicolumnDropdownStyles",
22840
+ "default": "css`\n label {\n color: var(--neutral-foreground-hint, rgb(135 155 166));\n font-style: normal;\n margin: calc(var(--design-unit) * 2px) 0;\n display: block;\n cursor: pointer;\n font-size: var(--type-ramp-base-font-size);\n line-height: var(--type-ramp-base-line-height);\n }\n\n .${DISPLAY_NONE_CLASS} {\n display: none !important;\n }\n\n .root {\n position: relative;\n width: inherit;\n min-width: 250px;\n ${dropdownWidthVar}: 350px;\n }\n\n .control {\n cursor: pointer;\n position: relative;\n display: flex;\n align-items: center;\n width: 100%;\n border-radius: calc(var(--control-corner-radius) * 1px);\n }\n\n #display-field {\n width: 100%;\n cursor: pointer;\n color: inherit;\n min-height: 40px;\n padding-left: calc(var(--design-unit) * 2.25px);\n padding-right: 52px;\n border-width: 0;\n background: var(--neutral-fill-input-rest);\n border-radius: calc(var(--control-corner-radius) * 1px);\n text-overflow: ellipsis;\n font-size: var(--type-ramp-base-font-size);\n font-family: var(--body-font);\n }\n\n #display-field[disabled] {\n cursor: not-allowed;\n opacity: var(--disabled-opacity);\n }\n\n #display-field:focus {\n outline: 1px solid var(--accent-fill-rest);\n background: var(--neutral-fill-input-rest);\n border-style: none;\n box-shadow: none;\n }\n\n #display-field:hover:not(:focus):not([disabled]) {\n outline: 1px solid var(--neutral-stroke-hover, rgb(231 232 232));\n }\n\n button {\n pointer-events: none;\n }\n\n #arrow-icon {\n display: inline-block;\n width: 16px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 26px);\n padding: 0;\n cursor: pointer;\n transform: rotate(0deg);\n transition: transform 0.2s linear 0s;\n }\n\n #arrow-icon.flipped {\n transform: rotate(180deg);\n }\n\n .cross-icon {\n display: inline-block;\n width: 12px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 46px);\n padding: 0;\n cursor: pointer;\n visibility: hidden;\n }\n\n .cross-icon:hover {\n color: var(--error-color);\n }\n\n .disabled-icon {\n pointer-events: none;\n opacity: var(--disabled-opacity);\n }\n\n .${optionsClass} {\n min-width: 100%;\n width: var(${dropdownWidthVar});\n display: flex;\n flex-direction: column;\n position: absolute;\n height: max-content;\n overflow-y: hidden;\n margin: 5px 0;\n background: var(--neutral-fill-input-rest);\n visibility: hidden;\n z-index: 999;\n }\n\n .dropdown-above {\n bottom: 100%;\n }\n\n .dropdown-left {\n right: 0;\n }\n\n .grid-container {\n height: 300px;\n width: 100%;\n }\n\n #filter-search {\n padding: 5px;\n }\n\n .visible {\n visibility: visible;\n }\n`",
22841
+ "description": "Multicolumn Dropdown styles.",
22882
22842
  "privacy": "public"
22883
22843
  }
22884
22844
  ],
22885
22845
  "exports": [
22886
22846
  {
22887
22847
  "kind": "js",
22888
- "name": "defaultRowAlertColorPresets",
22848
+ "name": "dropdownWidthVar",
22889
22849
  "declaration": {
22890
- "name": "defaultRowAlertColorPresets",
22891
- "module": "src/row-alert/row-alert.types.ts"
22850
+ "name": "dropdownWidthVar",
22851
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22892
22852
  }
22893
22853
  },
22894
22854
  {
22895
22855
  "kind": "js",
22896
- "name": "defaultRowAlertRatePresets",
22856
+ "name": "optionsClass",
22897
22857
  "declaration": {
22898
- "name": "defaultRowAlertRatePresets",
22899
- "module": "src/row-alert/row-alert.types.ts"
22858
+ "name": "optionsClass",
22859
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22900
22860
  }
22901
22861
  },
22902
22862
  {
22903
22863
  "kind": "js",
22904
- "name": "defaultRowAlertScopePresets",
22864
+ "name": "DISPLAY_NONE_CLASS",
22905
22865
  "declaration": {
22906
- "name": "defaultRowAlertScopePresets",
22907
- "module": "src/row-alert/row-alert.types.ts"
22866
+ "name": "DISPLAY_NONE_CLASS",
22867
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22908
22868
  }
22909
22869
  },
22910
22870
  {
22911
22871
  "kind": "js",
22912
- "name": "defaultRowAlertPreferences",
22872
+ "name": "multicolumnDropdownStyles",
22913
22873
  "declaration": {
22914
- "name": "defaultRowAlertPreferences",
22915
- "module": "src/row-alert/row-alert.types.ts"
22874
+ "name": "multicolumnDropdownStyles",
22875
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
22916
22876
  }
22917
22877
  }
22918
22878
  ]
22919
22879
  },
22920
22880
  {
22921
22881
  "kind": "javascript-module",
22922
- "path": "src/state-persistence/index.ts",
22923
- "declarations": [],
22924
- "exports": [
22882
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
22883
+ "declarations": [
22925
22884
  {
22926
- "kind": "js",
22927
- "name": "*",
22928
- "declaration": {
22929
- "name": "*",
22930
- "package": "./kv-state"
22931
- }
22885
+ "kind": "function",
22886
+ "name": "getMulticolumnDropdownTemplate",
22887
+ "parameters": [
22888
+ {
22889
+ "name": "designSystem",
22890
+ "default": "'foundation'",
22891
+ "description": "The design system prefix to use. Defaults to 'foundation'."
22892
+ }
22893
+ ],
22894
+ "description": "Get a Design System prefixed Multicolumn Dropdown template.",
22895
+ "return": {
22896
+ "type": {
22897
+ "text": ""
22898
+ }
22899
+ },
22900
+ "privacy": "public"
22932
22901
  },
22902
+ {
22903
+ "kind": "variable",
22904
+ "name": "multicolumnDropdownTemplate",
22905
+ "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
22906
+ "privacy": "public"
22907
+ }
22908
+ ],
22909
+ "exports": [
22933
22910
  {
22934
22911
  "kind": "js",
22935
- "name": "*",
22912
+ "name": "getMulticolumnDropdownTemplate",
22936
22913
  "declaration": {
22937
- "name": "*",
22938
- "package": "./local-state"
22914
+ "name": "getMulticolumnDropdownTemplate",
22915
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
22939
22916
  }
22940
22917
  },
22941
22918
  {
22942
22919
  "kind": "js",
22943
- "name": "*",
22920
+ "name": "multicolumnDropdownTemplate",
22944
22921
  "declaration": {
22945
- "name": "*",
22946
- "package": "./state-persistence"
22922
+ "name": "multicolumnDropdownTemplate",
22923
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
22947
22924
  }
22948
22925
  }
22949
22926
  ]
22950
22927
  },
22951
22928
  {
22952
22929
  "kind": "javascript-module",
22953
- "path": "src/state-persistence/kv-state.ts",
22930
+ "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
22954
22931
  "declarations": [
22955
22932
  {
22956
- "kind": "class",
22957
- "description": "Implementation for the KV Storage State Persistence interface.",
22958
- "name": "KVStorageStatePersistence",
22959
- "members": [
22933
+ "kind": "function",
22934
+ "name": "wasClickOutsideElement",
22935
+ "parameters": [
22960
22936
  {
22961
- "kind": "field",
22962
- "name": "kvStorage",
22937
+ "name": "event",
22963
22938
  "type": {
22964
- "text": "KVStorage"
22939
+ "text": "MouseEvent"
22965
22940
  }
22966
22941
  },
22942
+ {
22943
+ "name": "target",
22944
+ "type": {
22945
+ "text": "EventTarget"
22946
+ }
22947
+ }
22948
+ ],
22949
+ "description": "Checks if the given mouse event occurred outside the target element.",
22950
+ "privacy": "public"
22951
+ },
22952
+ {
22953
+ "kind": "class",
22954
+ "description": "",
22955
+ "name": "MulticolumnDropdown",
22956
+ "members": [
22967
22957
  {
22968
22958
  "kind": "field",
22969
- "name": "session",
22959
+ "name": "optionsElement",
22970
22960
  "type": {
22971
- "text": "Session"
22961
+ "text": "HTMLElement"
22972
22962
  }
22973
22963
  },
22974
22964
  {
22975
- "kind": "method",
22976
- "name": "getColumnState",
22977
- "return": {
22978
- "type": {
22979
- "text": "Promise<ColumnState[]>"
22980
- }
22965
+ "kind": "field",
22966
+ "name": "lastRequest",
22967
+ "type": {
22968
+ "text": "object"
22981
22969
  },
22982
- "parameters": [
22983
- {
22984
- "name": "persistColumnStateKey",
22985
- "type": {
22986
- "text": "string"
22987
- }
22988
- }
22989
- ]
22970
+ "privacy": "private"
22990
22971
  },
22991
22972
  {
22992
- "kind": "method",
22993
- "name": "saveColumnState",
22994
- "return": {
22995
- "type": {
22996
- "text": "Promise<void>"
22997
- }
22973
+ "kind": "field",
22974
+ "name": "connectOverride",
22975
+ "type": {
22976
+ "text": "Connect"
22998
22977
  },
22999
- "parameters": [
23000
- {
23001
- "name": "persistColumnStateKey",
23002
- "type": {
23003
- "text": "string"
23004
- }
23005
- },
23006
- {
23007
- "name": "columnState",
23008
- "type": {
23009
- "text": "ColumnState[]"
23010
- }
23011
- }
23012
- ]
22978
+ "privacy": "private"
23013
22979
  },
23014
22980
  {
23015
- "kind": "method",
23016
- "name": "deleteColumnState",
23017
- "return": {
23018
- "type": {
23019
- "text": "Promise<void>"
23020
- }
22981
+ "kind": "field",
22982
+ "name": "_connectDI",
22983
+ "type": {
22984
+ "text": "Connect"
23021
22985
  },
23022
- "parameters": [
23023
- {
23024
- "name": "persistColumnStateKey",
23025
- "type": {
23026
- "text": "string"
23027
- }
23028
- }
23029
- ]
22986
+ "privacy": "private"
23030
22987
  },
23031
22988
  {
23032
- "kind": "method",
23033
- "name": "migrateLocalStorageToKVStorage",
23034
- "privacy": "private",
23035
- "return": {
23036
- "type": {
23037
- "text": "Promise<void>"
23038
- }
22989
+ "kind": "field",
22990
+ "name": "connect",
22991
+ "type": {
22992
+ "text": "Connect"
23039
22993
  },
23040
- "parameters": [
23041
- {
23042
- "name": "persistColumnStateKey",
23043
- "type": {
23044
- "text": "string"
23045
- }
23046
- }
23047
- ]
22994
+ "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
23048
22995
  },
23049
22996
  {
23050
- "kind": "method",
23051
- "name": "getFilterModel",
23052
- "return": {
23053
- "type": {
23054
- "text": "Promise<{ [key: string]: any }>"
23055
- }
22997
+ "kind": "field",
22998
+ "name": "disabled",
22999
+ "type": {
23000
+ "text": "boolean"
23056
23001
  },
23057
- "parameters": [
23058
- {
23059
- "name": "persistFilterModelKey",
23060
- "type": {
23061
- "text": "string"
23062
- }
23063
- }
23064
- ]
23002
+ "privacy": "public",
23003
+ "description": "Whether to disable control of the component"
23065
23004
  },
23066
23005
  {
23067
- "kind": "method",
23068
- "name": "saveFilterModel",
23069
- "return": {
23070
- "type": {
23071
- "text": "Promise<void>"
23072
- }
23006
+ "kind": "field",
23007
+ "name": "resourceName",
23008
+ "type": {
23009
+ "text": "string"
23073
23010
  },
23074
- "parameters": [
23075
- {
23076
- "name": "persistFilterModelKey",
23077
- "type": {
23078
- "text": "string"
23079
- }
23080
- },
23081
- {
23082
- "name": "filterModel",
23083
- "type": {
23084
- "text": "{ [key: string]: any }"
23085
- }
23086
- }
23087
- ]
23011
+ "privacy": "public",
23012
+ "description": "The name of the reqrep to get the options from"
23088
23013
  },
23089
23014
  {
23090
- "kind": "method",
23091
- "name": "getRowAlertPreferences",
23092
- "return": {
23093
- "type": {
23094
- "text": "Promise<Partial<RowAlertPreferences>>"
23095
- }
23015
+ "kind": "field",
23016
+ "name": "searchKey",
23017
+ "type": {
23018
+ "text": "string | string[] | undefined"
23096
23019
  },
23097
- "parameters": [
23098
- {
23099
- "name": "persistRowAlertKey",
23100
- "type": {
23101
- "text": "string"
23102
- }
23103
- }
23104
- ]
23020
+ "privacy": "public",
23021
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
23105
23022
  },
23106
23023
  {
23107
- "kind": "method",
23108
- "name": "saveRowAlertPreferences",
23109
- "return": {
23110
- "type": {
23111
- "text": "Promise<void>"
23112
- }
23024
+ "kind": "field",
23025
+ "name": "requestSupportsAdvancedSearch",
23026
+ "type": {
23027
+ "text": "boolean"
23113
23028
  },
23114
- "parameters": [
23115
- {
23116
- "name": "persistRowAlertKey",
23117
- "type": {
23118
- "text": "string"
23119
- }
23120
- },
23121
- {
23122
- "name": "preferences",
23123
- "type": {
23124
- "text": "RowAlertPreferences"
23125
- }
23126
- }
23127
- ]
23128
- }
23129
- ]
23130
- }
23131
- ],
23132
- "exports": [
23133
- {
23134
- "kind": "js",
23135
- "name": "KVStorageStatePersistence",
23136
- "declaration": {
23137
- "name": "KVStorageStatePersistence",
23138
- "module": "src/state-persistence/kv-state.ts"
23139
- }
23140
- }
23141
- ]
23142
- },
23143
- {
23144
- "kind": "javascript-module",
23145
- "path": "src/state-persistence/local-state.ts",
23146
- "declarations": [
23147
- {
23148
- "kind": "class",
23149
- "description": "Implementation for the Local Storage State Persistence interface.",
23150
- "name": "LocalStorageStatePersistence",
23151
- "members": [
23029
+ "privacy": "public",
23030
+ "default": "false",
23031
+ "description": "Tells whether a given request supports lookup by Groovy Expressions."
23032
+ },
23152
23033
  {
23153
23034
  "kind": "field",
23154
- "name": "session",
23035
+ "name": "valueKey",
23155
23036
  "type": {
23156
- "text": "Session"
23157
- }
23037
+ "text": "string"
23038
+ },
23039
+ "privacy": "public",
23040
+ "description": "The key used as the value sent to the server"
23158
23041
  },
23159
23042
  {
23160
- "kind": "method",
23161
- "name": "getColumnState",
23162
- "return": {
23163
- "type": {
23164
- "text": "Promise<ColumnState[]>"
23165
- }
23043
+ "kind": "field",
23044
+ "name": "labelKey",
23045
+ "type": {
23046
+ "text": "string"
23166
23047
  },
23167
- "parameters": [
23168
- {
23169
- "name": "persistColumnStateKey",
23170
- "type": {
23171
- "text": "string"
23172
- }
23173
- }
23174
- ]
23048
+ "privacy": "public",
23049
+ "description": "The key used as the label displayed in the UI"
23175
23050
  },
23176
23051
  {
23177
- "kind": "method",
23178
- "name": "saveColumnState",
23179
- "return": {
23180
- "type": {
23181
- "text": "Promise<void>"
23182
- }
23052
+ "kind": "field",
23053
+ "name": "dropdownPlacement",
23054
+ "type": {
23055
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
23183
23056
  },
23184
- "parameters": [
23185
- {
23186
- "name": "persistColumnStateKey",
23187
- "type": {
23188
- "text": "string"
23189
- }
23190
- },
23191
- {
23192
- "name": "columnState",
23193
- "type": {
23194
- "text": "ColumnState[]"
23195
- }
23196
- }
23197
- ]
23057
+ "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left"
23198
23058
  },
23199
23059
  {
23200
- "kind": "method",
23201
- "name": "deleteColumnState",
23202
- "return": {
23203
- "type": {
23204
- "text": "Promise<void>"
23205
- }
23060
+ "kind": "field",
23061
+ "name": "dropdownWidth",
23062
+ "type": {
23063
+ "text": "number"
23206
23064
  },
23207
- "parameters": [
23208
- {
23209
- "name": "persistColumnStateKey",
23210
- "type": {
23211
- "text": "string"
23212
- }
23213
- }
23214
- ]
23065
+ "privacy": "public",
23066
+ "description": "Optionally specifies the width of the dropdown"
23215
23067
  },
23216
23068
  {
23217
- "kind": "method",
23218
- "name": "getFilterModel",
23219
- "return": {
23220
- "type": {
23221
- "text": "Promise<{ [key: string]: any }>"
23222
- }
23069
+ "kind": "field",
23070
+ "name": "request",
23071
+ "type": {
23072
+ "text": "object"
23223
23073
  },
23224
- "parameters": [
23225
- {
23226
- "name": "persistFilterModelKey",
23227
- "type": {
23228
- "text": "string"
23229
- }
23230
- }
23231
- ]
23074
+ "privacy": "public",
23075
+ "description": "A request object to pass in the reqrep"
23232
23076
  },
23233
23077
  {
23234
- "kind": "method",
23235
- "name": "saveFilterModel",
23236
- "return": {
23237
- "type": {
23238
- "text": "Promise<void>"
23239
- }
23078
+ "kind": "field",
23079
+ "name": "columnDefinitions",
23080
+ "type": {
23081
+ "text": "ColDef[]"
23240
23082
  },
23241
- "parameters": [
23242
- {
23243
- "name": "persistFilterModelKey",
23244
- "type": {
23245
- "text": "string"
23246
- }
23247
- },
23248
- {
23249
- "name": "filterModel",
23250
- "type": {
23251
- "text": "{ [key: string]: any }"
23252
- }
23253
- }
23254
- ]
23083
+ "privacy": "public",
23084
+ "description": "An array of AG Grid column definitions to use in the grid to display the data"
23255
23085
  },
23256
23086
  {
23257
- "kind": "method",
23258
- "name": "getRowAlertPreferences",
23259
- "return": {
23260
- "type": {
23261
- "text": "Promise<Partial<RowAlertPreferences>>"
23262
- }
23087
+ "kind": "field",
23088
+ "name": "baseCriteria",
23089
+ "type": {
23090
+ "text": "string | undefined"
23091
+ },
23092
+ "privacy": "public",
23093
+ "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
23094
+ },
23095
+ {
23096
+ "kind": "field",
23097
+ "name": "defaultSlottedNodes",
23098
+ "type": {
23099
+ "text": "Node[]"
23100
+ },
23101
+ "privacy": "public",
23102
+ "default": "[]"
23103
+ },
23104
+ {
23105
+ "kind": "field",
23106
+ "name": "grid",
23107
+ "type": {
23108
+ "text": "GridPro | GridProLegacy"
23109
+ },
23110
+ "privacy": "public"
23111
+ },
23112
+ {
23113
+ "kind": "field",
23114
+ "name": "_value",
23115
+ "type": {
23116
+ "text": "string"
23117
+ },
23118
+ "privacy": "private"
23119
+ },
23120
+ {
23121
+ "kind": "field",
23122
+ "name": "value",
23123
+ "type": {
23124
+ "text": "string"
23125
+ }
23126
+ },
23127
+ {
23128
+ "kind": "field",
23129
+ "name": "filterSearch",
23130
+ "type": {
23131
+ "text": "string"
23132
+ },
23133
+ "privacy": "public",
23134
+ "description": "The criteria to search by"
23135
+ },
23136
+ {
23137
+ "kind": "field",
23138
+ "name": "open",
23139
+ "type": {
23140
+ "text": "boolean"
23141
+ },
23142
+ "privacy": "public",
23143
+ "description": "Whether the dropdown is open or not"
23144
+ },
23145
+ {
23146
+ "kind": "field",
23147
+ "name": "selectedRow",
23148
+ "type": {
23149
+ "text": "object"
23150
+ },
23151
+ "description": "Data for the selected row"
23152
+ },
23153
+ {
23154
+ "kind": "field",
23155
+ "name": "displayValue",
23156
+ "description": "Value to display in the form field",
23157
+ "readonly": true
23158
+ },
23159
+ {
23160
+ "kind": "field",
23161
+ "name": "hasSearchKey",
23162
+ "type": {
23163
+ "text": "boolean"
23164
+ },
23165
+ "readonly": true
23166
+ },
23167
+ {
23168
+ "kind": "field",
23169
+ "name": "hasSlottedContent",
23170
+ "type": {
23171
+ "text": "boolean"
23263
23172
  },
23173
+ "readonly": true
23174
+ },
23175
+ {
23176
+ "kind": "method",
23177
+ "name": "setGridRowData",
23178
+ "privacy": "private",
23264
23179
  "parameters": [
23265
23180
  {
23266
- "name": "persistRowAlertKey",
23181
+ "name": "rows",
23182
+ "type": {
23183
+ "text": "any[]"
23184
+ }
23185
+ }
23186
+ ],
23187
+ "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
23188
+ },
23189
+ {
23190
+ "kind": "method",
23191
+ "name": "setGridColumnDefs",
23192
+ "privacy": "private",
23193
+ "parameters": [
23194
+ {
23195
+ "name": "colDefs",
23196
+ "type": {
23197
+ "text": "ColDef[]"
23198
+ }
23199
+ }
23200
+ ],
23201
+ "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
23202
+ },
23203
+ {
23204
+ "kind": "method",
23205
+ "name": "emitValue",
23206
+ "privacy": "private",
23207
+ "parameters": [
23208
+ {
23209
+ "name": "value",
23267
23210
  "type": {
23268
23211
  "text": "string"
23269
23212
  }
23270
23213
  }
23214
+ ],
23215
+ "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
23216
+ },
23217
+ {
23218
+ "kind": "method",
23219
+ "name": "toggle",
23220
+ "privacy": "public"
23221
+ },
23222
+ {
23223
+ "kind": "method",
23224
+ "name": "getAndSetRows",
23225
+ "privacy": "private"
23226
+ },
23227
+ {
23228
+ "kind": "field",
23229
+ "name": "getAndSetRowsDebounce",
23230
+ "privacy": "private"
23231
+ },
23232
+ {
23233
+ "kind": "method",
23234
+ "name": "filterSearchChanged",
23235
+ "privacy": "public"
23236
+ },
23237
+ {
23238
+ "kind": "method",
23239
+ "name": "requestChanged",
23240
+ "privacy": "public"
23241
+ },
23242
+ {
23243
+ "kind": "method",
23244
+ "name": "columnDefinitionsChanged",
23245
+ "privacy": "public"
23246
+ },
23247
+ {
23248
+ "kind": "field",
23249
+ "name": "handleClickOutside",
23250
+ "privacy": "private"
23251
+ },
23252
+ {
23253
+ "kind": "method",
23254
+ "name": "openChanged",
23255
+ "privacy": "public"
23256
+ },
23257
+ {
23258
+ "kind": "method",
23259
+ "name": "dropdownWidthChanged",
23260
+ "privacy": "public"
23261
+ },
23262
+ {
23263
+ "kind": "method",
23264
+ "name": "changeHandler",
23265
+ "privacy": "public",
23266
+ "parameters": [
23267
+ {
23268
+ "name": "event",
23269
+ "type": {
23270
+ "text": "Event"
23271
+ }
23272
+ }
23271
23273
  ]
23272
23274
  },
23273
23275
  {
23274
23276
  "kind": "method",
23275
- "name": "saveRowAlertPreferences",
23277
+ "name": "cloneNode",
23276
23278
  "return": {
23277
23279
  "type": {
23278
- "text": "Promise<void>"
23280
+ "text": "Node"
23279
23281
  }
23280
23282
  },
23281
23283
  "parameters": [
23282
23284
  {
23283
- "name": "persistRowAlertKey",
23285
+ "name": "deep",
23286
+ "optional": true,
23284
23287
  "type": {
23285
- "text": "string"
23288
+ "text": "boolean"
23286
23289
  }
23287
- },
23290
+ }
23291
+ ],
23292
+ "inheritedFrom": {
23293
+ "name": "LifecycleMixin",
23294
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23295
+ }
23296
+ },
23297
+ {
23298
+ "kind": "method",
23299
+ "name": "deepClone",
23300
+ "return": {
23301
+ "type": {
23302
+ "text": "Node"
23303
+ }
23304
+ },
23305
+ "inheritedFrom": {
23306
+ "name": "LifecycleMixin",
23307
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23308
+ }
23309
+ },
23310
+ {
23311
+ "kind": "field",
23312
+ "name": "shouldRunDisconnect",
23313
+ "return": {
23314
+ "type": {
23315
+ "text": ""
23316
+ }
23317
+ },
23318
+ "readonly": true,
23319
+ "inheritedFrom": {
23320
+ "name": "LifecycleMixin",
23321
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23322
+ }
23323
+ },
23324
+ {
23325
+ "kind": "field",
23326
+ "name": "shouldRunConnect",
23327
+ "return": {
23328
+ "type": {
23329
+ "text": ""
23330
+ }
23331
+ },
23332
+ "readonly": true,
23333
+ "inheritedFrom": {
23334
+ "name": "LifecycleMixin",
23335
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23336
+ }
23337
+ },
23338
+ {
23339
+ "kind": "method",
23340
+ "name": "#_blockLifecycleDueToTokenChange",
23341
+ "return": {
23342
+ "type": {
23343
+ "text": "boolean"
23344
+ }
23345
+ },
23346
+ "parameters": [
23288
23347
  {
23289
- "name": "preferences",
23348
+ "name": "lifecycleType",
23290
23349
  "type": {
23291
- "text": "RowAlertPreferences"
23350
+ "text": "Lifecycletype"
23292
23351
  }
23293
23352
  }
23294
- ]
23353
+ ],
23354
+ "inheritedFrom": {
23355
+ "name": "LifecycleMixin",
23356
+ "module": "src/mixins/lifecycle/lifecycle.ts"
23357
+ }
23358
+ },
23359
+ {
23360
+ "kind": "field",
23361
+ "name": "_presentation",
23362
+ "type": {
23363
+ "text": "ComponentPresentation | null | undefined"
23364
+ },
23365
+ "privacy": "private",
23366
+ "default": "void 0",
23367
+ "inheritedFrom": {
23368
+ "name": "FoundationElement",
23369
+ "module": "src/foundation-element/foundation-element.ts"
23370
+ }
23371
+ },
23372
+ {
23373
+ "kind": "field",
23374
+ "name": "$presentation",
23375
+ "type": {
23376
+ "text": "ComponentPresentation | null"
23377
+ },
23378
+ "privacy": "public",
23379
+ "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
23380
+ "inheritedFrom": {
23381
+ "name": "FoundationElement",
23382
+ "module": "src/foundation-element/foundation-element.ts"
23383
+ }
23384
+ },
23385
+ {
23386
+ "kind": "field",
23387
+ "name": "template",
23388
+ "type": {
23389
+ "text": "ElementViewTemplate | void | null"
23390
+ },
23391
+ "privacy": "public",
23392
+ "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
23393
+ "inheritedFrom": {
23394
+ "name": "FoundationElement",
23395
+ "module": "src/foundation-element/foundation-element.ts"
23396
+ }
23397
+ },
23398
+ {
23399
+ "kind": "method",
23400
+ "name": "templateChanged",
23401
+ "privacy": "protected",
23402
+ "return": {
23403
+ "type": {
23404
+ "text": "void"
23405
+ }
23406
+ },
23407
+ "inheritedFrom": {
23408
+ "name": "FoundationElement",
23409
+ "module": "src/foundation-element/foundation-element.ts"
23410
+ }
23411
+ },
23412
+ {
23413
+ "kind": "field",
23414
+ "name": "styles",
23415
+ "type": {
23416
+ "text": "ElementStyles | void | null"
23417
+ },
23418
+ "privacy": "public",
23419
+ "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
23420
+ "inheritedFrom": {
23421
+ "name": "FoundationElement",
23422
+ "module": "src/foundation-element/foundation-element.ts"
23423
+ }
23424
+ },
23425
+ {
23426
+ "kind": "method",
23427
+ "name": "stylesChanged",
23428
+ "privacy": "protected",
23429
+ "return": {
23430
+ "type": {
23431
+ "text": "void"
23432
+ }
23433
+ },
23434
+ "inheritedFrom": {
23435
+ "name": "FoundationElement",
23436
+ "module": "src/foundation-element/foundation-element.ts"
23437
+ }
23438
+ },
23439
+ {
23440
+ "kind": "method",
23441
+ "name": "compose",
23442
+ "privacy": "public",
23443
+ "static": true,
23444
+ "return": {
23445
+ "type": {
23446
+ "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
23447
+ }
23448
+ },
23449
+ "parameters": [
23450
+ {
23451
+ "name": "this",
23452
+ "type": {
23453
+ "text": "K"
23454
+ }
23455
+ },
23456
+ {
23457
+ "name": "elementDefinition",
23458
+ "type": {
23459
+ "text": "T"
23460
+ },
23461
+ "description": "The definition of the element to create the registry\nfunction for."
23462
+ }
23463
+ ],
23464
+ "description": "Defines an element registry function with a set of element definition defaults.",
23465
+ "inheritedFrom": {
23466
+ "name": "FoundationElement",
23467
+ "module": "src/foundation-element/foundation-element.ts"
23468
+ }
23295
23469
  }
23296
- ]
23470
+ ],
23471
+ "events": [
23472
+ {
23473
+ "description": "Fired when the selected value changes. detail: `string`",
23474
+ "name": "change"
23475
+ },
23476
+ {
23477
+ "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
23478
+ "name": "input"
23479
+ }
23480
+ ],
23481
+ "attributes": [
23482
+ {
23483
+ "type": {
23484
+ "text": "boolean"
23485
+ },
23486
+ "description": "Whether to disable control of the component",
23487
+ "fieldName": "disabled"
23488
+ },
23489
+ {
23490
+ "name": "resource-name",
23491
+ "type": {
23492
+ "text": "string"
23493
+ },
23494
+ "description": "The name of the reqrep to get the options from",
23495
+ "fieldName": "resourceName"
23496
+ },
23497
+ {
23498
+ "name": "search-key",
23499
+ "type": {
23500
+ "text": "string | string[] | undefined"
23501
+ },
23502
+ "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
23503
+ "fieldName": "searchKey"
23504
+ },
23505
+ {
23506
+ "name": "advanced-search-req",
23507
+ "type": {
23508
+ "text": "boolean"
23509
+ },
23510
+ "default": "false",
23511
+ "description": "Tells whether a given request supports lookup by Groovy Expressions.",
23512
+ "fieldName": "requestSupportsAdvancedSearch"
23513
+ },
23514
+ {
23515
+ "name": "value-key",
23516
+ "type": {
23517
+ "text": "string"
23518
+ },
23519
+ "description": "The key used as the value sent to the server",
23520
+ "fieldName": "valueKey"
23521
+ },
23522
+ {
23523
+ "name": "label-key",
23524
+ "type": {
23525
+ "text": "string"
23526
+ },
23527
+ "description": "The key used as the label displayed in the UI",
23528
+ "fieldName": "labelKey"
23529
+ },
23530
+ {
23531
+ "name": "dropdown-placement",
23532
+ "type": {
23533
+ "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
23534
+ },
23535
+ "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left",
23536
+ "fieldName": "dropdownPlacement"
23537
+ },
23538
+ {
23539
+ "name": "dropdownWidth",
23540
+ "type": {
23541
+ "text": "number"
23542
+ },
23543
+ "description": "Optionally specifies the width of the dropdown",
23544
+ "fieldName": "dropdownWidth"
23545
+ }
23546
+ ],
23547
+ "mixins": [
23548
+ {
23549
+ "name": "LifecycleMixin",
23550
+ "package": "@genesislcap/foundation-utils"
23551
+ }
23552
+ ],
23553
+ "superclass": {
23554
+ "name": "FoundationElement",
23555
+ "package": "@microsoft/fast-foundation"
23556
+ },
23557
+ "tagName": "%%prefix%%-multicolumn-dropdown",
23558
+ "customElement": true
23559
+ },
23560
+ {
23561
+ "kind": "variable",
23562
+ "name": "foundationMulticolumnDropdown",
23563
+ "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
23564
+ "privacy": "public"
23297
23565
  }
23298
23566
  ],
23299
23567
  "exports": [
23300
23568
  {
23301
23569
  "kind": "js",
23302
- "name": "LocalStorageStatePersistence",
23570
+ "name": "wasClickOutsideElement",
23303
23571
  "declaration": {
23304
- "name": "LocalStorageStatePersistence",
23305
- "module": "src/state-persistence/local-state.ts"
23572
+ "name": "wasClickOutsideElement",
23573
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23574
+ }
23575
+ },
23576
+ {
23577
+ "kind": "js",
23578
+ "name": "MulticolumnDropdown",
23579
+ "declaration": {
23580
+ "name": "MulticolumnDropdown",
23581
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23582
+ }
23583
+ },
23584
+ {
23585
+ "kind": "js",
23586
+ "name": "foundationMulticolumnDropdown",
23587
+ "declaration": {
23588
+ "name": "foundationMulticolumnDropdown",
23589
+ "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
23306
23590
  }
23307
23591
  }
23308
23592
  ]
23309
23593
  },
23310
23594
  {
23311
23595
  "kind": "javascript-module",
23312
- "path": "src/state-persistence/state-persistence.ts",
23313
- "declarations": [],
23314
- "exports": []
23315
- },
23316
- {
23317
- "kind": "javascript-module",
23318
- "path": "src/multicolumn-dropdown/index.ts",
23596
+ "path": "src/row-alert/index.ts",
23319
23597
  "declarations": [],
23320
23598
  "exports": [
23321
23599
  {
@@ -23323,15 +23601,7 @@
23323
23601
  "name": "*",
23324
23602
  "declaration": {
23325
23603
  "name": "*",
23326
- "package": "./multicolumn-dropdown"
23327
- }
23328
- },
23329
- {
23330
- "kind": "js",
23331
- "name": "*",
23332
- "declaration": {
23333
- "name": "*",
23334
- "package": "./multicolumn-dropdown.styles"
23604
+ "package": "./row-alert"
23335
23605
  }
23336
23606
  },
23337
23607
  {
@@ -23339,799 +23609,529 @@
23339
23609
  "name": "*",
23340
23610
  "declaration": {
23341
23611
  "name": "*",
23342
- "package": "./multicolumn-dropdown.template"
23612
+ "package": "./row-alert.types"
23343
23613
  }
23344
23614
  }
23345
23615
  ]
23346
23616
  },
23347
23617
  {
23348
23618
  "kind": "javascript-module",
23349
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts",
23619
+ "path": "src/row-alert/row-alert.ts",
23620
+ "declarations": [
23621
+ {
23622
+ "kind": "function",
23623
+ "name": "createRowAlert",
23624
+ "return": {
23625
+ "type": {
23626
+ "text": "RowAlert"
23627
+ }
23628
+ },
23629
+ "parameters": [
23630
+ {
23631
+ "name": "criteria",
23632
+ "type": {
23633
+ "text": "RowMatchCriteria"
23634
+ }
23635
+ },
23636
+ {
23637
+ "name": "options",
23638
+ "default": "{}",
23639
+ "type": {
23640
+ "text": "RowAlertOptions"
23641
+ }
23642
+ }
23643
+ ],
23644
+ "description": "Builds the class rules that flash rows matching `criteria`, together with the context menu\nthat lets a user recolor, retime, or narrow that flash to a single cell.\n\nThe rules are created once and never replaced, because a grid backed by a Genesis datasource\nkeeps the options it was created with — handing it new rules later would change nothing. Each\nrule instead asks, as it runs, whether its scope is the one currently selected, so switching\ntarget only needs the rows redrawn.\n\n```ts\nconst alert = createRowAlert(criteria, { persistPreferencesKey: 'orders.row-alert' });\ngridOptions = {\n rowClassRules: alert.rowClassRules,\n defaultColDef: alert.defaultColDef,\n getContextMenuItems: alert.getContextMenuItems,\n};\n```\n\nAlerts sharing a `persistPreferencesKey` share their preferences, so a page of grids that each\nwatch for something different still answers to one setting.\n\nPairs with DatasourceRowMatchTracker: give both the same criteria and a tab can say\nthere is work to do while the grid shows which rows it meant.",
23645
+ "privacy": "public"
23646
+ }
23647
+ ],
23648
+ "exports": [
23649
+ {
23650
+ "kind": "js",
23651
+ "name": "createRowAlert",
23652
+ "declaration": {
23653
+ "name": "createRowAlert",
23654
+ "module": "src/row-alert/row-alert.ts"
23655
+ }
23656
+ }
23657
+ ]
23658
+ },
23659
+ {
23660
+ "kind": "javascript-module",
23661
+ "path": "src/row-alert/row-alert.types.ts",
23350
23662
  "declarations": [
23351
23663
  {
23352
23664
  "kind": "variable",
23353
- "name": "dropdownWidthVar",
23665
+ "name": "defaultRowAlertColorPresets",
23354
23666
  "type": {
23355
- "text": "string"
23667
+ "text": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]"
23356
23668
  },
23357
- "default": "'--dropdown-width'",
23358
- "description": "The CSS variable to use for specifying the dropdown's width"
23669
+ "default": "[\n { id: 'error', label: 'Error', value: 'var(--error-fill-rest, #c62828)' },\n { id: 'warning', label: 'Warning', value: 'var(--warning-fill-rest, #ef6c00)' },\n { id: 'success', label: 'Success', value: 'var(--success-fill-rest, #2e7d32)' },\n { id: 'accent', label: 'Accent', value: 'var(--accent-fill-rest, #1565c0)' },\n { id: 'neutral', label: 'Neutral', value: 'var(--neutral-fill-rest, #546e7a)' },\n]",
23670
+ "description": "Colors offered by default. Each resolves a design token so the menu follows the host\napplication's theme, falling back to a fixed color for design systems that lack the token.",
23671
+ "privacy": "public"
23359
23672
  },
23360
23673
  {
23361
23674
  "kind": "variable",
23362
- "name": "optionsClass",
23675
+ "name": "defaultRowAlertRatePresets",
23363
23676
  "type": {
23364
- "text": "string"
23677
+ "text": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]"
23365
23678
  },
23366
- "default": "'options'",
23367
- "description": "The CSS class to use for the options element's class in the dropdown"
23679
+ "default": "[\n { id: 'slow', label: 'Slow', value: 1400 },\n { id: 'normal', label: 'Normal', value: 1000 },\n { id: 'fast', label: 'Fast', value: 500 },\n]",
23680
+ "description": "Flash rates offered by default.",
23681
+ "privacy": "public"
23368
23682
  },
23369
23683
  {
23370
23684
  "kind": "variable",
23371
- "name": "DISPLAY_NONE_CLASS",
23685
+ "name": "defaultRowAlertScopePresets",
23372
23686
  "type": {
23373
- "text": "string"
23687
+ "text": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]"
23374
23688
  },
23375
- "default": "'dnone'",
23376
- "description": "Class name used to hide elements with display:none"
23689
+ "default": "[\n { id: 'row', label: 'Whole row', value: 'row' },\n { id: 'cell', label: 'Alert field cell', value: 'cell' },\n]",
23690
+ "description": "Flash targets offered by default. Cell scope only has an effect when the criteria name a\n`flashField`.",
23691
+ "privacy": "public"
23377
23692
  },
23378
23693
  {
23379
23694
  "kind": "variable",
23380
- "name": "multicolumnDropdownStyles",
23381
- "default": "css`\n label {\n color: var(--neutral-foreground-hint, rgb(135 155 166));\n font-style: normal;\n margin: calc(var(--design-unit) * 2px) 0;\n display: block;\n cursor: pointer;\n font-size: var(--type-ramp-base-font-size);\n line-height: var(--type-ramp-base-line-height);\n }\n\n .${DISPLAY_NONE_CLASS} {\n display: none !important;\n }\n\n .root {\n position: relative;\n width: inherit;\n min-width: 250px;\n ${dropdownWidthVar}: 350px;\n }\n\n .control {\n cursor: pointer;\n position: relative;\n display: flex;\n align-items: center;\n width: 100%;\n border-radius: calc(var(--control-corner-radius) * 1px);\n }\n\n #display-field {\n width: 100%;\n cursor: pointer;\n color: inherit;\n min-height: 40px;\n padding-left: calc(var(--design-unit) * 2.25px);\n padding-right: 52px;\n border-width: 0;\n background: var(--neutral-fill-input-rest);\n border-radius: calc(var(--control-corner-radius) * 1px);\n text-overflow: ellipsis;\n font-size: var(--type-ramp-base-font-size);\n font-family: var(--body-font);\n }\n\n #display-field[disabled] {\n cursor: not-allowed;\n opacity: var(--disabled-opacity);\n }\n\n #display-field:focus {\n outline: 1px solid var(--accent-fill-rest);\n background: var(--neutral-fill-input-rest);\n border-style: none;\n box-shadow: none;\n }\n\n #display-field:hover:not(:focus):not([disabled]) {\n outline: 1px solid var(--neutral-stroke-hover, rgb(231 232 232));\n }\n\n button {\n pointer-events: none;\n }\n\n #arrow-icon {\n display: inline-block;\n width: 16px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 26px);\n padding: 0;\n cursor: pointer;\n transform: rotate(0deg);\n transition: transform 0.2s linear 0s;\n }\n\n #arrow-icon.flipped {\n transform: rotate(180deg);\n }\n\n .cross-icon {\n display: inline-block;\n width: 12px;\n color: currentColor;\n position: absolute;\n left: calc(100% - 46px);\n padding: 0;\n cursor: pointer;\n visibility: hidden;\n }\n\n .cross-icon:hover {\n color: var(--error-color);\n }\n\n .disabled-icon {\n pointer-events: none;\n opacity: var(--disabled-opacity);\n }\n\n .${optionsClass} {\n min-width: 100%;\n width: var(${dropdownWidthVar});\n display: flex;\n flex-direction: column;\n position: absolute;\n height: max-content;\n overflow-y: hidden;\n margin: 5px 0;\n background: var(--neutral-fill-input-rest);\n visibility: hidden;\n z-index: 999;\n }\n\n .dropdown-above {\n bottom: 100%;\n }\n\n .dropdown-left {\n right: 0;\n }\n\n .grid-container {\n height: 300px;\n width: 100%;\n }\n\n #filter-search {\n padding: 5px;\n }\n\n .visible {\n visibility: visible;\n }\n`",
23382
- "description": "Multicolumn Dropdown styles.",
23695
+ "name": "defaultRowAlertPreferences",
23696
+ "type": {
23697
+ "text": "RowAlertPreferences"
23698
+ },
23699
+ "default": "{\n color: defaultRowAlertColorPresets[0].value,\n durationMs: defaultRowAlertRatePresets[1].value,\n scope: 'row',\n}",
23700
+ "description": "Where preferences start before a user changes anything.",
23383
23701
  "privacy": "public"
23384
23702
  }
23385
23703
  ],
23386
23704
  "exports": [
23387
23705
  {
23388
23706
  "kind": "js",
23389
- "name": "dropdownWidthVar",
23707
+ "name": "defaultRowAlertColorPresets",
23390
23708
  "declaration": {
23391
- "name": "dropdownWidthVar",
23392
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
23709
+ "name": "defaultRowAlertColorPresets",
23710
+ "module": "src/row-alert/row-alert.types.ts"
23393
23711
  }
23394
23712
  },
23395
23713
  {
23396
23714
  "kind": "js",
23397
- "name": "optionsClass",
23715
+ "name": "defaultRowAlertRatePresets",
23398
23716
  "declaration": {
23399
- "name": "optionsClass",
23400
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
23717
+ "name": "defaultRowAlertRatePresets",
23718
+ "module": "src/row-alert/row-alert.types.ts"
23401
23719
  }
23402
23720
  },
23403
23721
  {
23404
23722
  "kind": "js",
23405
- "name": "DISPLAY_NONE_CLASS",
23723
+ "name": "defaultRowAlertScopePresets",
23406
23724
  "declaration": {
23407
- "name": "DISPLAY_NONE_CLASS",
23408
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
23725
+ "name": "defaultRowAlertScopePresets",
23726
+ "module": "src/row-alert/row-alert.types.ts"
23409
23727
  }
23410
23728
  },
23411
23729
  {
23412
23730
  "kind": "js",
23413
- "name": "multicolumnDropdownStyles",
23731
+ "name": "defaultRowAlertPreferences",
23414
23732
  "declaration": {
23415
- "name": "multicolumnDropdownStyles",
23416
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.styles.ts"
23733
+ "name": "defaultRowAlertPreferences",
23734
+ "module": "src/row-alert/row-alert.types.ts"
23417
23735
  }
23418
23736
  }
23419
23737
  ]
23420
23738
  },
23421
23739
  {
23422
23740
  "kind": "javascript-module",
23423
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts",
23424
- "declarations": [
23741
+ "path": "src/state-persistence/index.ts",
23742
+ "declarations": [],
23743
+ "exports": [
23425
23744
  {
23426
- "kind": "function",
23427
- "name": "getMulticolumnDropdownTemplate",
23428
- "parameters": [
23429
- {
23430
- "name": "designSystem",
23431
- "default": "'foundation'",
23432
- "description": "The design system prefix to use. Defaults to 'foundation'."
23433
- }
23434
- ],
23435
- "description": "Get a Design System prefixed Multicolumn Dropdown template.",
23436
- "return": {
23437
- "type": {
23438
- "text": ""
23439
- }
23440
- },
23441
- "privacy": "public"
23745
+ "kind": "js",
23746
+ "name": "*",
23747
+ "declaration": {
23748
+ "name": "*",
23749
+ "package": "./kv-state"
23750
+ }
23442
23751
  },
23443
- {
23444
- "kind": "variable",
23445
- "name": "multicolumnDropdownTemplate",
23446
- "description": "The default Multicolumn Dropdown template using the 'foundation' design system prefix.",
23447
- "privacy": "public"
23448
- }
23449
- ],
23450
- "exports": [
23451
23752
  {
23452
23753
  "kind": "js",
23453
- "name": "getMulticolumnDropdownTemplate",
23754
+ "name": "*",
23454
23755
  "declaration": {
23455
- "name": "getMulticolumnDropdownTemplate",
23456
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
23756
+ "name": "*",
23757
+ "package": "./local-state"
23457
23758
  }
23458
23759
  },
23459
23760
  {
23460
23761
  "kind": "js",
23461
- "name": "multicolumnDropdownTemplate",
23762
+ "name": "*",
23462
23763
  "declaration": {
23463
- "name": "multicolumnDropdownTemplate",
23464
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.template.ts"
23764
+ "name": "*",
23765
+ "package": "./state-persistence"
23465
23766
  }
23466
23767
  }
23467
23768
  ]
23468
23769
  },
23469
23770
  {
23470
23771
  "kind": "javascript-module",
23471
- "path": "src/multicolumn-dropdown/multicolumn-dropdown.ts",
23772
+ "path": "src/state-persistence/kv-state.ts",
23472
23773
  "declarations": [
23473
- {
23474
- "kind": "function",
23475
- "name": "wasClickOutsideElement",
23476
- "parameters": [
23477
- {
23478
- "name": "event",
23479
- "type": {
23480
- "text": "MouseEvent"
23481
- }
23482
- },
23483
- {
23484
- "name": "target",
23485
- "type": {
23486
- "text": "EventTarget"
23487
- }
23488
- }
23489
- ],
23490
- "description": "Checks if the given mouse event occurred outside the target element.",
23491
- "privacy": "public"
23492
- },
23493
23774
  {
23494
23775
  "kind": "class",
23495
- "description": "",
23496
- "name": "MulticolumnDropdown",
23776
+ "description": "Implementation for the KV Storage State Persistence interface.",
23777
+ "name": "KVStorageStatePersistence",
23497
23778
  "members": [
23498
23779
  {
23499
23780
  "kind": "field",
23500
- "name": "optionsElement",
23501
- "type": {
23502
- "text": "HTMLElement"
23503
- }
23504
- },
23505
- {
23506
- "kind": "field",
23507
- "name": "lastRequest",
23508
- "type": {
23509
- "text": "object"
23510
- },
23511
- "privacy": "private"
23512
- },
23513
- {
23514
- "kind": "field",
23515
- "name": "connectOverride",
23516
- "type": {
23517
- "text": "Connect"
23518
- },
23519
- "privacy": "private"
23520
- },
23521
- {
23522
- "kind": "field",
23523
- "name": "_connectDI",
23524
- "type": {
23525
- "text": "Connect"
23526
- },
23527
- "privacy": "private"
23528
- },
23529
- {
23530
- "kind": "field",
23531
- "name": "connect",
23532
- "type": {
23533
- "text": "Connect"
23534
- },
23535
- "description": "The connect service - uses DI by default, but can be manually set for dynamic element creation"
23536
- },
23537
- {
23538
- "kind": "field",
23539
- "name": "disabled",
23540
- "type": {
23541
- "text": "boolean"
23542
- },
23543
- "privacy": "public",
23544
- "description": "Whether to disable control of the component"
23545
- },
23546
- {
23547
- "kind": "field",
23548
- "name": "resourceName",
23549
- "type": {
23550
- "text": "string"
23551
- },
23552
- "privacy": "public",
23553
- "description": "The name of the reqrep to get the options from"
23554
- },
23555
- {
23556
- "kind": "field",
23557
- "name": "searchKey",
23558
- "type": {
23559
- "text": "string | string[] | undefined"
23560
- },
23561
- "privacy": "public",
23562
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\")."
23563
- },
23564
- {
23565
- "kind": "field",
23566
- "name": "requestSupportsAdvancedSearch",
23567
- "type": {
23568
- "text": "boolean"
23569
- },
23570
- "privacy": "public",
23571
- "default": "false",
23572
- "description": "Tells whether a given request supports lookup by Groovy Expressions."
23573
- },
23574
- {
23575
- "kind": "field",
23576
- "name": "valueKey",
23577
- "type": {
23578
- "text": "string"
23579
- },
23580
- "privacy": "public",
23581
- "description": "The key used as the value sent to the server"
23582
- },
23583
- {
23584
- "kind": "field",
23585
- "name": "labelKey",
23586
- "type": {
23587
- "text": "string"
23588
- },
23589
- "privacy": "public",
23590
- "description": "The key used as the label displayed in the UI"
23591
- },
23592
- {
23593
- "kind": "field",
23594
- "name": "dropdownPlacement",
23595
- "type": {
23596
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
23597
- },
23598
- "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left"
23599
- },
23600
- {
23601
- "kind": "field",
23602
- "name": "dropdownWidth",
23603
- "type": {
23604
- "text": "number"
23605
- },
23606
- "privacy": "public",
23607
- "description": "Optionally specifies the width of the dropdown"
23608
- },
23609
- {
23610
- "kind": "field",
23611
- "name": "request",
23612
- "type": {
23613
- "text": "object"
23614
- },
23615
- "privacy": "public",
23616
- "description": "A request object to pass in the reqrep"
23617
- },
23618
- {
23619
- "kind": "field",
23620
- "name": "columnDefinitions",
23621
- "type": {
23622
- "text": "ColDef[]"
23623
- },
23624
- "privacy": "public",
23625
- "description": "An array of AG Grid column definitions to use in the grid to display the data"
23626
- },
23627
- {
23628
- "kind": "field",
23629
- "name": "baseCriteria",
23630
- "type": {
23631
- "text": "string | undefined"
23632
- },
23633
- "privacy": "public",
23634
- "description": "Base criteria that is always applied to requests combined with search criteria via AND.\nUse this to pre-filter results."
23635
- },
23636
- {
23637
- "kind": "field",
23638
- "name": "defaultSlottedNodes",
23639
- "type": {
23640
- "text": "Node[]"
23641
- },
23642
- "privacy": "public",
23643
- "default": "[]"
23644
- },
23645
- {
23646
- "kind": "field",
23647
- "name": "grid",
23648
- "type": {
23649
- "text": "GridPro | GridProLegacy"
23650
- },
23651
- "privacy": "public"
23652
- },
23653
- {
23654
- "kind": "field",
23655
- "name": "_value",
23656
- "type": {
23657
- "text": "string"
23658
- },
23659
- "privacy": "private"
23660
- },
23661
- {
23662
- "kind": "field",
23663
- "name": "value",
23664
- "type": {
23665
- "text": "string"
23666
- }
23667
- },
23668
- {
23669
- "kind": "field",
23670
- "name": "filterSearch",
23671
- "type": {
23672
- "text": "string"
23673
- },
23674
- "privacy": "public",
23675
- "description": "The criteria to search by"
23676
- },
23677
- {
23678
- "kind": "field",
23679
- "name": "open",
23680
- "type": {
23681
- "text": "boolean"
23682
- },
23683
- "privacy": "public",
23684
- "description": "Whether the dropdown is open or not"
23685
- },
23686
- {
23687
- "kind": "field",
23688
- "name": "selectedRow",
23689
- "type": {
23690
- "text": "object"
23691
- },
23692
- "description": "Data for the selected row"
23693
- },
23694
- {
23695
- "kind": "field",
23696
- "name": "displayValue",
23697
- "description": "Value to display in the form field",
23698
- "readonly": true
23699
- },
23700
- {
23701
- "kind": "field",
23702
- "name": "hasSearchKey",
23703
- "type": {
23704
- "text": "boolean"
23705
- },
23706
- "readonly": true
23707
- },
23708
- {
23709
- "kind": "field",
23710
- "name": "hasSlottedContent",
23781
+ "name": "kvStorage",
23711
23782
  "type": {
23712
- "text": "boolean"
23713
- },
23714
- "readonly": true
23715
- },
23716
- {
23717
- "kind": "method",
23718
- "name": "setGridRowData",
23719
- "privacy": "private",
23720
- "parameters": [
23721
- {
23722
- "name": "rows",
23723
- "type": {
23724
- "text": "any[]"
23725
- }
23726
- }
23727
- ],
23728
- "description": "Sets row data on the grid in a version-safe way.\nAG Grid v32+ removed `setRowData` in favour of `updateGridOptions`."
23783
+ "text": "KVStorage"
23784
+ }
23785
+ },
23786
+ {
23787
+ "kind": "field",
23788
+ "name": "session",
23789
+ "type": {
23790
+ "text": "Session"
23791
+ }
23729
23792
  },
23730
23793
  {
23731
23794
  "kind": "method",
23732
- "name": "setGridColumnDefs",
23733
- "privacy": "private",
23795
+ "name": "getColumnState",
23796
+ "return": {
23797
+ "type": {
23798
+ "text": "Promise<ColumnState[]>"
23799
+ }
23800
+ },
23734
23801
  "parameters": [
23735
23802
  {
23736
- "name": "colDefs",
23803
+ "name": "persistColumnStateKey",
23737
23804
  "type": {
23738
- "text": "ColDef[]"
23805
+ "text": "string"
23739
23806
  }
23740
23807
  }
23741
- ],
23742
- "description": "Sets column defs on the grid in a version-safe way.\nAG Grid v32+ removed `setColumnDefs` in favour of `updateGridOptions`."
23808
+ ]
23743
23809
  },
23744
23810
  {
23745
23811
  "kind": "method",
23746
- "name": "emitValue",
23747
- "privacy": "private",
23812
+ "name": "saveColumnState",
23813
+ "return": {
23814
+ "type": {
23815
+ "text": "Promise<void>"
23816
+ }
23817
+ },
23748
23818
  "parameters": [
23749
23819
  {
23750
- "name": "value",
23820
+ "name": "persistColumnStateKey",
23751
23821
  "type": {
23752
23822
  "text": "string"
23753
23823
  }
23754
- }
23755
- ],
23756
- "description": "Emits 'change' and 'input' events so that the `sync` directive and forms work correctly."
23757
- },
23758
- {
23759
- "kind": "method",
23760
- "name": "toggle",
23761
- "privacy": "public"
23762
- },
23763
- {
23764
- "kind": "method",
23765
- "name": "getAndSetRows",
23766
- "privacy": "private"
23767
- },
23768
- {
23769
- "kind": "field",
23770
- "name": "getAndSetRowsDebounce",
23771
- "privacy": "private"
23772
- },
23773
- {
23774
- "kind": "method",
23775
- "name": "filterSearchChanged",
23776
- "privacy": "public"
23777
- },
23778
- {
23779
- "kind": "method",
23780
- "name": "requestChanged",
23781
- "privacy": "public"
23782
- },
23783
- {
23784
- "kind": "method",
23785
- "name": "columnDefinitionsChanged",
23786
- "privacy": "public"
23787
- },
23788
- {
23789
- "kind": "field",
23790
- "name": "handleClickOutside",
23791
- "privacy": "private"
23792
- },
23793
- {
23794
- "kind": "method",
23795
- "name": "openChanged",
23796
- "privacy": "public"
23797
- },
23798
- {
23799
- "kind": "method",
23800
- "name": "dropdownWidthChanged",
23801
- "privacy": "public"
23802
- },
23803
- {
23804
- "kind": "method",
23805
- "name": "changeHandler",
23806
- "privacy": "public",
23807
- "parameters": [
23824
+ },
23808
23825
  {
23809
- "name": "event",
23826
+ "name": "columnState",
23810
23827
  "type": {
23811
- "text": "Event"
23828
+ "text": "ColumnState[]"
23812
23829
  }
23813
23830
  }
23814
23831
  ]
23815
23832
  },
23816
23833
  {
23817
23834
  "kind": "method",
23818
- "name": "cloneNode",
23835
+ "name": "deleteColumnState",
23819
23836
  "return": {
23820
23837
  "type": {
23821
- "text": "Node"
23838
+ "text": "Promise<void>"
23822
23839
  }
23823
23840
  },
23824
23841
  "parameters": [
23825
23842
  {
23826
- "name": "deep",
23827
- "optional": true,
23843
+ "name": "persistColumnStateKey",
23828
23844
  "type": {
23829
- "text": "boolean"
23845
+ "text": "string"
23830
23846
  }
23831
23847
  }
23832
- ],
23833
- "inheritedFrom": {
23834
- "name": "LifecycleMixin",
23835
- "module": "src/mixins/lifecycle/lifecycle.ts"
23836
- }
23848
+ ]
23837
23849
  },
23838
23850
  {
23839
23851
  "kind": "method",
23840
- "name": "deepClone",
23852
+ "name": "migrateLocalStorageToKVStorage",
23853
+ "privacy": "private",
23841
23854
  "return": {
23842
23855
  "type": {
23843
- "text": "Node"
23856
+ "text": "Promise<void>"
23844
23857
  }
23845
23858
  },
23846
- "inheritedFrom": {
23847
- "name": "LifecycleMixin",
23848
- "module": "src/mixins/lifecycle/lifecycle.ts"
23849
- }
23859
+ "parameters": [
23860
+ {
23861
+ "name": "persistColumnStateKey",
23862
+ "type": {
23863
+ "text": "string"
23864
+ }
23865
+ }
23866
+ ]
23850
23867
  },
23851
23868
  {
23852
- "kind": "field",
23853
- "name": "shouldRunDisconnect",
23869
+ "kind": "method",
23870
+ "name": "getFilterModel",
23854
23871
  "return": {
23855
23872
  "type": {
23856
- "text": ""
23873
+ "text": "Promise<{ [key: string]: any }>"
23857
23874
  }
23858
23875
  },
23859
- "readonly": true,
23860
- "inheritedFrom": {
23861
- "name": "LifecycleMixin",
23862
- "module": "src/mixins/lifecycle/lifecycle.ts"
23863
- }
23876
+ "parameters": [
23877
+ {
23878
+ "name": "persistFilterModelKey",
23879
+ "type": {
23880
+ "text": "string"
23881
+ }
23882
+ }
23883
+ ]
23864
23884
  },
23865
23885
  {
23866
- "kind": "field",
23867
- "name": "shouldRunConnect",
23886
+ "kind": "method",
23887
+ "name": "saveFilterModel",
23868
23888
  "return": {
23869
23889
  "type": {
23870
- "text": ""
23890
+ "text": "Promise<void>"
23871
23891
  }
23872
23892
  },
23873
- "readonly": true,
23874
- "inheritedFrom": {
23875
- "name": "LifecycleMixin",
23876
- "module": "src/mixins/lifecycle/lifecycle.ts"
23877
- }
23893
+ "parameters": [
23894
+ {
23895
+ "name": "persistFilterModelKey",
23896
+ "type": {
23897
+ "text": "string"
23898
+ }
23899
+ },
23900
+ {
23901
+ "name": "filterModel",
23902
+ "type": {
23903
+ "text": "{ [key: string]: any }"
23904
+ }
23905
+ }
23906
+ ]
23878
23907
  },
23879
23908
  {
23880
23909
  "kind": "method",
23881
- "name": "#_blockLifecycleDueToTokenChange",
23910
+ "name": "getRowAlertPreferences",
23882
23911
  "return": {
23883
23912
  "type": {
23884
- "text": "boolean"
23913
+ "text": "Promise<Partial<RowAlertPreferences>>"
23885
23914
  }
23886
23915
  },
23887
23916
  "parameters": [
23888
23917
  {
23889
- "name": "lifecycleType",
23918
+ "name": "persistRowAlertKey",
23890
23919
  "type": {
23891
- "text": "Lifecycletype"
23920
+ "text": "string"
23892
23921
  }
23893
23922
  }
23894
- ],
23895
- "inheritedFrom": {
23896
- "name": "LifecycleMixin",
23897
- "module": "src/mixins/lifecycle/lifecycle.ts"
23898
- }
23899
- },
23900
- {
23901
- "kind": "field",
23902
- "name": "_presentation",
23903
- "type": {
23904
- "text": "ComponentPresentation | null | undefined"
23905
- },
23906
- "privacy": "private",
23907
- "default": "void 0",
23908
- "inheritedFrom": {
23909
- "name": "FoundationElement",
23910
- "module": "src/foundation-element/foundation-element.ts"
23911
- }
23912
- },
23913
- {
23914
- "kind": "field",
23915
- "name": "$presentation",
23916
- "type": {
23917
- "text": "ComponentPresentation | null"
23918
- },
23919
- "privacy": "public",
23920
- "description": "A property which resolves the ComponentPresentation instance\nfor the current component.",
23921
- "inheritedFrom": {
23922
- "name": "FoundationElement",
23923
- "module": "src/foundation-element/foundation-element.ts"
23924
- }
23925
- },
23926
- {
23927
- "kind": "field",
23928
- "name": "template",
23929
- "type": {
23930
- "text": "ElementViewTemplate | void | null"
23931
- },
23932
- "privacy": "public",
23933
- "description": "Sets the template of the element instance. When undefined,\nthe element will attempt to resolve the template from\nthe associated presentation or custom element definition.",
23934
- "inheritedFrom": {
23935
- "name": "FoundationElement",
23936
- "module": "src/foundation-element/foundation-element.ts"
23937
- }
23923
+ ]
23938
23924
  },
23939
23925
  {
23940
23926
  "kind": "method",
23941
- "name": "templateChanged",
23942
- "privacy": "protected",
23927
+ "name": "saveRowAlertPreferences",
23943
23928
  "return": {
23944
23929
  "type": {
23945
- "text": "void"
23930
+ "text": "Promise<void>"
23946
23931
  }
23947
23932
  },
23948
- "inheritedFrom": {
23949
- "name": "FoundationElement",
23950
- "module": "src/foundation-element/foundation-element.ts"
23951
- }
23952
- },
23933
+ "parameters": [
23934
+ {
23935
+ "name": "persistRowAlertKey",
23936
+ "type": {
23937
+ "text": "string"
23938
+ }
23939
+ },
23940
+ {
23941
+ "name": "preferences",
23942
+ "type": {
23943
+ "text": "RowAlertPreferences"
23944
+ }
23945
+ }
23946
+ ]
23947
+ }
23948
+ ]
23949
+ }
23950
+ ],
23951
+ "exports": [
23952
+ {
23953
+ "kind": "js",
23954
+ "name": "KVStorageStatePersistence",
23955
+ "declaration": {
23956
+ "name": "KVStorageStatePersistence",
23957
+ "module": "src/state-persistence/kv-state.ts"
23958
+ }
23959
+ }
23960
+ ]
23961
+ },
23962
+ {
23963
+ "kind": "javascript-module",
23964
+ "path": "src/state-persistence/local-state.ts",
23965
+ "declarations": [
23966
+ {
23967
+ "kind": "class",
23968
+ "description": "Implementation for the Local Storage State Persistence interface.",
23969
+ "name": "LocalStorageStatePersistence",
23970
+ "members": [
23953
23971
  {
23954
23972
  "kind": "field",
23955
- "name": "styles",
23973
+ "name": "session",
23956
23974
  "type": {
23957
- "text": "ElementStyles | void | null"
23958
- },
23959
- "privacy": "public",
23960
- "description": "Sets the default styles for the element instance. When undefined,\nthe element will attempt to resolve default styles from\nthe associated presentation or custom element definition.",
23961
- "inheritedFrom": {
23962
- "name": "FoundationElement",
23963
- "module": "src/foundation-element/foundation-element.ts"
23975
+ "text": "Session"
23964
23976
  }
23965
23977
  },
23966
23978
  {
23967
23979
  "kind": "method",
23968
- "name": "stylesChanged",
23969
- "privacy": "protected",
23980
+ "name": "getColumnState",
23970
23981
  "return": {
23971
23982
  "type": {
23972
- "text": "void"
23983
+ "text": "Promise<ColumnState[]>"
23973
23984
  }
23974
23985
  },
23975
- "inheritedFrom": {
23976
- "name": "FoundationElement",
23977
- "module": "src/foundation-element/foundation-element.ts"
23978
- }
23986
+ "parameters": [
23987
+ {
23988
+ "name": "persistColumnStateKey",
23989
+ "type": {
23990
+ "text": "string"
23991
+ }
23992
+ }
23993
+ ]
23979
23994
  },
23980
23995
  {
23981
23996
  "kind": "method",
23982
- "name": "compose",
23983
- "privacy": "public",
23984
- "static": true,
23997
+ "name": "saveColumnState",
23985
23998
  "return": {
23986
23999
  "type": {
23987
- "text": "(\n overrideDefinition?: OverrideFoundationElementDefinition<T>\n ) => FoundationElementRegistry<T, K>"
24000
+ "text": "Promise<void>"
23988
24001
  }
23989
24002
  },
23990
24003
  "parameters": [
23991
24004
  {
23992
- "name": "this",
24005
+ "name": "persistColumnStateKey",
23993
24006
  "type": {
23994
- "text": "K"
24007
+ "text": "string"
23995
24008
  }
23996
24009
  },
23997
24010
  {
23998
- "name": "elementDefinition",
24011
+ "name": "columnState",
23999
24012
  "type": {
24000
- "text": "T"
24001
- },
24002
- "description": "The definition of the element to create the registry\nfunction for."
24013
+ "text": "ColumnState[]"
24014
+ }
24003
24015
  }
24004
- ],
24005
- "description": "Defines an element registry function with a set of element definition defaults.",
24006
- "inheritedFrom": {
24007
- "name": "FoundationElement",
24008
- "module": "src/foundation-element/foundation-element.ts"
24009
- }
24010
- }
24011
- ],
24012
- "events": [
24013
- {
24014
- "description": "Fired when the selected value changes. detail: `string`",
24015
- "name": "change"
24016
- },
24017
- {
24018
- "description": "Fired when the value is updated (including programmatic changes). detail: `string`",
24019
- "name": "input"
24020
- }
24021
- ],
24022
- "attributes": [
24023
- {
24024
- "type": {
24025
- "text": "boolean"
24026
- },
24027
- "description": "Whether to disable control of the component",
24028
- "fieldName": "disabled"
24029
- },
24030
- {
24031
- "name": "resource-name",
24032
- "type": {
24033
- "text": "string"
24034
- },
24035
- "description": "The name of the reqrep to get the options from",
24036
- "fieldName": "resourceName"
24037
- },
24038
- {
24039
- "name": "search-key",
24040
- "type": {
24041
- "text": "string | string[] | undefined"
24042
- },
24043
- "description": "The key(s) to search by. Use comma-separated values for multiple keys (e.g. search-key=\"NAME,ID\").",
24044
- "fieldName": "searchKey"
24016
+ ]
24045
24017
  },
24046
24018
  {
24047
- "name": "advanced-search-req",
24048
- "type": {
24049
- "text": "boolean"
24019
+ "kind": "method",
24020
+ "name": "deleteColumnState",
24021
+ "return": {
24022
+ "type": {
24023
+ "text": "Promise<void>"
24024
+ }
24050
24025
  },
24051
- "default": "false",
24052
- "description": "Tells whether a given request supports lookup by Groovy Expressions.",
24053
- "fieldName": "requestSupportsAdvancedSearch"
24026
+ "parameters": [
24027
+ {
24028
+ "name": "persistColumnStateKey",
24029
+ "type": {
24030
+ "text": "string"
24031
+ }
24032
+ }
24033
+ ]
24054
24034
  },
24055
24035
  {
24056
- "name": "value-key",
24057
- "type": {
24058
- "text": "string"
24036
+ "kind": "method",
24037
+ "name": "getFilterModel",
24038
+ "return": {
24039
+ "type": {
24040
+ "text": "Promise<{ [key: string]: any }>"
24041
+ }
24059
24042
  },
24060
- "description": "The key used as the value sent to the server",
24061
- "fieldName": "valueKey"
24043
+ "parameters": [
24044
+ {
24045
+ "name": "persistFilterModelKey",
24046
+ "type": {
24047
+ "text": "string"
24048
+ }
24049
+ }
24050
+ ]
24062
24051
  },
24063
24052
  {
24064
- "name": "label-key",
24065
- "type": {
24066
- "text": "string"
24053
+ "kind": "method",
24054
+ "name": "saveFilterModel",
24055
+ "return": {
24056
+ "type": {
24057
+ "text": "Promise<void>"
24058
+ }
24067
24059
  },
24068
- "description": "The key used as the label displayed in the UI",
24069
- "fieldName": "labelKey"
24060
+ "parameters": [
24061
+ {
24062
+ "name": "persistFilterModelKey",
24063
+ "type": {
24064
+ "text": "string"
24065
+ }
24066
+ },
24067
+ {
24068
+ "name": "filterModel",
24069
+ "type": {
24070
+ "text": "{ [key: string]: any }"
24071
+ }
24072
+ }
24073
+ ]
24070
24074
  },
24071
24075
  {
24072
- "name": "dropdown-placement",
24073
- "type": {
24074
- "text": "'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'"
24076
+ "kind": "method",
24077
+ "name": "getRowAlertPreferences",
24078
+ "return": {
24079
+ "type": {
24080
+ "text": "Promise<Partial<RowAlertPreferences>>"
24081
+ }
24075
24082
  },
24076
- "description": "Position of the dropdown panel relative to the control.\n- `'bottom-right'` – default; opens below and aligns to the right edge of the control\n- `'bottom-left'` – opens below and extends to the left\n- `'top-right'` – opens above and aligns to the right edge of the control\n- `'top-left'` – opens above and extends to the left",
24077
- "fieldName": "dropdownPlacement"
24083
+ "parameters": [
24084
+ {
24085
+ "name": "persistRowAlertKey",
24086
+ "type": {
24087
+ "text": "string"
24088
+ }
24089
+ }
24090
+ ]
24078
24091
  },
24079
24092
  {
24080
- "name": "dropdownWidth",
24081
- "type": {
24082
- "text": "number"
24093
+ "kind": "method",
24094
+ "name": "saveRowAlertPreferences",
24095
+ "return": {
24096
+ "type": {
24097
+ "text": "Promise<void>"
24098
+ }
24083
24099
  },
24084
- "description": "Optionally specifies the width of the dropdown",
24085
- "fieldName": "dropdownWidth"
24086
- }
24087
- ],
24088
- "mixins": [
24089
- {
24090
- "name": "LifecycleMixin",
24091
- "package": "@genesislcap/foundation-utils"
24100
+ "parameters": [
24101
+ {
24102
+ "name": "persistRowAlertKey",
24103
+ "type": {
24104
+ "text": "string"
24105
+ }
24106
+ },
24107
+ {
24108
+ "name": "preferences",
24109
+ "type": {
24110
+ "text": "RowAlertPreferences"
24111
+ }
24112
+ }
24113
+ ]
24092
24114
  }
24093
- ],
24094
- "superclass": {
24095
- "name": "FoundationElement",
24096
- "package": "@microsoft/fast-foundation"
24097
- },
24098
- "tagName": "%%prefix%%-multicolumn-dropdown",
24099
- "customElement": true
24100
- },
24101
- {
24102
- "kind": "variable",
24103
- "name": "foundationMulticolumnDropdown",
24104
- "description": "A function that returns a Multicolumn Dropdown registration for configuring the component with a DesignSystem.",
24105
- "privacy": "public"
24115
+ ]
24106
24116
  }
24107
24117
  ],
24108
24118
  "exports": [
24109
24119
  {
24110
24120
  "kind": "js",
24111
- "name": "wasClickOutsideElement",
24112
- "declaration": {
24113
- "name": "wasClickOutsideElement",
24114
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
24115
- }
24116
- },
24117
- {
24118
- "kind": "js",
24119
- "name": "MulticolumnDropdown",
24120
- "declaration": {
24121
- "name": "MulticolumnDropdown",
24122
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
24123
- }
24124
- },
24125
- {
24126
- "kind": "js",
24127
- "name": "foundationMulticolumnDropdown",
24121
+ "name": "LocalStorageStatePersistence",
24128
24122
  "declaration": {
24129
- "name": "foundationMulticolumnDropdown",
24130
- "module": "src/multicolumn-dropdown/multicolumn-dropdown.ts"
24123
+ "name": "LocalStorageStatePersistence",
24124
+ "module": "src/state-persistence/local-state.ts"
24131
24125
  }
24132
24126
  }
24133
24127
  ]
24134
24128
  },
24129
+ {
24130
+ "kind": "javascript-module",
24131
+ "path": "src/state-persistence/state-persistence.ts",
24132
+ "declarations": [],
24133
+ "exports": []
24134
+ },
24135
24135
  {
24136
24136
  "kind": "javascript-module",
24137
24137
  "path": "src/status-bar-components/index.ts",