@vuu-ui/vuu-filters 4.0.0-alpha.21 → 4.0.0-alpha.23

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 (78) hide show
  1. package/package.json +12 -12
  2. package/src/toggle-filter/ToggleFilter.js +2 -1
  3. package/src/toggle-filter/useToggleFilter.js +15 -2
  4. package/types/column-filter/column-filter-utils.d.ts +8 -0
  5. package/types/toggle-filter/ToggleFilter.d.ts +3 -0
  6. package/types/toggle-filter/useToggleFilter.d.ts +9 -1
  7. package/types/src/FilterAggregator.d.ts +0 -28
  8. package/types/src/FilterModel.d.ts +0 -44
  9. package/types/src/column-filter/ColumnFilter.d.ts +0 -6
  10. package/types/src/column-filter/useColumnFilter.d.ts +0 -43
  11. package/types/src/column-filter/utils.d.ts +0 -4
  12. package/types/src/custom-filters/CustomFilters.d.ts +0 -7
  13. package/types/src/custom-filters/filterBarFocusManagement.d.ts +0 -1
  14. package/types/src/custom-filters/index.d.ts +0 -1
  15. package/types/src/custom-filters/useCustomFilters.d.ts +0 -33
  16. package/types/src/custom-filters/useFilterState.d.ts +0 -17
  17. package/types/src/filter-bar/FilterBar.d.ts +0 -33
  18. package/types/src/filter-bar/FilterBarMenu.d.ts +0 -1
  19. package/types/src/filter-bar/index.d.ts +0 -2
  20. package/types/src/filter-bar/useFilterBar.d.ts +0 -7
  21. package/types/src/filter-clause/ExpandoCombobox.d.ts +0 -10
  22. package/types/src/filter-clause/FilterClause.d.ts +0 -16
  23. package/types/src/filter-clause/column-picker/ColumnPicker.d.ts +0 -13
  24. package/types/src/filter-clause/column-picker/useColumnPicker.d.ts +0 -11
  25. package/types/src/filter-clause/filterClauseFocusManagement.d.ts +0 -15
  26. package/types/src/filter-clause/filterClauseTypes.d.ts +0 -12
  27. package/types/src/filter-clause/index.d.ts +0 -5
  28. package/types/src/filter-clause/operator-picker/OperatorPicker.d.ts +0 -14
  29. package/types/src/filter-clause/operator-picker/operator-utils.d.ts +0 -5
  30. package/types/src/filter-clause/operator-picker/useOperatorPicker.d.ts +0 -12
  31. package/types/src/filter-clause/useFilterClause.d.ts +0 -26
  32. package/types/src/filter-clause/value-editors/FilterClauseValueEditor.d.ts +0 -26
  33. package/types/src/filter-clause/value-editors/FilterClauseValueEditorDate.d.ts +0 -9
  34. package/types/src/filter-clause/value-editors/FilterClauseValueEditorNumber.d.ts +0 -9
  35. package/types/src/filter-clause/value-editors/FilterClauseValueEditorText.d.ts +0 -9
  36. package/types/src/filter-clause/value-editors/FilterClauseValueEditorTime.d.ts +0 -9
  37. package/types/src/filter-container/ExtendedSingleValueFilterClause.d.ts +0 -21
  38. package/types/src/filter-container/FilterContainer.d.ts +0 -23
  39. package/types/src/filter-container/useFilterContainer.d.ts +0 -22
  40. package/types/src/filter-context-menu/useFilterContextMenu.d.ts +0 -6
  41. package/types/src/filter-display/FilterDisplay.d.ts +0 -10
  42. package/types/src/filter-editor/FilterClauseCombinator.d.ts +0 -9
  43. package/types/src/filter-editor/FilterEditor.d.ts +0 -14
  44. package/types/src/filter-editor/index.d.ts +0 -1
  45. package/types/src/filter-editor/useFilterEditor.d.ts +0 -32
  46. package/types/src/filter-panel/FilterPanel.d.ts +0 -9
  47. package/types/src/filter-panel/useFilterPanel.d.ts +0 -14
  48. package/types/src/filter-pill/FilterMenu.d.ts +0 -24
  49. package/types/src/filter-pill/FilterPill.d.ts +0 -16
  50. package/types/src/filter-pill/FilterPillNext.d.ts +0 -15
  51. package/types/src/filter-pill/filterAsReactNode.d.ts +0 -3
  52. package/types/src/filter-pill/getFilterLabel.d.ts +0 -2
  53. package/types/src/filter-pill/getFilterTooltipText.d.ts +0 -2
  54. package/types/src/filter-pill/index.d.ts +0 -1
  55. package/types/src/filter-pill/useFilterPillNext.d.ts +0 -25
  56. package/types/src/filter-pill-menu/FilterPillMenu.d.ts +0 -17
  57. package/types/src/filter-pill-menu/FilterPillMenuOptions.d.ts +0 -12
  58. package/types/src/filter-pill-menu/index.d.ts +0 -1
  59. package/types/src/filter-provider/FilterContext.d.ts +0 -39
  60. package/types/src/filter-provider/FilterProvider.d.ts +0 -10
  61. package/types/src/filter-provider/filter-descriptor-utils.d.ts +0 -7
  62. package/types/src/filter-toggle-button/FilterToggleButton.d.ts +0 -9
  63. package/types/src/filter-utils.d.ts +0 -60
  64. package/types/src/index.d.ts +0 -24
  65. package/types/src/inline-filter/InlineFilter.d.ts +0 -12
  66. package/types/src/inline-filter/index.d.ts +0 -1
  67. package/types/src/inline-filter/useInlineFilter.d.ts +0 -5
  68. package/types/src/quick-filters/QuickFilters.d.ts +0 -17
  69. package/types/src/quick-filters/index.d.ts +0 -1
  70. package/types/src/quick-filters/useQuickFilters.d.ts +0 -12
  71. package/types/src/saved-filters/DeleteFilterPrompt.d.ts +0 -9
  72. package/types/src/saved-filters/FilterNamePrompt.d.ts +0 -6
  73. package/types/src/saved-filters/SavedFilterPanel.d.ts +0 -14
  74. package/types/src/saved-filters/useFilterNamePrompt.d.ts +0 -28
  75. package/types/src/saved-filters/useSavedFilterPanel.d.ts +0 -13
  76. package/types/src/tabbed-filter-container/TabbedFilterContainer.d.ts +0 -10
  77. package/types/src/toggle-filter/ToggleFilter.d.ts +0 -17
  78. package/types/src/toggle-filter/useToggleFilter.d.ts +0 -11
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "4.0.0-alpha.21",
2
+ "version": "4.0.0-alpha.23",
3
3
  "main": "./src/index.js",
