@trackunit/filters-filter-bar 1.8.177 → 1.8.180
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs.js +35 -76
- package/index.esm.js +35 -76
- package/package.json +12 -12
- package/src/lib/FilterBar.d.ts +2 -1
- package/src/lib/components/AppliedFiltersRenderer.d.ts +2 -1
- package/src/lib/components/DefaultCheckboxFilter.d.ts +2 -1
- package/src/lib/components/DefaultDateRangeFilter.d.ts +2 -1
- package/src/lib/components/FilterButtonTooltipLabel.d.ts +2 -1
- package/src/lib/components/FilterOptionsResults.d.ts +1 -1
- package/src/lib/components/FilterResults.d.ts +1 -1
- package/src/lib/components/FiltersMenuContent.d.ts +2 -1
- package/src/lib/components/HierarchicalCheckboxFilter/HierarchicalCheckboxFilter.d.ts +2 -1
- package/src/lib/components/HierarchicalCheckboxFilter/RenderHierarchicalOption.d.ts +2 -1
- package/src/lib/components/HierarchicalCheckboxFilter/useHierarchicalOptionState.d.ts +6 -5
- package/src/lib/hooks/useFiltersMenu.d.ts +13 -11
- package/src/lib/hooks/useSearchParamAsFilter.d.ts +2 -2
- package/src/lib/hooks/utils/useFilterBarActions.d.ts +8 -4
- package/src/lib/hooks/utils/useFilterBarPersistence.d.ts +9 -3
- package/src/lib/hooks/utils/useFilterUrlSync.d.ts +8 -1
- package/src/lib/hooks/utils/useGenericSetValue.d.ts +6 -4
- package/src/lib/hooks/utils/useIsDefaultValue.d.ts +7 -5
- package/src/lib/hooks/utils/useSearchUtils.d.ts +6 -4
- package/src/lib/utils/createFilterValues.d.ts +2 -2
- package/src/translation.d.ts +4 -7
package/index.cjs.js
CHANGED
|
@@ -1386,45 +1386,48 @@ const FilterBar = ({ hiddenFilters, className, filterBarDefinition, filterBarCon
|
|
|
1386
1386
|
return (jsxRuntime.jsx(FiltersMenu, { allowShowFiltersDirectly: allowShowFiltersDirectly, className: className, compact: compact, "data-testid": `${filterBarConfig.name}-filterbar`, filterBarConfig: filterBarConfig, filterBarDefinition: filterBarDefinition, hiddenFilters: hiddenFilters, title: title }));
|
|
1387
1387
|
};
|
|
1388
1388
|
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
const doNothing = (args) => { };
|
|
1389
|
+
const returnFalse = () => false;
|
|
1390
|
+
const returnUndefined = () => undefined;
|
|
1392
1391
|
const mockFilterBar = {
|
|
1393
1392
|
filterBarConfig: {
|
|
1394
|
-
isFilterIncludedByKey:
|
|
1393
|
+
isFilterIncludedByKey: () => false,
|
|
1395
1394
|
appliedFilterKeys: () => [],
|
|
1396
|
-
arrayIncludesValue:
|
|
1397
|
-
getFilterTitle:
|
|
1398
|
-
getFilterBarName:
|
|
1395
|
+
arrayIncludesValue: () => false,
|
|
1396
|
+
getFilterTitle: key => key,
|
|
1397
|
+
getFilterBarName: () => "test",
|
|
1399
1398
|
initialState: { customerType: [] },
|
|
1400
1399
|
name: "test",
|
|
1401
|
-
isDefaultValue:
|
|
1402
|
-
objectArrayIncludesValue:
|
|
1403
|
-
resetFiltersToInitialState:
|
|
1404
|
-
resetIndividualFilterToInitialState:
|
|
1405
|
-
setArrayObjectValue:
|
|
1406
|
-
setArrayValue:
|
|
1407
|
-
setBooleanValue:
|
|
1408
|
-
setArea:
|
|
1409
|
-
setDateRange:
|
|
1410
|
-
setMinMaxValue:
|
|
1411
|
-
setNumberValue:
|
|
1412
|
-
setStringValue:
|
|
1413
|
-
toggleArrayObjectValue:
|
|
1414
|
-
toggleArrayValue:
|
|
1400
|
+
isDefaultValue: () => false,
|
|
1401
|
+
objectArrayIncludesValue: () => false,
|
|
1402
|
+
resetFiltersToInitialState: () => undefined,
|
|
1403
|
+
resetIndividualFilterToInitialState: () => undefined,
|
|
1404
|
+
setArrayObjectValue: () => undefined,
|
|
1405
|
+
setArrayValue: () => undefined,
|
|
1406
|
+
setBooleanValue: () => undefined,
|
|
1407
|
+
setArea: () => undefined,
|
|
1408
|
+
setDateRange: () => undefined,
|
|
1409
|
+
setMinMaxValue: () => undefined,
|
|
1410
|
+
setNumberValue: () => undefined,
|
|
1411
|
+
setStringValue: () => undefined,
|
|
1412
|
+
toggleArrayObjectValue: () => undefined,
|
|
1413
|
+
toggleArrayValue: () => undefined,
|
|
1415
1414
|
values: { customerType: [] },
|
|
1416
|
-
getValuesByKey:
|
|
1415
|
+
getValuesByKey: returnUndefined,
|
|
1417
1416
|
setters: {
|
|
1418
|
-
setCriticality:
|
|
1419
|
-
|
|
1417
|
+
setCriticality: callback => {
|
|
1418
|
+
callback(undefined);
|
|
1419
|
+
},
|
|
1420
|
+
setServicePlan: callback => {
|
|
1421
|
+
callback(undefined);
|
|
1422
|
+
},
|
|
1420
1423
|
},
|
|
1421
|
-
objectIncludesValue:
|
|
1422
|
-
setObjectValue:
|
|
1423
|
-
toggleObjectValue:
|
|
1424
|
+
objectIncludesValue: returnFalse,
|
|
1425
|
+
setObjectValue: () => undefined,
|
|
1426
|
+
toggleObjectValue: () => undefined,
|
|
1424
1427
|
},
|
|
1425
1428
|
filterBarDefinition: {},
|
|
1426
1429
|
name: "test",
|
|
1427
|
-
onValuesChange:
|
|
1430
|
+
onValuesChange: () => undefined,
|
|
1428
1431
|
};
|
|
1429
1432
|
|
|
1430
1433
|
/**
|
|
@@ -1630,10 +1633,10 @@ const validateFilter = ({ values, filterDefinitions, }) => {
|
|
|
1630
1633
|
};
|
|
1631
1634
|
|
|
1632
1635
|
/**
|
|
1633
|
-
* Generic hook for
|
|
1636
|
+
* Generic hook for checking if a filter value matches its default.
|
|
1634
1637
|
*
|
|
1635
1638
|
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
1636
|
-
* @returns {object} An object containing the
|
|
1639
|
+
* @returns {object} An object containing the isDefaultValue helper.
|
|
1637
1640
|
*/
|
|
1638
1641
|
const useIsDefaultValue = () => {
|
|
1639
1642
|
const isDefaultValue = react.useCallback((key, filterValue, filterBarDefinition, initialState) => {
|
|
@@ -1666,10 +1669,7 @@ const useIsDefaultValue = () => {
|
|
|
1666
1669
|
};
|
|
1667
1670
|
|
|
1668
1671
|
/**
|
|
1669
|
-
*
|
|
1670
|
-
*
|
|
1671
|
-
* @template TFilterBarDefinition - A generic type for the filter bar definition.
|
|
1672
|
-
* @returns {object} An object containing filter bar configuration and actions.
|
|
1672
|
+
* Hook that wires all filter map actions and getters for a filter bar definition.
|
|
1673
1673
|
*/
|
|
1674
1674
|
const useFilterBarActions = ({ name, filterBarConfig, filterBarDefinition, setFilterBarConfig, setValue, initialState, }) => {
|
|
1675
1675
|
const { isDefaultValue } = useIsDefaultValue();
|
|
@@ -2060,48 +2060,6 @@ const MAX_URL_LENGTH = 5000;
|
|
|
2060
2060
|
const getPersistenceKey = (name, clientSideUserId) => `filter-${name}-${clientSideUserId}`;
|
|
2061
2061
|
/**
|
|
2062
2062
|
* Custom hook for managing the persistence of filter bar configurations.
|
|
2063
|
-
*
|
|
2064
|
-
* This hook provides a complete state management solution for filter bars with automatic
|
|
2065
|
-
* URL synchronization and localStorage persistence. It maintains the following state:
|
|
2066
|
-
*
|
|
2067
|
-
* ## State Management Flow:
|
|
2068
|
-
*
|
|
2069
|
-
* 1. **Initial Load**:
|
|
2070
|
-
* - Loads from localStorage (if no custom loadData or saveData function is provided)
|
|
2071
|
-
* - Updates with state from URL search parameters
|
|
2072
|
-
* - Ensures URL is updated with the final state after load
|
|
2073
|
-
*
|
|
2074
|
-
* 2. **Save Operations**:
|
|
2075
|
-
* - Updates localStorage with new filter values
|
|
2076
|
-
* - Updates URL search parameters to reflect current state
|
|
2077
|
-
* - Maintains synchronization between localStorage and URL
|
|
2078
|
-
*
|
|
2079
|
-
* 3. **URL Change Detection**:
|
|
2080
|
-
* - Listens for changes in URL search parameters
|
|
2081
|
-
* - Compares URL state with last known state to detect external changes
|
|
2082
|
-
* - Triggers refreshData callback when external URL changes are detected
|
|
2083
|
-
* - Only updates URL when no custom loadData or saveData function provided
|
|
2084
|
-
*
|
|
2085
|
-
* ## Behavior Modes:
|
|
2086
|
-
*
|
|
2087
|
-
* **Default Mode** (no custom functions):
|
|
2088
|
-
* - Uses localStorage for persistence
|
|
2089
|
-
* - Automatically syncs with URL search parameters
|
|
2090
|
-
* - Handles URL updates and change detection
|
|
2091
|
-
*
|
|
2092
|
-
* **Custom Mode** (with loadData/saveData functions):
|
|
2093
|
-
* - Does NOT sync with URL or use localStorage
|
|
2094
|
-
* - Relies entirely on provided functions for persistence
|
|
2095
|
-
* - Does not provide URL change detection via refreshData callback
|
|
2096
|
-
*
|
|
2097
|
-
* The hook prevents infinite loops by:
|
|
2098
|
-
* - Tracking what state was last sent to the URL
|
|
2099
|
-
* - Only updating URL when state actually changes
|
|
2100
|
-
* - Distinguishing between internal state changes and external URL changes
|
|
2101
|
-
*
|
|
2102
|
-
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
2103
|
-
* @param {FilterBarPersistenceProps<TFilterBarDefinition>} props - The props for the filter bar persistence.
|
|
2104
|
-
* @returns { object } An object containing the loadData and saveData functions.
|
|
2105
2063
|
*/
|
|
2106
2064
|
const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue, loadData: inputLoadData, saveData: inputSaveData, }) => {
|
|
2107
2065
|
const { clientSideUserId } = reactCoreHooks.useCurrentUser();
|
|
@@ -2581,6 +2539,7 @@ const useSearchParamAsFilter = ({ filterName, search, zodSchema, errorHandler, }
|
|
|
2581
2539
|
zodParseError: null,
|
|
2582
2540
|
});
|
|
2583
2541
|
}
|
|
2542
|
+
return null;
|
|
2584
2543
|
}, [search, zodSchema, errorHandler, filterName]);
|
|
2585
2544
|
};
|
|
2586
2545
|
const captureUrlParseException = (errorHandler, { filterName, param, jsonParsed: parsed }) => errorHandler.captureException(new Error(JSON.stringify({
|
package/index.esm.js
CHANGED
|
@@ -1384,45 +1384,48 @@ const FilterBar = ({ hiddenFilters, className, filterBarDefinition, filterBarCon
|
|
|
1384
1384
|
return (jsx(FiltersMenu, { allowShowFiltersDirectly: allowShowFiltersDirectly, className: className, compact: compact, "data-testid": `${filterBarConfig.name}-filterbar`, filterBarConfig: filterBarConfig, filterBarDefinition: filterBarDefinition, hiddenFilters: hiddenFilters, title: title }));
|
|
1385
1385
|
};
|
|
1386
1386
|
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
const doNothing = (args) => { };
|
|
1387
|
+
const returnFalse = () => false;
|
|
1388
|
+
const returnUndefined = () => undefined;
|
|
1390
1389
|
const mockFilterBar = {
|
|
1391
1390
|
filterBarConfig: {
|
|
1392
|
-
isFilterIncludedByKey:
|
|
1391
|
+
isFilterIncludedByKey: () => false,
|
|
1393
1392
|
appliedFilterKeys: () => [],
|
|
1394
|
-
arrayIncludesValue:
|
|
1395
|
-
getFilterTitle:
|
|
1396
|
-
getFilterBarName:
|
|
1393
|
+
arrayIncludesValue: () => false,
|
|
1394
|
+
getFilterTitle: key => key,
|
|
1395
|
+
getFilterBarName: () => "test",
|
|
1397
1396
|
initialState: { customerType: [] },
|
|
1398
1397
|
name: "test",
|
|
1399
|
-
isDefaultValue:
|
|
1400
|
-
objectArrayIncludesValue:
|
|
1401
|
-
resetFiltersToInitialState:
|
|
1402
|
-
resetIndividualFilterToInitialState:
|
|
1403
|
-
setArrayObjectValue:
|
|
1404
|
-
setArrayValue:
|
|
1405
|
-
setBooleanValue:
|
|
1406
|
-
setArea:
|
|
1407
|
-
setDateRange:
|
|
1408
|
-
setMinMaxValue:
|
|
1409
|
-
setNumberValue:
|
|
1410
|
-
setStringValue:
|
|
1411
|
-
toggleArrayObjectValue:
|
|
1412
|
-
toggleArrayValue:
|
|
1398
|
+
isDefaultValue: () => false,
|
|
1399
|
+
objectArrayIncludesValue: () => false,
|
|
1400
|
+
resetFiltersToInitialState: () => undefined,
|
|
1401
|
+
resetIndividualFilterToInitialState: () => undefined,
|
|
1402
|
+
setArrayObjectValue: () => undefined,
|
|
1403
|
+
setArrayValue: () => undefined,
|
|
1404
|
+
setBooleanValue: () => undefined,
|
|
1405
|
+
setArea: () => undefined,
|
|
1406
|
+
setDateRange: () => undefined,
|
|
1407
|
+
setMinMaxValue: () => undefined,
|
|
1408
|
+
setNumberValue: () => undefined,
|
|
1409
|
+
setStringValue: () => undefined,
|
|
1410
|
+
toggleArrayObjectValue: () => undefined,
|
|
1411
|
+
toggleArrayValue: () => undefined,
|
|
1413
1412
|
values: { customerType: [] },
|
|
1414
|
-
getValuesByKey:
|
|
1413
|
+
getValuesByKey: returnUndefined,
|
|
1415
1414
|
setters: {
|
|
1416
|
-
setCriticality:
|
|
1417
|
-
|
|
1415
|
+
setCriticality: callback => {
|
|
1416
|
+
callback(undefined);
|
|
1417
|
+
},
|
|
1418
|
+
setServicePlan: callback => {
|
|
1419
|
+
callback(undefined);
|
|
1420
|
+
},
|
|
1418
1421
|
},
|
|
1419
|
-
objectIncludesValue:
|
|
1420
|
-
setObjectValue:
|
|
1421
|
-
toggleObjectValue:
|
|
1422
|
+
objectIncludesValue: returnFalse,
|
|
1423
|
+
setObjectValue: () => undefined,
|
|
1424
|
+
toggleObjectValue: () => undefined,
|
|
1422
1425
|
},
|
|
1423
1426
|
filterBarDefinition: {},
|
|
1424
1427
|
name: "test",
|
|
1425
|
-
onValuesChange:
|
|
1428
|
+
onValuesChange: () => undefined,
|
|
1426
1429
|
};
|
|
1427
1430
|
|
|
1428
1431
|
/**
|
|
@@ -1628,10 +1631,10 @@ const validateFilter = ({ values, filterDefinitions, }) => {
|
|
|
1628
1631
|
};
|
|
1629
1632
|
|
|
1630
1633
|
/**
|
|
1631
|
-
* Generic hook for
|
|
1634
|
+
* Generic hook for checking if a filter value matches its default.
|
|
1632
1635
|
*
|
|
1633
1636
|
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
1634
|
-
* @returns {object} An object containing the
|
|
1637
|
+
* @returns {object} An object containing the isDefaultValue helper.
|
|
1635
1638
|
*/
|
|
1636
1639
|
const useIsDefaultValue = () => {
|
|
1637
1640
|
const isDefaultValue = useCallback((key, filterValue, filterBarDefinition, initialState) => {
|
|
@@ -1664,10 +1667,7 @@ const useIsDefaultValue = () => {
|
|
|
1664
1667
|
};
|
|
1665
1668
|
|
|
1666
1669
|
/**
|
|
1667
|
-
*
|
|
1668
|
-
*
|
|
1669
|
-
* @template TFilterBarDefinition - A generic type for the filter bar definition.
|
|
1670
|
-
* @returns {object} An object containing filter bar configuration and actions.
|
|
1670
|
+
* Hook that wires all filter map actions and getters for a filter bar definition.
|
|
1671
1671
|
*/
|
|
1672
1672
|
const useFilterBarActions = ({ name, filterBarConfig, filterBarDefinition, setFilterBarConfig, setValue, initialState, }) => {
|
|
1673
1673
|
const { isDefaultValue } = useIsDefaultValue();
|
|
@@ -2058,48 +2058,6 @@ const MAX_URL_LENGTH = 5000;
|
|
|
2058
2058
|
const getPersistenceKey = (name, clientSideUserId) => `filter-${name}-${clientSideUserId}`;
|
|
2059
2059
|
/**
|
|
2060
2060
|
* Custom hook for managing the persistence of filter bar configurations.
|
|
2061
|
-
*
|
|
2062
|
-
* This hook provides a complete state management solution for filter bars with automatic
|
|
2063
|
-
* URL synchronization and localStorage persistence. It maintains the following state:
|
|
2064
|
-
*
|
|
2065
|
-
* ## State Management Flow:
|
|
2066
|
-
*
|
|
2067
|
-
* 1. **Initial Load**:
|
|
2068
|
-
* - Loads from localStorage (if no custom loadData or saveData function is provided)
|
|
2069
|
-
* - Updates with state from URL search parameters
|
|
2070
|
-
* - Ensures URL is updated with the final state after load
|
|
2071
|
-
*
|
|
2072
|
-
* 2. **Save Operations**:
|
|
2073
|
-
* - Updates localStorage with new filter values
|
|
2074
|
-
* - Updates URL search parameters to reflect current state
|
|
2075
|
-
* - Maintains synchronization between localStorage and URL
|
|
2076
|
-
*
|
|
2077
|
-
* 3. **URL Change Detection**:
|
|
2078
|
-
* - Listens for changes in URL search parameters
|
|
2079
|
-
* - Compares URL state with last known state to detect external changes
|
|
2080
|
-
* - Triggers refreshData callback when external URL changes are detected
|
|
2081
|
-
* - Only updates URL when no custom loadData or saveData function provided
|
|
2082
|
-
*
|
|
2083
|
-
* ## Behavior Modes:
|
|
2084
|
-
*
|
|
2085
|
-
* **Default Mode** (no custom functions):
|
|
2086
|
-
* - Uses localStorage for persistence
|
|
2087
|
-
* - Automatically syncs with URL search parameters
|
|
2088
|
-
* - Handles URL updates and change detection
|
|
2089
|
-
*
|
|
2090
|
-
* **Custom Mode** (with loadData/saveData functions):
|
|
2091
|
-
* - Does NOT sync with URL or use localStorage
|
|
2092
|
-
* - Relies entirely on provided functions for persistence
|
|
2093
|
-
* - Does not provide URL change detection via refreshData callback
|
|
2094
|
-
*
|
|
2095
|
-
* The hook prevents infinite loops by:
|
|
2096
|
-
* - Tracking what state was last sent to the URL
|
|
2097
|
-
* - Only updating URL when state actually changes
|
|
2098
|
-
* - Distinguishing between internal state changes and external URL changes
|
|
2099
|
-
*
|
|
2100
|
-
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
2101
|
-
* @param {FilterBarPersistenceProps<TFilterBarDefinition>} props - The props for the filter bar persistence.
|
|
2102
|
-
* @returns { object } An object containing the loadData and saveData functions.
|
|
2103
2061
|
*/
|
|
2104
2062
|
const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue, loadData: inputLoadData, saveData: inputSaveData, }) => {
|
|
2105
2063
|
const { clientSideUserId } = useCurrentUser();
|
|
@@ -2579,6 +2537,7 @@ const useSearchParamAsFilter = ({ filterName, search, zodSchema, errorHandler, }
|
|
|
2579
2537
|
zodParseError: null,
|
|
2580
2538
|
});
|
|
2581
2539
|
}
|
|
2540
|
+
return null;
|
|
2582
2541
|
}, [search, zodSchema, errorHandler, filterName]);
|
|
2583
2542
|
};
|
|
2584
2543
|
const captureUrlParseException = (errorHandler, { filterName, param, jsonParsed: parsed }) => errorHandler.captureException(new Error(JSON.stringify({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trackunit/filters-filter-bar",
|
|
3
|
-
"version": "1.8.
|
|
3
|
+
"version": "1.8.180",
|
|
4
4
|
"repository": "https://github.com/Trackunit/manager",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"engines": {
|
|
@@ -12,17 +12,17 @@
|
|
|
12
12
|
"tailwind-merge": "^2.0.0",
|
|
13
13
|
"string-ts": "^2.0.0",
|
|
14
14
|
"zod": "^3.23.8",
|
|
15
|
-
"@trackunit/iris-app-api": "1.10.
|
|
16
|
-
"@trackunit/react-core-hooks": "1.7.
|
|
17
|
-
"@trackunit/react-filter-components": "1.7.
|
|
18
|
-
"@trackunit/react-date-and-time-components": "1.10.
|
|
19
|
-
"@trackunit/shared-utils": "1.9.
|
|
20
|
-
"@trackunit/react-form-components": "1.8.
|
|
21
|
-
"@trackunit/iris-app-runtime-core-api": "1.7.
|
|
22
|
-
"@trackunit/geo-json-utils": "1.7.
|
|
23
|
-
"@trackunit/i18n-library-translation": "1.7.
|
|
24
|
-
"@trackunit/css-class-variance-utilities": "1.7.
|
|
25
|
-
"@trackunit/react-components": "1.10.
|
|
15
|
+
"@trackunit/iris-app-api": "1.10.12",
|
|
16
|
+
"@trackunit/react-core-hooks": "1.7.132",
|
|
17
|
+
"@trackunit/react-filter-components": "1.7.173",
|
|
18
|
+
"@trackunit/react-date-and-time-components": "1.10.173",
|
|
19
|
+
"@trackunit/shared-utils": "1.9.118",
|
|
20
|
+
"@trackunit/react-form-components": "1.8.170",
|
|
21
|
+
"@trackunit/iris-app-runtime-core-api": "1.7.128",
|
|
22
|
+
"@trackunit/geo-json-utils": "1.7.118",
|
|
23
|
+
"@trackunit/i18n-library-translation": "1.7.140",
|
|
24
|
+
"@trackunit/css-class-variance-utilities": "1.7.118",
|
|
25
|
+
"@trackunit/react-components": "1.10.94",
|
|
26
26
|
"@tanstack/react-router": "1.114.29"
|
|
27
27
|
},
|
|
28
28
|
"module": "./index.esm.js",
|
package/src/lib/FilterBar.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { FilterBarConfig, FilterBarDefinition, FilterMapActions, FilterMapGetter } from "./types/FilterTypes";
|
|
2
3
|
interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> {
|
|
3
4
|
/**
|
|
@@ -34,5 +35,5 @@ interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> {
|
|
|
34
35
|
/**
|
|
35
36
|
* The FilterBar component serves as a wrapper for managing filters.
|
|
36
37
|
*/
|
|
37
|
-
export declare const FilterBar: <TFilterBarDefinition extends FilterBarDefinition>({ hiddenFilters, className, filterBarDefinition, filterBarConfig, compact, allowShowFiltersDirectly, title, }: FilterBarProps<TFilterBarDefinition>) =>
|
|
38
|
+
export declare const FilterBar: <TFilterBarDefinition extends FilterBarDefinition>({ hiddenFilters, className, filterBarDefinition, filterBarConfig, compact, allowShowFiltersDirectly, title, }: FilterBarProps<TFilterBarDefinition>) => ReactElement;
|
|
38
39
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { FilterBarConfig, FilterBarDefinition, FilterDefinition, FilterMapActions, FilterMapGetter } from "../types/FilterTypes";
|
|
2
3
|
/**
|
|
3
4
|
*
|
|
@@ -6,4 +7,4 @@ export declare const AppliedFiltersRenderer: <TFilterBarDefinition extends Filte
|
|
|
6
7
|
appliedFilters: Array<FilterDefinition>;
|
|
7
8
|
filterBarConfig: FilterBarConfig<TFilterBarDefinition> & FilterMapActions & FilterMapGetter;
|
|
8
9
|
showResetButton?: boolean;
|
|
9
|
-
}) =>
|
|
10
|
+
}) => ReactElement;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { ValueName } from "../types/FilterTypes";
|
|
2
3
|
import { DefaultFilterProps } from "./DefaultFilterTypes";
|
|
3
4
|
type FilterDefinitionValue = Array<string> | Array<ValueName>;
|
|
@@ -6,5 +7,5 @@ type FilterDefinitionValue = Array<string> | Array<ValueName>;
|
|
|
6
7
|
*
|
|
7
8
|
* @param {DefaultFilterProps<string[]>} props - The properties required for the `DefaultCheckboxFilter` component.
|
|
8
9
|
*/
|
|
9
|
-
export declare const DefaultCheckboxFilter: <T extends FilterDefinitionValue>({ filterDefinition, filterBarActions, options, loading, setValue, filterName, customSearch, showRequestMoreUseSearch, showUndefinedOptionWithCountAtBottom, }: DefaultFilterProps<T>) =>
|
|
10
|
+
export declare const DefaultCheckboxFilter: <T extends FilterDefinitionValue>({ filterDefinition, filterBarActions, options, loading, setValue, filterName, customSearch, showRequestMoreUseSearch, showUndefinedOptionWithCountAtBottom, }: DefaultFilterProps<T>) => ReactElement;
|
|
10
11
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { DateRangeValue } from "../types/FilterTypes";
|
|
2
3
|
import { DefaultFilterProps } from "./DefaultFilterTypes";
|
|
3
4
|
/**
|
|
@@ -6,4 +7,4 @@ import { DefaultFilterProps } from "./DefaultFilterTypes";
|
|
|
6
7
|
*
|
|
7
8
|
* @param {DefaultFilterProps<DateRangeValue>} props - The properties required for the `DefaultDateRangeFilter` component.
|
|
8
9
|
*/
|
|
9
|
-
export declare const DefaultDateRangeFilter: ({ filterDefinition, filterName, value, setValue, }: DefaultFilterProps<DateRangeValue>) =>
|
|
10
|
+
export declare const DefaultDateRangeFilter: ({ filterDefinition, filterName, value, setValue, }: DefaultFilterProps<DateRangeValue>) => ReactElement;
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
+
import { ReactNode } from "react";
|
|
1
2
|
import { FilterBarConfig, FilterBarDefinition, FilterMapActions, FilterMapGetter } from "../types/FilterTypes";
|
|
2
3
|
/**
|
|
3
4
|
* Tooltip label for the filter button
|
|
4
5
|
*/
|
|
5
6
|
export declare const FilterButtonTooltipLabel: <TFilterBarDefinition extends FilterBarDefinition>({ filterBarConfig, }: {
|
|
6
7
|
filterBarConfig: FilterBarConfig<TFilterBarDefinition> & FilterMapActions & FilterMapGetter;
|
|
7
|
-
}) =>
|
|
8
|
+
}) => ReactNode;
|
|
@@ -11,5 +11,5 @@ interface Props<TResult> {
|
|
|
11
11
|
* shows no results if length or array is 0
|
|
12
12
|
* otherwise it calls children as a render prop
|
|
13
13
|
*/
|
|
14
|
-
export declare const FilterResults: <TResult extends object | string>({ results, ignoreUndefined, loading, children, }: Props<TResult>) =>
|
|
14
|
+
export declare const FilterResults: <TResult extends object | string>({ results, ignoreUndefined, loading, children, }: Props<TResult>) => ReactElement | null;
|
|
15
15
|
export {};
|
|
@@ -11,5 +11,5 @@ interface Props<TResult> {
|
|
|
11
11
|
* shows no results if length or array is 0
|
|
12
12
|
* otherwise it calls children as a render prop
|
|
13
13
|
*/
|
|
14
|
-
export declare const FilterResults: <TResult extends object | string>({ results, ignoreUndefined, loading, children, }: Props<TResult>) =>
|
|
14
|
+
export declare const FilterResults: <TResult extends object | string>({ results, ignoreUndefined, loading, children, }: Props<TResult>) => ReactElement | null;
|
|
15
15
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { GroupOfFilters } from "../hooks/useGroupFilters";
|
|
2
3
|
import { FilterBarConfig, FilterBarDefinition, FilterDefinition, FilterMapActions, FilterMapGetter } from "../types/FilterTypes";
|
|
3
4
|
/**
|
|
@@ -15,4 +16,4 @@ export declare const FiltersMenuContent: ({ filterBarConfig, setShowCustomFilter
|
|
|
15
16
|
appliedCustomFields: Array<FilterDefinition>;
|
|
16
17
|
showCustomFilters: boolean;
|
|
17
18
|
filterBarDefinitionCount: number;
|
|
18
|
-
}) =>
|
|
19
|
+
}) => ReactElement;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ReactElement } from "react";
|
|
1
2
|
import { FilterDefinition, FilterStateSetterCallback, ValueName } from "../../types/FilterTypes";
|
|
2
3
|
import { DefaultFilterProps, HierarchicalFilterOption } from "../DefaultFilterTypes";
|
|
3
4
|
/**
|
|
@@ -56,4 +57,4 @@ export interface HierarchicalFilterProps extends Omit<DefaultFilterProps<Array<V
|
|
|
56
57
|
*
|
|
57
58
|
* Supports optional cascading selection behavior via the `cascadeSelection` prop.
|
|
58
59
|
*/
|
|
59
|
-
export declare const HierarchicalCheckboxFilter: ({ filterDefinition, filterBarActions, options, loading, setValue, value, cascadeSelection, customSearch, showCount, }: HierarchicalFilterProps) =>
|
|
60
|
+
export declare const HierarchicalCheckboxFilter: ({ filterDefinition, filterBarActions, options, loading, setValue, value, cascadeSelection, customSearch, showCount, }: HierarchicalFilterProps) => ReactElement;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { useAnalytics } from "@trackunit/react-core-hooks";
|
|
2
|
+
import { ReactElement } from "react";
|
|
2
3
|
import { ValueName } from "../../types/FilterTypes";
|
|
3
4
|
import { HierarchicalFilterOption } from "../DefaultFilterTypes";
|
|
4
5
|
import { HierarchicalFilterProps } from "./HierarchicalCheckboxFilter";
|
|
@@ -17,5 +18,5 @@ interface RenderHierarchicalOptionProps {
|
|
|
17
18
|
* Renders a single option and its children recursively.
|
|
18
19
|
* Uses the `useHierarchicalOptionState` hook for state management and interaction logic.
|
|
19
20
|
*/
|
|
20
|
-
export declare const RenderHierarchicalOption: ({ option, filterDefinition, filterBarActions, setValue, logEvent, selectedValues, cascadeSelection, optionsMap, showCount, }: RenderHierarchicalOptionProps) =>
|
|
21
|
+
export declare const RenderHierarchicalOption: ({ option, filterDefinition, filterBarActions, setValue, logEvent, selectedValues, cascadeSelection, optionsMap, showCount, }: RenderHierarchicalOptionProps) => ReactElement;
|
|
21
22
|
export {};
|
|
@@ -12,14 +12,15 @@ interface UseHierarchicalOptionStateProps {
|
|
|
12
12
|
filterDefinition: HierarchicalFilterProps["filterDefinition"];
|
|
13
13
|
logEvent: ReturnType<typeof useAnalytics>["logEvent"];
|
|
14
14
|
}
|
|
15
|
+
type UseHierarchicalOptionStateReturn = {
|
|
16
|
+
isChecked: boolean;
|
|
17
|
+
isIndeterminate: boolean;
|
|
18
|
+
handleSelect: () => void;
|
|
19
|
+
};
|
|
15
20
|
/**
|
|
16
21
|
* Custom hook to manage the state and interactions of a single hierarchical option.
|
|
17
22
|
* Calculates checked/indeterminate state and provides a handler for value changes,
|
|
18
23
|
* including cascading logic.
|
|
19
24
|
*/
|
|
20
|
-
export declare const useHierarchicalOptionState: ({ options, option, selectedValues, cascadeSelection, optionsMap, setValue, filterDefinition, logEvent, }: UseHierarchicalOptionStateProps) =>
|
|
21
|
-
isChecked: boolean;
|
|
22
|
-
isIndeterminate: boolean;
|
|
23
|
-
handleSelect: () => void;
|
|
24
|
-
};
|
|
25
|
+
export declare const useHierarchicalOptionState: ({ options, option, selectedValues, cascadeSelection, optionsMap, setValue, filterDefinition, logEvent, }: UseHierarchicalOptionStateProps) => UseHierarchicalOptionStateReturn;
|
|
25
26
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Dispatch } from "react";
|
|
1
2
|
import { FilterBarConfig, FilterBarDefinition, FilterDefinition, FilterMapActions, FilterMapGetter } from "../types/FilterTypes";
|
|
2
3
|
import { GroupOfFilters } from "./useGroupFilters";
|
|
3
4
|
type UseFiltersMenuProps<TFilterBarDefinition extends FilterBarDefinition> = {
|
|
@@ -7,20 +8,21 @@ type UseFiltersMenuProps<TFilterBarDefinition extends FilterBarDefinition> = {
|
|
|
7
8
|
allowShowFiltersDirectly?: boolean;
|
|
8
9
|
includeFilterKeys?: Array<string>;
|
|
9
10
|
};
|
|
11
|
+
type UseFiltersMenuResult = {
|
|
12
|
+
appliedFilters: Array<FilterDefinition>;
|
|
13
|
+
hasCustomFields: boolean;
|
|
14
|
+
showDirectlyFilters: Array<FilterDefinition>;
|
|
15
|
+
appliedCustomFields: Array<FilterDefinition>;
|
|
16
|
+
searchText: string;
|
|
17
|
+
setSearchText: Dispatch<string>;
|
|
18
|
+
filtersToShowGrouped: Array<GroupOfFilters>;
|
|
19
|
+
searchResultsGrouped: Array<GroupOfFilters>;
|
|
20
|
+
removeCustomFieldsGroup: (groupOfFilters: Array<GroupOfFilters>) => Array<GroupOfFilters>;
|
|
21
|
+
};
|
|
10
22
|
/**
|
|
11
23
|
* This hook is used to manage the filters menu.
|
|
12
24
|
* It returns the filters that should be shown in the menu, the filters that should be shown directly in the filter bar,
|
|
13
25
|
* and the filters that should be shown in the search results.
|
|
14
26
|
*/
|
|
15
|
-
export declare const useFiltersMenu: <TFilterBarDefinition extends FilterBarDefinition>({ filterBarDefinition, filterBarConfig, hiddenFilters, allowShowFiltersDirectly, includeFilterKeys, }: UseFiltersMenuProps<TFilterBarDefinition>) =>
|
|
16
|
-
appliedFilters: FilterDefinition[];
|
|
17
|
-
hasCustomFields: boolean;
|
|
18
|
-
showDirectlyFilters: FilterDefinition[];
|
|
19
|
-
appliedCustomFields: FilterDefinition[];
|
|
20
|
-
searchText: string;
|
|
21
|
-
setSearchText: import("react").Dispatch<string>;
|
|
22
|
-
filtersToShowGrouped: GroupOfFilters[];
|
|
23
|
-
searchResultsGrouped: GroupOfFilters[];
|
|
24
|
-
removeCustomFieldsGroup: (groupOfFilters: Array<GroupOfFilters>) => Array<GroupOfFilters>;
|
|
25
|
-
};
|
|
27
|
+
export declare const useFiltersMenu: <TFilterBarDefinition extends FilterBarDefinition>({ filterBarDefinition, filterBarConfig, hiddenFilters, allowShowFiltersDirectly, includeFilterKeys, }: UseFiltersMenuProps<TFilterBarDefinition>) => UseFiltersMenuResult;
|
|
26
28
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ErrorHandlingContextValue } from "@trackunit/iris-app-runtime-core-api";
|
|
2
|
-
import { ZodTypeAny } from "zod";
|
|
2
|
+
import { z, ZodTypeAny } from "zod";
|
|
3
3
|
interface SearchParamAsFilterProps<TZodSchema> {
|
|
4
4
|
filterName: string;
|
|
5
5
|
search: Record<PropertyKey, unknown>;
|
|
@@ -17,5 +17,5 @@ interface SearchParamAsFilterProps<TZodSchema> {
|
|
|
17
17
|
* @param {ErrorHandlingContextValue} errorHandler - Error handling context for capturing and reporting exceptions.
|
|
18
18
|
* @returns {any} The parsed filter data if validation succeeds, otherwise `null`.
|
|
19
19
|
*/
|
|
20
|
-
export declare const useSearchParamAsFilter: <TZodSchema extends ZodTypeAny>({ filterName, search, zodSchema, errorHandler, }: SearchParamAsFilterProps<TZodSchema>) =>
|
|
20
|
+
export declare const useSearchParamAsFilter: <TZodSchema extends ZodTypeAny>({ filterName, search, zodSchema, errorHandler, }: SearchParamAsFilterProps<TZodSchema>) => z.infer<TZodSchema> | null;
|
|
21
21
|
export {};
|
|
@@ -6,6 +6,13 @@ import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterMap
|
|
|
6
6
|
* @template TFilterBarDefinition - A generic type for the filter bar definition.
|
|
7
7
|
* @returns {object} An object containing filter bar configuration and actions.
|
|
8
8
|
*/
|
|
9
|
+
type UseFilterBarActionsReturn = {
|
|
10
|
+
filterMapGetter: FilterMapGetter;
|
|
11
|
+
filterMapActions: FilterMapActions;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Hook that wires all filter map actions and getters for a filter bar definition.
|
|
15
|
+
*/
|
|
9
16
|
declare const useFilterBarActions: <TFilterBarDefinition extends FilterBarDefinition>({ name, filterBarConfig, filterBarDefinition, setFilterBarConfig, setValue, initialState, }: {
|
|
10
17
|
name: string;
|
|
11
18
|
filterBarConfig: FilterBarConfig<TFilterBarDefinition>;
|
|
@@ -13,8 +20,5 @@ declare const useFilterBarActions: <TFilterBarDefinition extends FilterBarDefini
|
|
|
13
20
|
setFilterBarConfig: Dispatch<SetStateAction<FilterBarConfig<TFilterBarDefinition>>>;
|
|
14
21
|
setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
|
|
15
22
|
initialState?: InitialState<TFilterBarDefinition>;
|
|
16
|
-
}) =>
|
|
17
|
-
filterMapGetter: FilterMapGetter;
|
|
18
|
-
filterMapActions: FilterMapActions;
|
|
19
|
-
};
|
|
23
|
+
}) => UseFilterBarActionsReturn;
|
|
20
24
|
export default useFilterBarActions;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue,
|
|
1
|
+
import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterValueType } from "../../types/FilterTypes";
|
|
2
2
|
import { FilterPersistenceConfig } from "../types";
|
|
3
|
+
import { useFilterUrlSync } from "./useFilterUrlSync";
|
|
3
4
|
export interface FilterBarPersistenceProps<TFilterBarDefinition extends FilterBarDefinition> extends FilterPersistenceConfig<TFilterBarDefinition> {
|
|
4
5
|
name: string;
|
|
5
6
|
setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
|
|
@@ -62,8 +63,13 @@ export declare const getPersistenceKey: (name: string, clientSideUserId?: string
|
|
|
62
63
|
* @param {FilterBarPersistenceProps<TFilterBarDefinition>} props - The props for the filter bar persistence.
|
|
63
64
|
* @returns { object } An object containing the loadData and saveData functions.
|
|
64
65
|
*/
|
|
65
|
-
|
|
66
|
+
type UseFilterBarPersistenceReturn<TFilterBarDefinition extends FilterBarDefinition> = {
|
|
66
67
|
loadData: <TFilterBarDefinitionExtended extends TFilterBarDefinition>(updatedFilterDefinitionsValues: Array<TFilterBarDefinitionExtended[keyof TFilterBarDefinitionExtended]>) => FilterBarConfig<TFilterBarDefinition>;
|
|
67
68
|
saveData: (filterBarConfig: Partial<FilterBarConfig<TFilterBarDefinition>>, filterBarDefinitions: TFilterBarDefinition) => void;
|
|
68
|
-
getFilterValuesToUrl:
|
|
69
|
+
getFilterValuesToUrl: ReturnType<typeof useFilterUrlSync>["getFilterValuesToUrl"];
|
|
69
70
|
};
|
|
71
|
+
/**
|
|
72
|
+
* Custom hook for managing the persistence of filter bar configurations.
|
|
73
|
+
*/
|
|
74
|
+
export declare const useFilterBarPersistence: <TFilterBarDefinition extends FilterBarDefinition>({ name, setValue, refreshData, isDefaultValue, loadData: inputLoadData, saveData: inputSaveData, }: FilterBarPersistenceProps<TFilterBarDefinition>) => UseFilterBarPersistenceReturn<TFilterBarDefinition>;
|
|
75
|
+
export {};
|
|
@@ -4,7 +4,14 @@ import { FilterBarDefinition, FilterDefinition, FilterStateValues, FilterValueTy
|
|
|
4
4
|
*
|
|
5
5
|
* @returns {object} Object containing loadFromUrl and saveToUrl functions
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
type UseFilterUrlSyncReturn = {
|
|
8
8
|
getFilterValuesFromUrl: <TFilterBarDefinition extends FilterBarDefinition>(definitions: Array<FilterDefinition>, search: Record<PropertyKey, unknown>) => FilterStateValues<TFilterBarDefinition>;
|
|
9
9
|
getFilterValuesToUrl: (values: FilterStateValues<FilterBarDefinition> | null, definitions: Array<FilterDefinition>, setEmptyAndDefaultValues: boolean, isDefaultValue: (key: string, value: FilterValueType) => boolean) => Record<string, unknown>;
|
|
10
10
|
};
|
|
11
|
+
/**
|
|
12
|
+
* Hook to sync filter values with URL
|
|
13
|
+
*
|
|
14
|
+
* @returns {object} Object containing loadFromUrl and saveToUrl functions
|
|
15
|
+
*/
|
|
16
|
+
export declare const useFilterUrlSync: () => UseFilterUrlSyncReturn;
|
|
17
|
+
export {};
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue } from "../../types/FilterTypes";
|
|
2
1
|
import { Dispatch, SetStateAction } from "react";
|
|
2
|
+
import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue } from "../../types/FilterTypes";
|
|
3
|
+
type UseGenericSetValueReturn<TFilterBarDefinition extends FilterBarDefinition> = {
|
|
4
|
+
setValue: (setFilterBarConfig: Dispatch<SetStateAction<FilterBarConfig<TFilterBarDefinition>>>, key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
|
|
5
|
+
};
|
|
3
6
|
/**
|
|
4
7
|
* Generic hook for setting the value of a filter bar.
|
|
5
8
|
*
|
|
6
9
|
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
7
10
|
* @returns {object} An object containing the setValue function.
|
|
8
11
|
*/
|
|
9
|
-
export declare const useGenericSetValue: <TFilterBarDefinition extends FilterBarDefinition>() =>
|
|
10
|
-
|
|
11
|
-
};
|
|
12
|
+
export declare const useGenericSetValue: <TFilterBarDefinition extends FilterBarDefinition>() => UseGenericSetValueReturn<TFilterBarDefinition>;
|
|
13
|
+
export {};
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { FilterBarDefinition, FilterValueType, InitialState } from "../../types/FilterTypes";
|
|
2
|
+
type UseIsDefaultValueReturn<TFilterBarDefinition extends FilterBarDefinition> = {
|
|
3
|
+
isDefaultValue: (key: string, filterValue: FilterValueType, filterBarDefinition: TFilterBarDefinition, initialState?: InitialState<TFilterBarDefinition>) => boolean;
|
|
4
|
+
};
|
|
2
5
|
/**
|
|
3
|
-
* Generic hook for
|
|
6
|
+
* Generic hook for checking if a filter value matches its default.
|
|
4
7
|
*
|
|
5
8
|
* @template TFilterBarDefinition - The type of the filter bar definition.
|
|
6
|
-
* @returns {object} An object containing the
|
|
9
|
+
* @returns {object} An object containing the isDefaultValue helper.
|
|
7
10
|
*/
|
|
8
|
-
export declare const useIsDefaultValue: <TFilterBarDefinition extends FilterBarDefinition>() =>
|
|
9
|
-
|
|
10
|
-
};
|
|
11
|
+
export declare const useIsDefaultValue: <TFilterBarDefinition extends FilterBarDefinition>() => UseIsDefaultValueReturn<TFilterBarDefinition>;
|
|
12
|
+
export {};
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
type UseSearchUtilsReturn = {
|
|
2
|
+
getSearchParamsLengthExcluding: (excludeKey: string, searchParams: Record<PropertyKey, unknown>) => number;
|
|
3
|
+
getUrlLengthWithSearchParam: (key: string, value: string, prev: Record<PropertyKey, unknown>) => number;
|
|
4
|
+
};
|
|
1
5
|
/**
|
|
2
6
|
* This hook provides functionality to:
|
|
3
7
|
* - Get the length of the search parameters excluding a specific key
|
|
4
8
|
*/
|
|
5
|
-
export declare const useSearchUtils: () =>
|
|
6
|
-
|
|
7
|
-
getUrlLengthWithSearchParam: (key: string, value: string, prev: Record<PropertyKey, unknown>) => number;
|
|
8
|
-
};
|
|
9
|
+
export declare const useSearchUtils: () => UseSearchUtilsReturn;
|
|
10
|
+
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { FilterDefinition } from "../types/FilterTypes";
|
|
1
|
+
import { FilterBarDefinition, FilterDefinition, FilterStateValues } from "../types/FilterTypes";
|
|
2
2
|
/**
|
|
3
3
|
*
|
|
4
4
|
*/
|
|
5
|
-
export declare const createFilterValues: (mainFilters: Array<FilterDefinition>, useDefaultValues?: boolean) =>
|
|
5
|
+
export declare const createFilterValues: <TFilterBarDefinition extends FilterBarDefinition>(mainFilters: Array<FilterDefinition>, useDefaultValues?: boolean) => FilterStateValues<TFilterBarDefinition>;
|
package/src/translation.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { NamespaceTransProps, TransForLibs, TranslationResource } from "@trackunit/i18n-library-translation";
|
|
1
|
+
import { NamespaceTransProps, TransForLibs, TranslationResource, useNamespaceTranslation } from "@trackunit/i18n-library-translation";
|
|
2
|
+
import { ReactElement } from "react";
|
|
2
3
|
import defaultTranslations from "./locales/en/translation.json";
|
|
3
4
|
/** A type for all available translation keys in this library */
|
|
4
5
|
export type TranslationKeys = keyof typeof defaultTranslations;
|
|
@@ -14,11 +15,7 @@ export declare const translations: TranslationResource<TranslationKeys>;
|
|
|
14
15
|
/**
|
|
15
16
|
* Local useTranslation for this specific library
|
|
16
17
|
*/
|
|
17
|
-
export declare const useTranslation: () => [TransForLibs<"access.management.filter.operator.role.keyAdmin" | "access.management.keys.filter.active" | "access.management.keys.filter.deleted" | "access.management.keys.filter.expired" | "access.management.keys.filter.future" | "access.management.operator.asset.filter.category" | "access.management.operator.asset.filter.keyType" | "access.management.operator.asset.filter.type.digitalKey" | "access.management.operator.asset.filter.type.rollingPin" | "access.management.operator.asset.filter.type.staticPin" | "access.management.operator.filter.category" | "access.management.operator.filter.keyStatus.title" | "access.management.operator.filter.operatorRole.title" | "assetFilters.activityFilter.idling" | "assetFilters.activityFilter.stopped" | "assetFilters.activityFilter.unknown" | "assetFilters.activityFilter.working" | "assetFilters.assetType.ATTACHMENT" | "assetFilters.assetType.EQUIPMENT" | "assetFilters.assetType.GATEWAY" | "assetFilters.assetType.MACHINE" | "assetFilters.assetType.OTHER" | "assetFilters.assetType.TOOL" | "assetFilters.boundingBoxFilter.label" | "assetFilters.boundingBoxFilter.value" | "assetFilters.criticality.CRITICAL" | "assetFilters.criticality.LOW" | "assetFilters.criticality.NONE" | "assetFilters.followedFilter.label" | "assetFilters.hourIntervalFilter.label" | "assetFilters.lastSeenFilter.anytime" | "assetFilters.lastSeenFilter.last24Hours" | "assetFilters.lastSeenFilter.last30Days" | "assetFilters.lastSeenFilter.last7Days" | "assetFilters.lastSeenFilter.lastHour" | "assetFilters.lastSeenFilter.olderThan30Days" | "assetFilters.location.previouslySearched" | "assetFilters.ownerAccountNameFilter.label" | "assetFilters.partnerFilter.label" | "assetFilters.periodFilter.label" | "assetFilters.periodFilter.LAST_24_HOURS" | "assetFilters.periodFilter.LAST_30_DAYS" | "assetFilters.periodFilter.LAST_7_DAYS" | "assetFilters.periodFilter.LIFETIME" | "assetFilters.planned" | "assetFilters.productionYear.label" | "assetFilters.regions.ANTARCTICA" | "assetFilters.regions.AUSTRALIA_AND_NEW_ZEALAND" | "assetFilters.regions.CENTRAL_ASIA" | "assetFilters.regions.EASTERN_ASIA" | "assetFilters.regions.EASTERN_EUROPE" | "assetFilters.regions.label" | "assetFilters.regions.LATIN_AMERICA_AND_THE_CARIBBEAN" | "assetFilters.regions.MELANESIA" | "assetFilters.regions.MICRONESIA" | "assetFilters.regions.NORTHERN_AFRICA" | "assetFilters.regions.NORTHERN_AMERICA" | "assetFilters.regions.NORTHERN_EUROPE" | "assetFilters.regions.POLYNESIA" | "assetFilters.regions.SOUTH-EASTERN_ASIA" | "assetFilters.regions.SOUTHERN_ASIA" | "assetFilters.regions.SOUTHERN_EUROPE" | "assetFilters.regions.SUB-SAHARAN_AFRICA" | "assetFilters.regions.WESTERN_ASIA" | "assetFilters.regions.WESTERN_EUROPE" | "assetFilters.regions.WHOLE_WORLD" | "assetFilters.searchFilter.label" | "assetFilters.searchPlaceholder" | "assetFilters.serviceAssignmentStatusFilter.label" | "assetFilters.servicePlanFilter.fullyConfigured" | "assetFilters.servicePlanFilter.label" | "assetFilters.servicePlanFilter.notConfigured" | "assetFilters.servicePlanFilter.partiallyConfigured" | "assetFilters.serviceProviderFilter.label" | "assetFilters.serviceProviderStatusFilter.hasServiceProvider" | "assetFilters.serviceProviderStatusFilter.noServiceProvider" | "assetFilters.serviceStatusFilter.label" | "assetFilters.serviceStatusFilter.overdue" | "assetFilters.serviceStatusFilter.upcoming" | "assetFilters.shareOwnerFilter.label" | "assetFilters.unknown" | "assetFilters.visibleToFilter.label" | "auditlog.filter.categories" | "auditlog.filter.component" | "auditlog.filter.components" | "auditlog.filter.events" | "auditlog.filter.users" | "filter.more.options.if.you.search.description" | "filter.more.options.if.you.search.title" | "filtersBar.appliedFiltersTooltip.none" | "filtersBar.appliedFiltersTooltip.plural" | "filtersBar.appliedFiltersTooltip.singular" | "filtersBar.defaultAssetFilters.followedFilter.ALL" | "filtersBar.defaultAssetFilters.followedFilter.allLabel" | "filtersBar.defaultAssetFilters.followedFilter.FOLLOWED" | "filtersBar.defaultAssetFilters.followedFilter.followedOnlyLabel" | "filtersBar.defaultAssetFilters.lastSeenFilter.ALL" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_24_HOURS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_30_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_7_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_HOUR" | "filtersBar.defaultAssetFilters.lastSeenFilter.OLDER_THAN_30_DAYS" | "filtersBar.defaultDateRangeFilters.apply" | "filtersBar.defaultDateRangeFilters.cancel" | "filtersBar.defaultMinMaxFilters.apply" | "filtersBar.defaultMinMaxFilters.max" | "filtersBar.defaultMinMaxFilters.min" | "filtersBar.deselectAll" | "filtersBar.emptyResults" | "filtersBar.filtersHeading" | "filtersBar.groups.ACCESS_MANAGEMENT" | "filtersBar.groups.ASSET" | "filtersBar.groups.CURRENT_LOCATION" | "filtersBar.groups.CUSTOM_FIELDS" | "filtersBar.groups.CUSTOMERS" | "filtersBar.groups.DEVICE_HEALTH" | "filtersBar.groups.INTEGRATION" | "filtersBar.groups.MANAGEMENT" | "filtersBar.groups.METADATA" | "filtersBar.groups.MY_NETWORK" | "filtersBar.groups.OPERATOR" | "filtersBar.groups.OTHER" | "filtersBar.groups.RENTAL" | "filtersBar.groups.SERVICE" | "filtersBar.groups.SITES" | "filtersBar.groups.STATUS" | "filtersBar.hiddenFilters.plural" | "filtersBar.hiddenFilters.singular" | "filtersBar.hiddenFilters.toggleFilters" | "filtersBar.loading" | "filtersBar.myNetworkGroup" | "filtersBar.resetFilter" | "filtersBar.resetFilters" | "filtersBar.resetFiltersSR" | "filtersBar.searchFiltersPlaceholder" | "filtersBar.searchPlaceholder" | "filtersBar.selectAll" | "filtersBar.showAll" | "filtersMenu.appliedFiltersLabel.plural" | "filtersMenu.appliedFiltersLabel.singular" | "fleetlist.column.activity" | "fleetlist.column.assetIds" | "fleetlist.column.assetType" | "fleetlist.column.attention" | "fleetlist.column.brand" | "fleetlist.column.city" | "fleetlist.column.country" | "fleetlist.column.externalReference" | "fleetlist.column.lastSeen" | "fleetlist.column.metadata" | "fleetlist.column.model" | "fleetlist.column.name" | "fleetlist.column.owner" | "fleetlist.column.siteStatus" | "fleetlist.column.siteType" | "fleetlist.column.streetAddress" | "fleetlist.column.totalHours" | "fleetlist.column.type" | "fleetlist.column.unitSerialNumber" | "fleetlist.column.vin" | "fleetlist.column.year" | "fleetlist.column.zipCode" | "fleetlist.createGroup" | "fleetlist.description" | "fleetList.sorting.ACTIVITY" | "fleetList.sorting.ASSET_TYPE" | "fleetList.sorting.BRAND" | "fleetList.sorting.CATEGORY" | "fleetList.sorting.CRITICALITY" | "fleetList.sorting.EXTERNAL_REFERENCE" | "fleetList.sorting.LOCATION" | "fleetList.sorting.LOCATION_UPDATED_AT" | "fleetList.sorting.MODEL" | "fleetList.sorting.NAME" | "fleetList.sorting.OWNER_ACCOUNT_NAME" | "fleetList.sorting.PRODUCTION_YEAR" | "fleetList.sorting.SERIAL_NUMBER" | "fleetList.sorting.SERVICE_PLAN_ASSIGNMENT_STATUS" | "fleetList.sorting.SERVICE_PLAN_OVERDUENESS" | "fleetList.sorting.SERVICE_PLAN_STATUS" | "fleetList.sorting.TELEMATICS_DEVICE_SERIAL_NUMBER" | "fleetList.sorting.TYPE" | "fleetList.sortingCategories.metadata" | "fleetList.sortingCategories.other" | "fleetList.sortingCategories.status" | "machine.types.ALL" | "machine.types.Unknown" | "myNetwork.deviceList.filterBar.accessControlType" | "myNetwork.deviceList.filterBar.canProfile" | "myNetwork.deviceList.filterBar.country" | "myNetwork.deviceList.filterBar.dataFeed" | "myNetwork.deviceList.filterBar.deviceHealth" | "myNetwork.deviceList.filterBar.deviceHealthScore" | "myNetwork.deviceList.filterBar.deviceType" | "myNetwork.deviceList.filterBar.digitalKeyMode" | "myNetwork.deviceList.filterBar.firmwareVersion" | "myNetwork.deviceList.filterBar.hasCanSupport" | "myNetwork.deviceList.filterBar.mobileOperator" | "myNetwork.deviceList.filterBar.networkTechnology" | "myNetwork.deviceList.filterBar.operatingHoursIssue" | "myNetwork.deviceList.filterBar.owner" | "myNetwork.deviceList.filterBar.powerProfile" | "myNetwork.insights.accessControlDevice.DUALID" | "myNetwork.insights.accessControlDevice.DUALID_II" | "myNetwork.insights.accessControlDevice.IBUTTON_READER" | "myNetwork.insights.accessControlDevice.K300" | "myNetwork.insights.accessControlDevice.NO_ACCESSORY_CONNECTED" | "myNetwork.insights.accessControlDevice.UNKNOWN" | "myNetwork.insights.hasCanSupport.false" | "myNetwork.insights.hasCanSupport.true" | "myNetwork.insights.NONE" | "myNetwork.insights.operatingHoursIssue.HOURS_FROM_CAN_AND_PRERUN1_CONFIGURED" | "myNetwork.insights.operatingHoursIssue.MACHINE_CONSTANTLY_ON" | "myNetwork.insights.operatingHoursIssue.MULTIPLE_HOURS_SOURCE" | "myNetwork.insights.operatingHoursIssue.NOT_COUNTING_OPERATING_HOURS" | "myNetwork.insights.operatingHoursIssue.NOT_RECEIVING_HOURS_FROM_CAN" | "myNetwork.insights.unknown" | "myNetwork.overview.deviceHealthScoreV2.criticality.AT_RISK" | "myNetwork.overview.deviceHealthScoreV2.criticality.CRITICAL" | "myNetwork.overview.deviceHealthScoreV2.criticality.HEALTHY" | "myNetwork.overview.deviceHealthScoreV2.criticality.NONE" | "myNetwork.overview.unsupportedNetworkTechnology" | "pages.machines.telematics.networkTechnology.NW_TECH_2G" | "pages.machines.telematics.networkTechnology.NW_TECH_3G" | "pages.machines.telematics.networkTechnology.NW_TECH_4G" | "pages.machines.telematics.networkTechnology.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.DISABLED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.name" | "pages.machines.telematics.operationalStatus.digitalKeyMode.NEVER_INITIALIZED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY_AND_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNSUPPORTED" | "rental.status.available" | "rental.status.inRepair" | "rental.status.onRent" | "rental.status.other" | "rental.status.pickUpReady" | "rental.status.returned" | "rental.status.transfer" | "rental.status.unknown" | "siteFilters.siteStatus.ACTIVE" | "siteFilters.siteStatus.ARCHIVED" | "siteFilters.siteStatus.FINISHED" | "siteFilters.siteStatus.PLANNED" | "siteFilters.siteStatus.unknown" | "siteFilters.siteType.AREA" | "siteFilters.siteType.CLASSIC_POI" | "siteFilters.siteType.CLASSIC_ZONE" | "siteFilters.siteType.CONSTRUCTION_SITE" | "siteFilters.siteType.DEPOT" | "siteFilters.siteType.NOT_ON_SITE" | "siteFilters.siteType.unknown" | "siteFilters.siteType.WORK_PLACE">, import("i18next").i18n, boolean] & {
|
|
18
|
-
t: TransForLibs<"access.management.filter.operator.role.keyAdmin" | "access.management.keys.filter.active" | "access.management.keys.filter.deleted" | "access.management.keys.filter.expired" | "access.management.keys.filter.future" | "access.management.operator.asset.filter.category" | "access.management.operator.asset.filter.keyType" | "access.management.operator.asset.filter.type.digitalKey" | "access.management.operator.asset.filter.type.rollingPin" | "access.management.operator.asset.filter.type.staticPin" | "access.management.operator.filter.category" | "access.management.operator.filter.keyStatus.title" | "access.management.operator.filter.operatorRole.title" | "assetFilters.activityFilter.idling" | "assetFilters.activityFilter.stopped" | "assetFilters.activityFilter.unknown" | "assetFilters.activityFilter.working" | "assetFilters.assetType.ATTACHMENT" | "assetFilters.assetType.EQUIPMENT" | "assetFilters.assetType.GATEWAY" | "assetFilters.assetType.MACHINE" | "assetFilters.assetType.OTHER" | "assetFilters.assetType.TOOL" | "assetFilters.boundingBoxFilter.label" | "assetFilters.boundingBoxFilter.value" | "assetFilters.criticality.CRITICAL" | "assetFilters.criticality.LOW" | "assetFilters.criticality.NONE" | "assetFilters.followedFilter.label" | "assetFilters.hourIntervalFilter.label" | "assetFilters.lastSeenFilter.anytime" | "assetFilters.lastSeenFilter.last24Hours" | "assetFilters.lastSeenFilter.last30Days" | "assetFilters.lastSeenFilter.last7Days" | "assetFilters.lastSeenFilter.lastHour" | "assetFilters.lastSeenFilter.olderThan30Days" | "assetFilters.location.previouslySearched" | "assetFilters.ownerAccountNameFilter.label" | "assetFilters.partnerFilter.label" | "assetFilters.periodFilter.label" | "assetFilters.periodFilter.LAST_24_HOURS" | "assetFilters.periodFilter.LAST_30_DAYS" | "assetFilters.periodFilter.LAST_7_DAYS" | "assetFilters.periodFilter.LIFETIME" | "assetFilters.planned" | "assetFilters.productionYear.label" | "assetFilters.regions.ANTARCTICA" | "assetFilters.regions.AUSTRALIA_AND_NEW_ZEALAND" | "assetFilters.regions.CENTRAL_ASIA" | "assetFilters.regions.EASTERN_ASIA" | "assetFilters.regions.EASTERN_EUROPE" | "assetFilters.regions.label" | "assetFilters.regions.LATIN_AMERICA_AND_THE_CARIBBEAN" | "assetFilters.regions.MELANESIA" | "assetFilters.regions.MICRONESIA" | "assetFilters.regions.NORTHERN_AFRICA" | "assetFilters.regions.NORTHERN_AMERICA" | "assetFilters.regions.NORTHERN_EUROPE" | "assetFilters.regions.POLYNESIA" | "assetFilters.regions.SOUTH-EASTERN_ASIA" | "assetFilters.regions.SOUTHERN_ASIA" | "assetFilters.regions.SOUTHERN_EUROPE" | "assetFilters.regions.SUB-SAHARAN_AFRICA" | "assetFilters.regions.WESTERN_ASIA" | "assetFilters.regions.WESTERN_EUROPE" | "assetFilters.regions.WHOLE_WORLD" | "assetFilters.searchFilter.label" | "assetFilters.searchPlaceholder" | "assetFilters.serviceAssignmentStatusFilter.label" | "assetFilters.servicePlanFilter.fullyConfigured" | "assetFilters.servicePlanFilter.label" | "assetFilters.servicePlanFilter.notConfigured" | "assetFilters.servicePlanFilter.partiallyConfigured" | "assetFilters.serviceProviderFilter.label" | "assetFilters.serviceProviderStatusFilter.hasServiceProvider" | "assetFilters.serviceProviderStatusFilter.noServiceProvider" | "assetFilters.serviceStatusFilter.label" | "assetFilters.serviceStatusFilter.overdue" | "assetFilters.serviceStatusFilter.upcoming" | "assetFilters.shareOwnerFilter.label" | "assetFilters.unknown" | "assetFilters.visibleToFilter.label" | "auditlog.filter.categories" | "auditlog.filter.component" | "auditlog.filter.components" | "auditlog.filter.events" | "auditlog.filter.users" | "filter.more.options.if.you.search.description" | "filter.more.options.if.you.search.title" | "filtersBar.appliedFiltersTooltip.none" | "filtersBar.appliedFiltersTooltip.plural" | "filtersBar.appliedFiltersTooltip.singular" | "filtersBar.defaultAssetFilters.followedFilter.ALL" | "filtersBar.defaultAssetFilters.followedFilter.allLabel" | "filtersBar.defaultAssetFilters.followedFilter.FOLLOWED" | "filtersBar.defaultAssetFilters.followedFilter.followedOnlyLabel" | "filtersBar.defaultAssetFilters.lastSeenFilter.ALL" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_24_HOURS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_30_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_7_DAYS" | "filtersBar.defaultAssetFilters.lastSeenFilter.LAST_HOUR" | "filtersBar.defaultAssetFilters.lastSeenFilter.OLDER_THAN_30_DAYS" | "filtersBar.defaultDateRangeFilters.apply" | "filtersBar.defaultDateRangeFilters.cancel" | "filtersBar.defaultMinMaxFilters.apply" | "filtersBar.defaultMinMaxFilters.max" | "filtersBar.defaultMinMaxFilters.min" | "filtersBar.deselectAll" | "filtersBar.emptyResults" | "filtersBar.filtersHeading" | "filtersBar.groups.ACCESS_MANAGEMENT" | "filtersBar.groups.ASSET" | "filtersBar.groups.CURRENT_LOCATION" | "filtersBar.groups.CUSTOM_FIELDS" | "filtersBar.groups.CUSTOMERS" | "filtersBar.groups.DEVICE_HEALTH" | "filtersBar.groups.INTEGRATION" | "filtersBar.groups.MANAGEMENT" | "filtersBar.groups.METADATA" | "filtersBar.groups.MY_NETWORK" | "filtersBar.groups.OPERATOR" | "filtersBar.groups.OTHER" | "filtersBar.groups.RENTAL" | "filtersBar.groups.SERVICE" | "filtersBar.groups.SITES" | "filtersBar.groups.STATUS" | "filtersBar.hiddenFilters.plural" | "filtersBar.hiddenFilters.singular" | "filtersBar.hiddenFilters.toggleFilters" | "filtersBar.loading" | "filtersBar.myNetworkGroup" | "filtersBar.resetFilter" | "filtersBar.resetFilters" | "filtersBar.resetFiltersSR" | "filtersBar.searchFiltersPlaceholder" | "filtersBar.searchPlaceholder" | "filtersBar.selectAll" | "filtersBar.showAll" | "filtersMenu.appliedFiltersLabel.plural" | "filtersMenu.appliedFiltersLabel.singular" | "fleetlist.column.activity" | "fleetlist.column.assetIds" | "fleetlist.column.assetType" | "fleetlist.column.attention" | "fleetlist.column.brand" | "fleetlist.column.city" | "fleetlist.column.country" | "fleetlist.column.externalReference" | "fleetlist.column.lastSeen" | "fleetlist.column.metadata" | "fleetlist.column.model" | "fleetlist.column.name" | "fleetlist.column.owner" | "fleetlist.column.siteStatus" | "fleetlist.column.siteType" | "fleetlist.column.streetAddress" | "fleetlist.column.totalHours" | "fleetlist.column.type" | "fleetlist.column.unitSerialNumber" | "fleetlist.column.vin" | "fleetlist.column.year" | "fleetlist.column.zipCode" | "fleetlist.createGroup" | "fleetlist.description" | "fleetList.sorting.ACTIVITY" | "fleetList.sorting.ASSET_TYPE" | "fleetList.sorting.BRAND" | "fleetList.sorting.CATEGORY" | "fleetList.sorting.CRITICALITY" | "fleetList.sorting.EXTERNAL_REFERENCE" | "fleetList.sorting.LOCATION" | "fleetList.sorting.LOCATION_UPDATED_AT" | "fleetList.sorting.MODEL" | "fleetList.sorting.NAME" | "fleetList.sorting.OWNER_ACCOUNT_NAME" | "fleetList.sorting.PRODUCTION_YEAR" | "fleetList.sorting.SERIAL_NUMBER" | "fleetList.sorting.SERVICE_PLAN_ASSIGNMENT_STATUS" | "fleetList.sorting.SERVICE_PLAN_OVERDUENESS" | "fleetList.sorting.SERVICE_PLAN_STATUS" | "fleetList.sorting.TELEMATICS_DEVICE_SERIAL_NUMBER" | "fleetList.sorting.TYPE" | "fleetList.sortingCategories.metadata" | "fleetList.sortingCategories.other" | "fleetList.sortingCategories.status" | "machine.types.ALL" | "machine.types.Unknown" | "myNetwork.deviceList.filterBar.accessControlType" | "myNetwork.deviceList.filterBar.canProfile" | "myNetwork.deviceList.filterBar.country" | "myNetwork.deviceList.filterBar.dataFeed" | "myNetwork.deviceList.filterBar.deviceHealth" | "myNetwork.deviceList.filterBar.deviceHealthScore" | "myNetwork.deviceList.filterBar.deviceType" | "myNetwork.deviceList.filterBar.digitalKeyMode" | "myNetwork.deviceList.filterBar.firmwareVersion" | "myNetwork.deviceList.filterBar.hasCanSupport" | "myNetwork.deviceList.filterBar.mobileOperator" | "myNetwork.deviceList.filterBar.networkTechnology" | "myNetwork.deviceList.filterBar.operatingHoursIssue" | "myNetwork.deviceList.filterBar.owner" | "myNetwork.deviceList.filterBar.powerProfile" | "myNetwork.insights.accessControlDevice.DUALID" | "myNetwork.insights.accessControlDevice.DUALID_II" | "myNetwork.insights.accessControlDevice.IBUTTON_READER" | "myNetwork.insights.accessControlDevice.K300" | "myNetwork.insights.accessControlDevice.NO_ACCESSORY_CONNECTED" | "myNetwork.insights.accessControlDevice.UNKNOWN" | "myNetwork.insights.hasCanSupport.false" | "myNetwork.insights.hasCanSupport.true" | "myNetwork.insights.NONE" | "myNetwork.insights.operatingHoursIssue.HOURS_FROM_CAN_AND_PRERUN1_CONFIGURED" | "myNetwork.insights.operatingHoursIssue.MACHINE_CONSTANTLY_ON" | "myNetwork.insights.operatingHoursIssue.MULTIPLE_HOURS_SOURCE" | "myNetwork.insights.operatingHoursIssue.NOT_COUNTING_OPERATING_HOURS" | "myNetwork.insights.operatingHoursIssue.NOT_RECEIVING_HOURS_FROM_CAN" | "myNetwork.insights.unknown" | "myNetwork.overview.deviceHealthScoreV2.criticality.AT_RISK" | "myNetwork.overview.deviceHealthScoreV2.criticality.CRITICAL" | "myNetwork.overview.deviceHealthScoreV2.criticality.HEALTHY" | "myNetwork.overview.deviceHealthScoreV2.criticality.NONE" | "myNetwork.overview.unsupportedNetworkTechnology" | "pages.machines.telematics.networkTechnology.NW_TECH_2G" | "pages.machines.telematics.networkTechnology.NW_TECH_3G" | "pages.machines.telematics.networkTechnology.NW_TECH_4G" | "pages.machines.telematics.networkTechnology.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.DISABLED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.LOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.name" | "pages.machines.telematics.operationalStatus.digitalKeyMode.NEVER_INITIALIZED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNKNOWN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_ALL_FIXED" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_KEY_AND_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNLOCKED_FOR_PIN" | "pages.machines.telematics.operationalStatus.digitalKeyMode.UNSUPPORTED" | "rental.status.available" | "rental.status.inRepair" | "rental.status.onRent" | "rental.status.other" | "rental.status.pickUpReady" | "rental.status.returned" | "rental.status.transfer" | "rental.status.unknown" | "siteFilters.siteStatus.ACTIVE" | "siteFilters.siteStatus.ARCHIVED" | "siteFilters.siteStatus.FINISHED" | "siteFilters.siteStatus.PLANNED" | "siteFilters.siteStatus.unknown" | "siteFilters.siteType.AREA" | "siteFilters.siteType.CLASSIC_POI" | "siteFilters.siteType.CLASSIC_ZONE" | "siteFilters.siteType.CONSTRUCTION_SITE" | "siteFilters.siteType.DEPOT" | "siteFilters.siteType.NOT_ON_SITE" | "siteFilters.siteType.unknown" | "siteFilters.siteType.WORK_PLACE">;
|
|
19
|
-
i18n: import("i18next").i18n;
|
|
20
|
-
ready: boolean;
|
|
21
|
-
};
|
|
18
|
+
export declare const useTranslation: () => ReturnType<typeof useNamespaceTranslation<TranslationKeys>>;
|
|
22
19
|
/**
|
|
23
20
|
* Type of the t function for the local useTranslation for this specific library
|
|
24
21
|
*/
|
|
@@ -26,7 +23,7 @@ export type TranslationFunction = TransForLibs<TranslationKeys>;
|
|
|
26
23
|
/**
|
|
27
24
|
* Trans for this specific library.
|
|
28
25
|
*/
|
|
29
|
-
export declare const Trans: (props: NamespaceTransProps<TranslationKeys>) =>
|
|
26
|
+
export declare const Trans: (props: NamespaceTransProps<TranslationKeys>) => ReactElement;
|
|
30
27
|
/**
|
|
31
28
|
* Registers the translations for this library
|
|
32
29
|
*/
|