@trackunit/react-core-hooks 0.2.90 → 0.2.91
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 +29 -0
- package/index.esm.js +28 -1
- package/package.json +4 -4
- package/src/filter-bar/FilterBarProvider.d.ts +26 -0
- package/src/index.d.ts +1 -0
package/index.cjs.js
CHANGED
|
@@ -124,6 +124,33 @@ const useEnvironment = () => {
|
|
|
124
124
|
return context;
|
|
125
125
|
};
|
|
126
126
|
|
|
127
|
+
const FilterBarContext = React__namespace.createContext(null);
|
|
128
|
+
/**
|
|
129
|
+
* This is a hook to use the FilterBarProvider.
|
|
130
|
+
*
|
|
131
|
+
* @requires FilterBarProvider
|
|
132
|
+
* @example
|
|
133
|
+
* import { useFilterBar } from "@trackunit/react-core-hooks";
|
|
134
|
+
*
|
|
135
|
+
* export const useFilterBarValues = () => {
|
|
136
|
+
* const { filterBarValues } = useFilterBar();
|
|
137
|
+
*
|
|
138
|
+
* ...
|
|
139
|
+
* };
|
|
140
|
+
* @see {@link IFilterBarContext}
|
|
141
|
+
*/
|
|
142
|
+
const useFilterBarContext = () => {
|
|
143
|
+
const context = React__namespace.useContext(FilterBarContext);
|
|
144
|
+
if (!context) {
|
|
145
|
+
throw new Error("useFilterBar must be used within the FilterBarContext");
|
|
146
|
+
}
|
|
147
|
+
return context;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* This is a provider for the FilterBarContext.
|
|
151
|
+
*/
|
|
152
|
+
const FilterBarProvider = (props) => jsxRuntime.jsx(FilterBarContext.Provider, Object.assign({}, props));
|
|
153
|
+
|
|
127
154
|
const GlobalSelectionContext = React__namespace.createContext(null);
|
|
128
155
|
/**
|
|
129
156
|
* This is a hook to use the GlobalSelectionContext.
|
|
@@ -489,6 +516,7 @@ exports.AnalyticsContextProvider = AnalyticsContextProvider;
|
|
|
489
516
|
exports.AssetSortingProvider = AssetSortingProvider;
|
|
490
517
|
exports.CurrentUserProvider = CurrentUserProvider;
|
|
491
518
|
exports.EnvironmentContextProvider = EnvironmentContextProvider;
|
|
519
|
+
exports.FilterBarProvider = FilterBarProvider;
|
|
492
520
|
exports.GlobalSelectionProvider = GlobalSelectionProvider;
|
|
493
521
|
exports.OemBrandingContextProvider = OemBrandingContextProvider;
|
|
494
522
|
exports.ToastProvider = ToastProvider;
|
|
@@ -501,6 +529,7 @@ exports.useCurrentUser = useCurrentUser;
|
|
|
501
529
|
exports.useCustomFieldRuntime = useCustomFieldRuntime;
|
|
502
530
|
exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
|
|
503
531
|
exports.useEnvironment = useEnvironment;
|
|
532
|
+
exports.useFilterBarContext = useFilterBarContext;
|
|
504
533
|
exports.useGlobalSelection = useGlobalSelection;
|
|
505
534
|
exports.useNavigationRuntime = useNavigationRuntime;
|
|
506
535
|
exports.useOemBrandingContext = useOemBrandingContext;
|
package/index.esm.js
CHANGED
|
@@ -98,6 +98,33 @@ const useEnvironment = () => {
|
|
|
98
98
|
return context;
|
|
99
99
|
};
|
|
100
100
|
|
|
101
|
+
const FilterBarContext = React.createContext(null);
|
|
102
|
+
/**
|
|
103
|
+
* This is a hook to use the FilterBarProvider.
|
|
104
|
+
*
|
|
105
|
+
* @requires FilterBarProvider
|
|
106
|
+
* @example
|
|
107
|
+
* import { useFilterBar } from "@trackunit/react-core-hooks";
|
|
108
|
+
*
|
|
109
|
+
* export const useFilterBarValues = () => {
|
|
110
|
+
* const { filterBarValues } = useFilterBar();
|
|
111
|
+
*
|
|
112
|
+
* ...
|
|
113
|
+
* };
|
|
114
|
+
* @see {@link IFilterBarContext}
|
|
115
|
+
*/
|
|
116
|
+
const useFilterBarContext = () => {
|
|
117
|
+
const context = React.useContext(FilterBarContext);
|
|
118
|
+
if (!context) {
|
|
119
|
+
throw new Error("useFilterBar must be used within the FilterBarContext");
|
|
120
|
+
}
|
|
121
|
+
return context;
|
|
122
|
+
};
|
|
123
|
+
/**
|
|
124
|
+
* This is a provider for the FilterBarContext.
|
|
125
|
+
*/
|
|
126
|
+
const FilterBarProvider = (props) => jsx(FilterBarContext.Provider, Object.assign({}, props));
|
|
127
|
+
|
|
101
128
|
const GlobalSelectionContext = React.createContext(null);
|
|
102
129
|
/**
|
|
103
130
|
* This is a hook to use the GlobalSelectionContext.
|
|
@@ -458,4 +485,4 @@ const useCurrentUser = () => {
|
|
|
458
485
|
return context;
|
|
459
486
|
};
|
|
460
487
|
|
|
461
|
-
export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
|
|
488
|
+
export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trackunit/react-core-hooks",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.91",
|
|
4
4
|
"repository": "https://github.com/Trackunit/manager",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"engines": {
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
"module": "./index.esm.js",
|
|
10
10
|
"main": "./index.cjs.js",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@trackunit/iris-app-runtime-core": "0.3.
|
|
13
|
-
"@trackunit/iris-app-runtime-core-api": "0.3.
|
|
14
|
-
"@trackunit/react-core-contexts-api": "0.2.
|
|
12
|
+
"@trackunit/iris-app-runtime-core": "0.3.73",
|
|
13
|
+
"@trackunit/iris-app-runtime-core-api": "0.3.66",
|
|
14
|
+
"@trackunit/react-core-contexts-api": "0.2.56",
|
|
15
15
|
"@trackunit/shared-utils": "0.0.7",
|
|
16
16
|
"react": "18.2.0",
|
|
17
17
|
"react-router-dom": "6.11.2"
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { IFilterBarContext } from "@trackunit/react-core-contexts-api";
|
|
2
|
+
import * as React from "react";
|
|
3
|
+
/**
|
|
4
|
+
* This is a hook to use the FilterBarProvider.
|
|
5
|
+
*
|
|
6
|
+
* @requires FilterBarProvider
|
|
7
|
+
* @example
|
|
8
|
+
* import { useFilterBar } from "@trackunit/react-core-hooks";
|
|
9
|
+
*
|
|
10
|
+
* export const useFilterBarValues = () => {
|
|
11
|
+
* const { filterBarValues } = useFilterBar();
|
|
12
|
+
*
|
|
13
|
+
* ...
|
|
14
|
+
* };
|
|
15
|
+
* @see {@link IFilterBarContext}
|
|
16
|
+
*/
|
|
17
|
+
export declare const useFilterBarContext: () => IFilterBarContext;
|
|
18
|
+
interface IProps {
|
|
19
|
+
value: IFilterBarContext;
|
|
20
|
+
children?: React.ReactNode;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* This is a provider for the FilterBarContext.
|
|
24
|
+
*/
|
|
25
|
+
export declare const FilterBarProvider: (props: IProps) => JSX.Element;
|
|
26
|
+
export {};
|
package/src/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./analytics/AnalyticsProvider";
|
|
2
2
|
export * from "./assetSorting/AssetSortingProvider";
|
|
3
3
|
export * from "./environment/EnvironmentContextProvider";
|
|
4
|
+
export * from "./filter-bar/FilterBarProvider";
|
|
4
5
|
export * from "./global-selection/GlobalSelectionProvider";
|
|
5
6
|
export * from "./irisOemApp/IrisOemAppContextProvider";
|
|
6
7
|
export * from "./runtimes/navigation";
|