4
4
  "author": "heswell",
5
5
  "license": "Apache-2.0",
@@ -10,19 +10,19 @@
10
10
  "type-defs": "node ../../scripts/build-type-defs.mjs"
11
11
  },
12
12
  "devDependencies": {
13
- "@vuu-ui/vuu-data-types": "4.0.0-alpha.21",
14
- "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.21",
15
- "@vuu-ui/vuu-table-types": "4.0.0-alpha.21",
16
- "@vuu-ui/vuu-filter-types": "4.0.0-alpha.21"
13
+ "@vuu-ui/vuu-data-types": "4.0.0-alpha.23",
14
+ "@vuu-ui/vuu-protocol-types": "4.0.0-alpha.23",
15
+ "@vuu-ui/vuu-table-types": "4.0.0-alpha.23",
16
+ "@vuu-ui/vuu-filter-types": "4.0.0-alpha.23"
17
17
  },
18
18
  "dependencies": {
19
- "@vuu-ui/vuu-context-menu": "4.0.0-alpha.21",
20
- "@vuu-ui/vuu-data-react": "4.0.0-alpha.21",
21
- "@vuu-ui/vuu-filter-parser": "4.0.0-alpha.21",
22
- "@vuu-ui/vuu-popups": "4.0.0-alpha.21",
23
- "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.21",
24
- "@vuu-ui/vuu-table": "4.0.0-alpha.21",
25
- "@vuu-ui/vuu-utils": "4.0.0-alpha.21",
19
+ "@vuu-ui/vuu-context-menu": "4.0.0-alpha.23",
20
+ "@vuu-ui/vuu-data-react": "4.0.0-alpha.23",
21
+ "@vuu-ui/vuu-filter-parser": "4.0.0-alpha.23",
22
+ "@vuu-ui/vuu-popups": "4.0.0-alpha.23",
23
+ "@vuu-ui/vuu-ui-controls": "4.0.0-alpha.23",
24
+ "@vuu-ui/vuu-table": "4.0.0-alpha.23",
25
+ "@vuu-ui/vuu-utils": "4.0.0-alpha.23",
26
26
  "@salt-ds/core": "1.72.0",
27
27
  "@salt-ds/styles": "0.4.1",
28
28
  "@salt-ds/window": "0.1.2"
@@ -28,7 +28,7 @@ const getValues = (defaultValueProp, valueProp)=>{
28
28
  };
29
29
  const classBase = "vuuToggleFilter";
30
30
  const NO_MATCHING_DATA = "No matching data";
31
- const ToggleFilter_ToggleFilter = /*#__PURE__*/ forwardRef(function({ className, column, defaultValue: defaultValueProp, labels, onCommit, table, value: valueProp, values, ...ToggleButtonGroupProps }, forwardedRef) {
31
+ const ToggleFilter_ToggleFilter = /*#__PURE__*/ forwardRef(function({ className, column, defaultValue: defaultValueProp, disableTypeahead, labels, onCommit, table, value: valueProp, values, ...ToggleButtonGroupProps }, forwardedRef) {
32
32
  const targetWindow = useWindow();
33
33
  useComponentCssInjection({
34
34
  testId: "vuu-toggle-filter",
@@ -40,6 +40,7 @@ const ToggleFilter_ToggleFilter = /*#__PURE__*/ forwardRef(function({ className,
40
40
  const stringValues = values.map(String);
41
41
  const { onlyAvailableValue, unavailableValues } = useToggleFilter({
42
42
  column,
43
+ disableTypeahead,
43
44
  table,
44
45
  values: stringValues
45
46
  });
@@ -12,7 +12,11 @@ const hasFilterOnColumn = (filterSpec, column)=>{
12
12
  const filter = filterSpec.filterStruct ?? parseFilter(filterSpec.filter);
13
13
  return void 0 !== extractFilterForColumn(filter, column);
14
14
  };
15
- const useToggleFilter = ({ column, table, values })=>{
15
+ const isNonStringColumn = (dataSource, column)=>{
16
+ const serverDataType = dataSource?.tableSchema?.columns.find((col)=>col.name === column)?.serverDataType;
17
+ return void 0 !== serverDataType && "string" !== serverDataType;
18
+ };
19
+ const useToggleFilter = ({ column, disableTypeahead = false, table, values })=>{
16
20
  const dataSource = useDataSource(false);
17
21
  const [typeaheadValues, setTypeaheadValues] = useState(void 0);
18
22
  const getSuggestions = useTypeaheadSuggestions();
@@ -24,7 +28,7 @@ const useToggleFilter = ({ column, table, values })=>{
24
28
  const tableModule = vuuTable?.module;
25
29
  const tableName = vuuTable?.table;
26
30
  const checkAvailability = useCallback(()=>{
27
- if (void 0 === tableModule || void 0 === tableName || void 0 === dataSource) return;
31
+ if (disableTypeahead || void 0 === tableModule || void 0 === tableName || void 0 === dataSource || isNonStringColumn(dataSource, column)) return;
28
32
  if (hasFilterOnColumn(dataSource.filter, column)) return;
29
33
  const requestId = ++requestIdRef.current;
30
34
  const params = [
@@ -42,6 +46,7 @@ const useToggleFilter = ({ column, table, values })=>{
42
46
  }, [
43
47
  column,
44
48
  dataSource,
49
+ disableTypeahead,
45
50
  getSuggestions,
46
51
  tableModule,
47
52
  tableName
@@ -65,6 +70,14 @@ const useToggleFilter = ({ column, table, values })=>{
65
70
  checkAvailability,
66
71
  dataSource
67
72
  ]);
73
+ useEffect(()=>{
74
+ if (disableTypeahead) {
75
+ requestIdRef.current += 1;
76
+ setTypeaheadValues(void 0);
77
+ }
78
+ }, [
79
+ disableTypeahead
80
+ ]);
68
81
  return useMemo(()=>{
69
82
  if (void 0 === typeaheadValues) return {
70
83
  unavailableValues: []
@@ -0,0 +1,8 @@
1
+ import type { ColumnFilterOp, ColumnFilterValue, FilterContainerFilter } from "@vuu-ui/vuu-filter-types";
2
+ import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
+ export type SelectableColumnFilterOp = Exclude<ColumnFilterOp, "in">;
4
+ export declare const getColumnFilterOperators: (column: ColumnDescriptor, operators?: readonly SelectableColumnFilterOp[]) => readonly SelectableColumnFilterOp[];
5
+ export declare const getDefaultColumnFilterOperator: (operators: readonly SelectableColumnFilterOp[], operator?: ColumnFilterOp) => SelectableColumnFilterOp;
6
+ export declare const getColumnFilterOperator: (column: ColumnDescriptor, filter?: FilterContainerFilter) => SelectableColumnFilterOp | undefined;
7
+ export declare const getColumnFilterClause: (column: ColumnDescriptor, filter?: FilterContainerFilter) => FilterContainerFilter | undefined;
8
+ export declare const normalizeColumnFilterValue: (operator: ColumnFilterOp, value?: ColumnFilterValue) => ColumnFilterValue;
@@ -12,6 +12,9 @@ type Value = ToggleButtonGroupProps["value"];
12
12
  * values from dataSource.
13
13
  * With neither of these Providers available, the ToggleFilter is
14
14
  * behaving like a regular ToggleButtonGroup.
15
+ * Validation of values uses the typeahead service, which only supports
16
+ * string columns. It can be disabled with disableTypeahead and is always
17
+ * disabled for a non-string (e.g. boolean or numeric) column.
15
18
  */
16
19
  export interface ToggleFilterProps extends Omit<ToggleButtonGroupProps, "defaultValue" | "value">, Omit<ToggleFilterHookProps, "values"> {
17
20
  defaultValue?: ToggleFilterValue | Value;
@@ -1,6 +1,14 @@
1
1
  import type { TableSchemaTable } from "@vuu-ui/vuu-data-types";
2
2
  export interface ToggleFilterHookProps {
3
3
  column: string;
4
+ /**
5
+ * Typeahead is used to determine which toggle values have matching
6
+ * data. Set disableTypeahead to opt out of this check, all values
7
+ * will then be treated as available. Typeahead only supports string
8
+ * lookups, so it is always disabled if the serverDataType of column
9
+ * (from the DataSource tableSchema) is anything other than string.
10
+ */
11
+ disableTypeahead?: boolean;
4
12
  /**
5
13
  * table must be provided to enable validation
6
14
  * of values using server data.
@@ -26,4 +34,4 @@ export interface ToggleFilterHookResult {
26
34
  * and the result of the last check (if any) is retained. If there has
27
35
  * been no check, all values are assumed to possibly have data.
28
36
  */
29
- export declare const useToggleFilter: ({ column, table, values, }: ToggleFilterHookProps) => ToggleFilterHookResult;
37
+ export declare const useToggleFilter: ({ column, disableTypeahead, table, values, }: ToggleFilterHookProps) => ToggleFilterHookResult;
@@ -1,28 +0,0 @@
1
- import { ColumnFilterValue, ExtendedFilterOptions, FilterClauseOp, FilterContainerFilter } from "@vuu-ui/vuu-filter-types";
2
- import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
- /**
4
- * Manages a filter that can be updated one clause at a time.
5
- * Works with FilterContainer to aggregate multiple filter
6
- * clauses edited via individual controls. It is just a wrapper
7
- * around a Map, does not support switching filters - create a
8
- * new FilterAggregator for a new filter.
9
- *
10
- */
11
- export declare class FilterAggregator {
12
- #private;
13
- constructor(filter?: FilterContainerFilter);
14
- add(column: ColumnDescriptor, value: ColumnFilterValue, op?: FilterClauseOp | "between" | "between-inclusive", extendedFilterOptions?: ExtendedFilterOptions): void;
15
- has({ name }: ColumnDescriptor): boolean;
16
- get({ name }: ColumnDescriptor): FilterContainerFilter | undefined;
17
- clear(): void;
18
- /**
19
- * Remove filter for this column. Return false if no filter found, otw true
20
- */
21
- remove(column: ColumnDescriptor): boolean;
22
- get isEmpty(): boolean;
23
- /**
24
- * Count of the number of columns for which filters are stored
25
- */
26
- get count(): number;
27
- get filter(): FilterContainerFilter | undefined;
28
- }
@@ -1,44 +0,0 @@
1
- import { Filter, FilterClause, FilterClauseOp, FilterCombinatorOp } from "@vuu-ui/vuu-filter-types";
2
- import { EventEmitter } from "@vuu-ui/vuu-utils";
3
- export type FilterStatusChangeHandler = (isValid: boolean) => void;
4
- export type FilterChangeHandler = (filter: Partial<Filter>, isValid: boolean) => void;
5
- export type FilterClauseChangeHandler = (filter: Partial<FilterClause>, isValid: boolean) => void;
6
- export type FilterClauseModelEvents = {
7
- filterClause: FilterClauseChangeHandler;
8
- isValid: FilterStatusChangeHandler;
9
- };
10
- export type FilterModelEvents = {
11
- filter: FilterChangeHandler;
12
- isValid: FilterStatusChangeHandler;
13
- };
14
- export declare class FilterClauseModel extends EventEmitter<FilterClauseModelEvents> {
15
- #private;
16
- constructor(filterClause: Partial<FilterClause>);
17
- get isValid(): boolean;
18
- private setIsValid;
19
- get column(): undefined | string;
20
- set column(column: undefined | string);
21
- get op(): "in" | import("@vuu-ui/vuu-filter-types").SingleValueFilterClauseOp | undefined;
22
- setOp(op: undefined | FilterClauseOp): void;
23
- setValue(value: undefined | string | string[] | number | number[] | boolean | boolean[], isFinal?: boolean): void;
24
- asFilter(throwIfInvalid?: boolean): FilterClause;
25
- commit(): void;
26
- }
27
- export declare class FilterModel extends EventEmitter<FilterModelEvents> {
28
- #private;
29
- constructor(filter?: Filter);
30
- get isValid(): boolean;
31
- private setIsValid;
32
- addNewFilterClause(operator?: FilterCombinatorOp): void;
33
- addFilterClause(filterClause?: Partial<FilterClause>): void;
34
- removeFilterClause(filterClause: FilterClauseModel): void;
35
- checkValidStatus(): void;
36
- onFilterClauseChange: FilterChangeHandler;
37
- onFilterClauseStatusChange: (isValid: boolean) => void;
38
- getFilterClause(index: number): FilterClauseModel;
39
- get op(): FilterCombinatorOp | undefined;
40
- setOp(op: FilterCombinatorOp): void;
41
- get filterClauses(): FilterClauseModel[];
42
- get isMultiClauseFilter(): boolean;
43
- asFilter(throwIfInvalid?: boolean): Filter;
44
- }
@@ -1,6 +0,0 @@
1
- import { type SegmentedButtonGroupProps } from "@salt-ds/core";
2
- import { DataItemEditControlProps } from "@vuu-ui/vuu-data-react";
3
- import { ColumnFilterHookProps } from "./useColumnFilter";
4
- export interface ColumnFilterProps extends ColumnFilterHookProps, Omit<SegmentedButtonGroupProps, "defaultValue">, Pick<DataItemEditControlProps, "TypeaheadProps" | "table" | "values" | "variant"> {
5
- }
6
- export declare const ColumnFilter: import("react").ForwardRefExoticComponent<ColumnFilterProps & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,43 +0,0 @@
1
- import { ColumnFilterChangeHandler, ColumnFilterCommitHandler, ColumnFilterOp, ColumnFilterValue, ExtendedFilterOptions } from "@vuu-ui/vuu-filter-types";
2
- import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
- import { InputProps } from "@salt-ds/core";
4
- import { CommitHandler } from "@vuu-ui/vuu-utils";
5
- import { DataItemEditControlProps } from "@vuu-ui/vuu-data-react";
6
- export interface ColumnFilterHookProps extends Pick<DataItemEditControlProps, "InputProps"> {
7
- column: ColumnDescriptor;
8
- /**
9
- * Filter defaultValue. Pair of values expected when operator is
10
- * 'between'. If provided, component is uncontrolled
11
- */
12
- defaultValue?: ColumnFilterValue;
13
- /**
14
- * Provides for custom filters.
15
- */
16
- extendedFilterOptions?: ExtendedFilterOptions;
17
- /**
18
- * Filter change events.
19
- */
20
- onColumnFilterChange?: ColumnFilterChangeHandler;
21
- /**
22
- * Filter change events on second control in range filter
23
- */
24
- onColumnRangeFilterChange?: ColumnFilterChangeHandler;
25
- /**
26
- * Called when user 'commits' filter value, either by pressing enter,
27
- * tabbing away from control or making selection from list
28
- */
29
- onCommit: ColumnFilterCommitHandler;
30
- operator?: ColumnFilterOp;
31
- /**
32
- * Filter value. Pair of values expected when operator is
33
- * 'between'. If provided, component is controlled.
34
- */
35
- value?: ColumnFilterValue;
36
- }
37
- export declare const useColumnFilter: ({ InputProps: InputPropsProp, column, defaultValue, extendedFilterOptions, onColumnFilterChange, onColumnRangeFilterChange, onCommit, operator, value: valueProp, }: ColumnFilterHookProps) => {
38
- InputProps: InputProps;
39
- InputPropsRange: InputProps;
40
- isInvalid: boolean;
41
- onCommit: CommitHandler<HTMLElement>;
42
- onCommitRange: CommitHandler<HTMLElement>;
43
- };
@@ -1,4 +0,0 @@
1
- import { Filter } from "@vuu-ui/vuu-filter-types";
2
- export declare const isStartsWithValue: (value: string) => boolean;
3
- export declare const getTypeaheadFilter: (column: string, filterValues: string[], isStartsWithFilter?: boolean) => Filter | undefined;
4
- export declare const getRangeFilter: (column: string, startValue?: number, endValue?: number) => Filter | undefined;
@@ -1,7 +0,0 @@
1
- import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
2
- import { HTMLAttributes } from "react";
3
- import { type FilterBarProps } from "../filter-bar";
4
- export interface CustomFilterProps extends HTMLAttributes<HTMLDivElement>, Pick<FilterBarProps, "defaultFilterState" | "filterState" | "onApplyFilter" | "onClearFilter" | "onFilterDeleted" | "onFilterRenamed" | "onFilterStateChanged" | "vuuTable"> {
5
- columnDescriptors: readonly ColumnDescriptor[];
6
- }
7
- export declare const CustomFilters: ({ columnDescriptors, defaultFilterState, filterState, onApplyFilter, onClearFilter, onFilterDeleted, onFilterRenamed, onFilterStateChanged, vuuTable, }: CustomFilterProps) => import("react").JSX.Element;
@@ -1 +0,0 @@
1
- export declare const navigateToNextItem: (el: HTMLElement | EventTarget, direction?: "bwd" | "fwd") => void;
@@ -1 +0,0 @@
1
- export * from "./CustomFilters";
@@ -1,33 +0,0 @@
1
- import { ColumnDescriptorsByName, Filter } from "@vuu-ui/vuu-filter-types";
2
- import { PromptProps } from "@vuu-ui/vuu-ui-controls";
3
- import { KeyboardEventHandler, RefObject } from "react";
4
- import { FilterBarProps } from "../filter-bar";
5
- import { FilterEditCancelHandler, FilterEditSaveHandler } from "../filter-editor";
6
- import { FilterPillProps } from "../filter-pill";
7
- export type EditFilterState = "create" | "edit";
8
- export type FilterState = EditFilterState | "rename";
9
- export declare const isEditFilterState: (filterState?: string) => filterState is EditFilterState;
10
- type InteractedFilterState = {
11
- filter?: Filter;
12
- index: number;
13
- state: FilterState;
14
- };
15
- export interface CustomFilterHookProps extends Pick<FilterBarProps, "columnDescriptors" | "defaultFilterState" | "filterState" | "onApplyFilter" | "onClearFilter" | "onFilterDeleted" | "onFilterRenamed" | "onFilterStateChanged"> {
16
- containerRef: RefObject<HTMLDivElement | null>;
17
- }
18
- export declare const useCustomFilters: ({ columnDescriptors, containerRef, defaultFilterState, filterState, onApplyFilter, onClearFilter, onFilterDeleted, onFilterRenamed, onFilterStateChanged, }: CustomFilterHookProps) => {
19
- FilterPillProps: Omit<FilterPillProps, "filter" | "selected">;
20
- activeFilterIndex: number[];
21
- addButtonProps: {
22
- ref: RefObject<HTMLButtonElement | null>;
23
- onClick: () => void;
24
- onKeyDown: KeyboardEventHandler;
25
- };
26
- columnsByName: ColumnDescriptorsByName;
27
- filters: Filter[];
28
- interactedFilterState: InteractedFilterState | undefined;
29
- onCancelEdit: FilterEditCancelHandler;
30
- onSave: FilterEditSaveHandler;
31
- promptProps: PromptProps | null;
32
- };
33
- export {};
@@ -1,17 +0,0 @@
1
- import { Filter, FilterState } from "@vuu-ui/vuu-filter-types";
2
- export interface FiltersHookProps {
3
- defaultFilterState?: FilterState;
4
- filterState?: FilterState;
5
- onFilterDeleted?: (filter: Filter) => void;
6
- onFilterRenamed?: (filter: Filter, name: string) => void;
7
- onFilterStateChanged?: (s: FilterState) => void;
8
- }
9
- export declare const useFilterState: ({ defaultFilterState, onFilterDeleted, onFilterRenamed, onFilterStateChanged, filterState: filterStateProp, }: FiltersHookProps) => {
10
- activeFilterIndex: number[];
11
- filters: Filter[];
12
- onToggleFilterActive: (filterIndex: number, preserveRemainingFilters?: boolean) => void;
13
- onAddFilter: (filter: Filter) => number;
14
- onChangeFilter: (oldFilter: Filter, newFilter: Filter) => number;
15
- onDeleteFilter: (filter: Filter) => number;
16
- onRenameFilter: (filter: Filter, name: string) => number;
17
- };
@@ -1,33 +0,0 @@
1
- import { Filter, FilterHandler, FilterState } from "@vuu-ui/vuu-filter-types";
2
- import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
- import { HTMLAttributes } from "react";
4
- import { QuickFilterProps } from "../quick-filters";
5
- import { FilterMode } from "./useFilterBar";
6
- import type { VuuTable } from "@vuu-ui/vuu-protocol-types";
7
- export type FilterBarVariant = "custom-filters-only" | "quick-filters-only" | "full-filters";
8
- export interface FilterBarProps extends HTMLAttributes<HTMLDivElement> {
9
- QuickFilterProps?: Pick<QuickFilterProps, "quickFilterColumns" | "onChangeQuickFilterColumns">;
10
- /**
11
- * Used to ensure we present filter editors appropriate to the data type of column.
12
- * NOTE: Always make sure that these are passed with proper re-render optimization (i.e make
13
- * sure its a stable reference, in React terminology), otherwise might end up with infinite
14
- * state updates.
15
- */
16
- columnDescriptors: readonly ColumnDescriptor[];
17
- defaultFilterMode?: FilterMode;
18
- defaultFilterState?: FilterState;
19
- filterMode?: FilterMode;
20
- filterState?: FilterState;
21
- onApplyFilter: FilterHandler;
22
- onChangeFilterMode?: (filterMode: FilterMode) => void;
23
- onClearFilter: () => void;
24
- onFilterDeleted?: FilterHandler;
25
- onFilterRenamed?: (filter: Filter, name: string) => void;
26
- onFilterStateChanged?: (state: FilterState) => void;
27
- /**
28
- * Defines table used in call to Vuu Typeahead service
29
- */
30
- vuuTable?: VuuTable;
31
- variant?: FilterBarVariant;
32
- }
33
- export declare const FilterBar: ({ QuickFilterProps, className: classNameProp, columnDescriptors, defaultFilterMode, defaultFilterState, filterMode: filterModeProp, filterState, onApplyFilter, onChangeFilterMode: onChangeFilterModeProp, onClearFilter, onFilterDeleted, onFilterRenamed, onFilterStateChanged, vuuTable, variant, ...htmlAttributes }: FilterBarProps) => import("react").JSX.Element;
@@ -1 +0,0 @@
1
- export declare const FilterBarMenu: () => import("react").JSX.Element;
@@ -1,2 +0,0 @@
1
- export * from "./FilterBar";
2
- export type { FilterMode } from "./useFilterBar";
@@ -1,7 +0,0 @@
1
- import { SyntheticEvent } from "react";
2
- import { FilterBarProps } from "./FilterBar";
3
- export type FilterMode = "custom-filter" | "quick-filter";
4
- export declare const useFilterBar: ({ defaultFilterMode, filterMode: filterModeProp, onChangeFilterMode, }: Pick<FilterBarProps, "defaultFilterMode" | "filterMode" | "onChangeFilterMode">) => {
5
- filterMode: FilterMode;
6
- onChangeFilterMode: (e: SyntheticEvent<HTMLButtonElement>) => void;
7
- };
@@ -1,10 +0,0 @@
1
- import { ComboBoxProps } from "@salt-ds/core";
2
- import { ReactElement, Ref } from "react";
3
- export interface ExpandoComboboxProps<Item = string> extends Omit<ComboBoxProps<Item>, "onOpenChange"> {
4
- itemToString?: (item: Item) => string;
5
- dropdownOnAutofocus?: boolean;
6
- onOpenChange?: (open: boolean, reason?: "manual" | "input" | "focus") => void;
7
- }
8
- export declare const ExpandoCombobox: <Item = string>(props: ExpandoComboboxProps<Item> & {
9
- ref?: Ref<HTMLDivElement>;
10
- }) => ReactElement;
@@ -1,16 +0,0 @@
1
- import { ColumnDescriptorsByName } from "@vuu-ui/vuu-filter-types";
2
- import { HTMLAttributes } from "react";
3
- import { FilterClauseModel } from "../FilterModel";
4
- import { VuuTable } from "@vuu-ui/vuu-protocol-types";
5
- export type FilterClauseCancelType = "Backspace" | "Escape";
6
- export type FilterClauseCancelHandler = (filterClause: FilterClauseModel, reason: FilterClauseCancelType) => void;
7
- export interface FilterClauseProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange"> {
8
- columnsByName: ColumnDescriptorsByName;
9
- filterClauseModel: FilterClauseModel;
10
- onCancel?: FilterClauseCancelHandler;
11
- onDropdownOpen?: () => void;
12
- onFocusSave?: () => void;
13
- dropdownOnAutofocus?: boolean;
14
- vuuTable: VuuTable;
15
- }
16
- export declare const FilterClause: ({ className, columnsByName, onCancel, onDropdownOpen, onFocusSave, filterClauseModel, vuuTable, dropdownOnAutofocus, ...htmlAttributes }: FilterClauseProps) => import("react").JSX.Element;
@@ -1,13 +0,0 @@
1
- import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
2
- import { ComboBoxProps } from "@salt-ds/core";
3
- import { SyntheticEvent } from "react";
4
- export type ColumnPickerProps = Pick<ComboBoxProps, "className" | "inputProps" | "value"> & {
5
- columns: readonly ColumnDescriptor[];
6
- onSelect: (evt: SyntheticEvent, columnName: string) => void;
7
- dropdownOnAutofocus?: boolean;
8
- };
9
- export declare const ColumnPicker: import("react").ForwardRefExoticComponent<Pick<ComboBoxProps<string>, "className" | "inputProps" | "value"> & {
10
- columns: readonly ColumnDescriptor[];
11
- onSelect: (evt: SyntheticEvent, columnName: string) => void;
12
- dropdownOnAutofocus?: boolean;
13
- } & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,11 +0,0 @@
1
- import { ChangeEvent, SyntheticEvent } from "react";
2
- export declare const useColumnPicker: ({ onSelect, value: valueProp, }: {
3
- onSelect: (evt: SyntheticEvent, columnName: string) => void;
4
- value: string;
5
- }) => {
6
- onChange: (event: ChangeEvent<HTMLInputElement>) => void;
7
- onOpenChange: (isOpen: boolean, reason?: "manual" | "input" | "focus") => void;
8
- onSelectionChange: (evt: SyntheticEvent, [newSelected]: string[]) => void;
9
- ref: import("react").RefObject<HTMLDivElement | null>;
10
- value: string;
11
- };
@@ -1,15 +0,0 @@
1
- import { KeyboardEvent } from "react";
2
- type FilterClauseFieldName = "column" | "operator" | "value";
3
- export declare const getFocusedFieldDetails: () => [number, string] | [];
4
- export declare const elementIsFilterCombinator: (element: Element | null) => element is HTMLElement;
5
- export declare const elementIsFilterClause: (element: Element | null) => element is HTMLElement;
6
- export declare const focusFilterClauseField: (filterEditor: HTMLElement, filterClauseIndex: number, fieldName?: FilterClauseFieldName) => void;
7
- export declare const focusLastClauseValue: (filterEditor: HTMLElement) => void;
8
- export declare const focusNextFocusableElement: (direction?: "fwd" | "bwd") => void;
9
- export declare const focusNextElement: () => void;
10
- export declare const clauseIsNotFirst: (el: HTMLElement) => boolean | undefined;
11
- export declare const tabToPreviousFilterCombinator: (currentElement: HTMLElement) => void;
12
- export declare const navigateToNextFilterClause: (currentElement: HTMLElement, direction?: "bwd" | "fwd") => void;
13
- export declare const navigateToNextItemIfAtBoundary: (evt: KeyboardEvent<HTMLInputElement>) => void;
14
- export declare const focusFirstClauseIfAllClausesValid: (filterEditor: HTMLElement) => void;
15
- export {};
@@ -1,12 +0,0 @@
1
- import type { TableSchemaTable } from "@vuu-ui/vuu-data-types";
2
- import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
- import type { InputProps } from "@salt-ds/core";
4
- import type { FilterClauseValueChangeHandler } from "./useFilterClause";
5
- export interface FilterClauseValueEditor {
6
- inputProps?: InputProps["inputProps"];
7
- column: ColumnDescriptor;
8
- onDeselect?: () => void;
9
- onChangeValue: FilterClauseValueChangeHandler;
10
- onOpenChange?: (open: boolean, reason?: "input" | "manual" | "focus") => void;
11
- table?: TableSchemaTable;
12
- }
@@ -1,5 +0,0 @@
1
- export * from "./column-picker/ColumnPicker";
2
- export { OperatorPicker } from "./operator-picker/OperatorPicker";
3
- export * from "./ExpandoCombobox";
4
- export * from "./FilterClause";
5
- export * from "./value-editors/FilterClauseValueEditorText";
@@ -1,14 +0,0 @@
1
- import type { FilterClauseOp } from "@vuu-ui/vuu-filter-types";
2
- import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
3
- import { ComboBoxProps } from "@salt-ds/core";
4
- import { SyntheticEvent } from "react";
5
- export type OperatorPickerProps = Pick<ComboBoxProps, "className" | "inputProps" | "value"> & {
6
- column: ColumnDescriptor;
7
- onSelect: (evt: SyntheticEvent, operator: FilterClauseOp) => void;
8
- dropdownOnAutofocus?: boolean;
9
- };
10
- export declare const OperatorPicker: import("react").ForwardRefExoticComponent<Pick<ComboBoxProps<string>, "className" | "inputProps" | "value"> & {
11
- column: ColumnDescriptor;
12
- onSelect: (evt: SyntheticEvent, operator: FilterClauseOp) => void;
13
- dropdownOnAutofocus?: boolean;
14
- } & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,5 +0,0 @@
1
- import type { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
2
- import type { FilterClauseOp, NumericFilterClauseOp } from "@vuu-ui/vuu-filter-types";
3
- export declare const textOperators: FilterClauseOp[];
4
- export declare const numericOperators: NumericFilterClauseOp[];
5
- export declare const getOperators: (column: ColumnDescriptor) => FilterClauseOp[];
@@ -1,12 +0,0 @@
1
- import { ChangeEvent, SyntheticEvent } from "react";
2
- import { FilterClauseOp } from "@vuu-ui/vuu-filter-types";
3
- export declare const useOperatorPicker: ({ onSelect, value: valueProp, }: {
4
- onSelect: (evt: SyntheticEvent, op: FilterClauseOp) => void;
5
- value: string;
6
- }) => {
7
- onChange: (event: ChangeEvent<HTMLInputElement>) => void;
8
- onOpenChange: (isOpen: boolean, reason?: "manual" | "input" | "focus") => void;
9
- onSelectionChange: (evt: SyntheticEvent, [newSelected]: FilterClauseOp[]) => void;
10
- ref: import("react").RefObject<HTMLDivElement | null>;
11
- value: string;
12
- };
@@ -1,26 +0,0 @@
1
- import { FilterClause, FilterClauseOp } from "@vuu-ui/vuu-filter-types";
2
- import { KeyboardEvent, RefCallback, SyntheticEvent } from "react";
3
- import { FilterClauseProps } from "./FilterClause";
4
- export type FilterClauseEditorHookProps = Pick<FilterClauseProps, "columnsByName" | "filterClauseModel" | "onCancel" | "onFocusSave"> & {
5
- onOpenChange?: (open: boolean, reason?: "focus" | "input" | "manual") => void;
6
- dropdownOnAutofocus?: boolean;
7
- };
8
- export type FilterClauseValueChangeHandler = (value: string | string[] | number | number[], isFinal?: boolean) => void;
9
- export declare const useFilterClause: ({ filterClauseModel, onCancel, columnsByName, onFocusSave, onOpenChange, dropdownOnAutofocus, }: FilterClauseEditorHookProps) => {
10
- inputProps: {
11
- onKeyDownCapture: (evt: KeyboardEvent<HTMLInputElement>) => void;
12
- tabIndex: number;
13
- onFocus: () => true;
14
- };
15
- columnRef: import("react").RefObject<HTMLDivElement | null>;
16
- filterClause: Partial<FilterClause>;
17
- onChangeValue: FilterClauseValueChangeHandler;
18
- onDeselectValue: () => void;
19
- onSelectColumn: (evt: SyntheticEvent, selectedColumn: string) => void;
20
- onSelectOperator: (_: SyntheticEvent, selectedOp: FilterClauseOp) => void;
21
- onOpenChange: (open: boolean, closeReason?: "focus" | "input" | "manual") => void;
22
- operatorRef: import("react").RefObject<HTMLDivElement | null>;
23
- selectedColumn: import("@vuu-ui/vuu-table-types").ColumnDescriptor;
24
- valueRef: RefCallback<HTMLDivElement>;
25
- showDropdownOnAutoFocus: boolean;
26
- };
@@ -1,26 +0,0 @@
1
- import { TableSchemaTable } from "@vuu-ui/vuu-data-types";
2
- import { SingleValueFilterClauseOp } from "@vuu-ui/vuu-filter-types";
3
- export declare const FilterClauseValueEditor: import("react").ForwardRefExoticComponent<Pick<{
4
- inputProps: {
5
- onKeyDownCapture: (evt: import("react").KeyboardEvent<HTMLInputElement>) => void;
6
- tabIndex: number;
7
- onFocus: () => true;
8
- };
9
- columnRef: import("react").RefObject<HTMLDivElement | null>;
10
- filterClause: Partial<import("@vuu-ui/vuu-filter-types").FilterClause>;
11
- onChangeValue: import("../useFilterClause").FilterClauseValueChangeHandler;
12
- onDeselectValue: () => void;
13
- onSelectColumn: (evt: import("react").SyntheticEvent, selectedColumn: string) => void;
14
- onSelectOperator: (_: import("react").SyntheticEvent, selectedOp: import("@vuu-ui/vuu-filter-types").FilterClauseOp) => void;
15
- onOpenChange: (open: boolean, closeReason?: "focus" | "input" | "manual") => void;
16
- operatorRef: import("react").RefObject<HTMLDivElement | null>;
17
- selectedColumn: import("@vuu-ui/vuu-table-types").ColumnDescriptor;
18
- valueRef: import("react").RefCallback<HTMLDivElement>;
19
- showDropdownOnAutoFocus: boolean;
20
- }, "inputProps" | "onChangeValue" | "onDeselectValue" | "onOpenChange" | "selectedColumn"> & {
21
- table?: TableSchemaTable;
22
- } & {
23
- operator?: SingleValueFilterClauseOp | "in";
24
- value?: string | string[] | number | number[] | boolean | boolean[];
25
- dropdownOnAutofocus?: boolean;
26
- } & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,9 +0,0 @@
1
- import type { NumericFilterClauseOp } from "@vuu-ui/vuu-filter-types";
2
- import type { FilterClauseValueEditor } from "../filterClauseTypes";
3
- interface FilterClauseValueEditorDateProps extends Pick<FilterClauseValueEditor, "onChangeValue" | "inputProps"> {
4
- className?: string;
5
- value: number | undefined;
6
- operator: NumericFilterClauseOp;
7
- }
8
- export declare const FilterClauseValueEditorDate: (props: FilterClauseValueEditorDateProps) => import("react").JSX.Element;
9
- export {};
@@ -1,9 +0,0 @@
1
- import { HTMLAttributes, RefObject } from "react";
2
- import { FilterClauseValueEditor } from "../filterClauseTypes";
3
- export interface FilterClauseNumericValueEditorProps extends FilterClauseValueEditor, HTMLAttributes<HTMLDivElement> {
4
- "data-field"?: string;
5
- operatorInputRef?: RefObject<HTMLInputElement>;
6
- operator: string;
7
- value?: number;
8
- }
9
- export declare const FilterClauseValueEditorNumber: import("react").ForwardRefExoticComponent<FilterClauseNumericValueEditorProps & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,9 +0,0 @@
1
- import { HTMLAttributes } from "react";
2
- import { FilterClauseValueEditor } from "../filterClauseTypes";
3
- export interface FilterClauseTextValueEditorProps extends FilterClauseValueEditor, HTMLAttributes<HTMLDivElement> {
4
- "data-field"?: string;
5
- operator: string;
6
- value: string | string[];
7
- dropdownOnAutofocus?: boolean;
8
- }
9
- export declare const FilterClauseValueEditorText: import("react").ForwardRefExoticComponent<FilterClauseTextValueEditorProps & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,9 +0,0 @@
1
- import { NumericFilterClauseOp } from "@vuu-ui/vuu-filter-types";
2
- import { FilterClauseValueEditor } from "../filterClauseTypes";
3
- interface FilterClauseValueEditorTimeProps extends Pick<FilterClauseValueEditor, "onChangeValue" | "inputProps"> {
4
- className?: string;
5
- value: number | undefined;
6
- operator: NumericFilterClauseOp;
7
- }
8
- export declare const FilterClauseValueEditorTime: (props: FilterClauseValueEditorTimeProps) => import("react").JSX.Element;
9
- export {};