@trackunit/react-core-hooks 0.2.80 → 0.2.83-alpha-bfdefa6ec9.0

package/index.cjs.js

@@ -6,6 +6,7 @@ var React = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
 var reactRouterDom = require('react-router-dom');
+var sharedUtils = require('@trackunit/shared-utils');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -434,6 +435,26 @@ const TokenProvider = (props) => {
     return jsxRuntime.jsx(TokenContext.Provider, Object.assign({}, props));
 };
 
+/**
+ * Hook for filtering a list of items by text search, client side search in a list.
+ *
+ * @param items The list of items to filter.
+ * @param props The properties to search in each item.
+ * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @example
+ * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
+ */
+function useTextSearch(items, props) {
+    const [searchText, setSearchText] = React.useState("");
+    const result = React.useMemo(() => {
+        if (!searchText) {
+            return items;
+        }
+        return sharedUtils.filterByMultiple(items, props, searchText);
+    }, [items, props, searchText]);
+    return [result, searchText, setSearchText];
+}
+
 const CurrentUserContext = React__namespace.createContext(null);
 /**
  * This is a provider for the CurrentUserContext.
@@ -485,6 +506,7 @@ exports.useNavigationRuntime = useNavigationRuntime;
 exports.useOemBrandingContext = useOemBrandingContext;
 exports.useRestRuntime = useRestRuntime;
 exports.useSiteRuntime = useSiteRuntime;
+exports.useTextSearch = useTextSearch;
 exports.useToast = useToast;
 exports.useToken = useToken;
 exports.useURLSynchronization = useURLSynchronization;

package/index.esm.js

@@ -1,8 +1,9 @@
 import * as React from 'react';
-import React__default, { createContext, useContext, useState, useEffect } from 'react';
+import React__default, { createContext, useContext, useState, useEffect, useMemo } from 'react';
 import { jsx } from 'react/jsx-runtime';
 import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { useLocation } from 'react-router-dom';
+import { filterByMultiple } from '@trackunit/shared-utils';
 
 const AnalyticsContext = createContext(null);
 const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
@@ -408,6 +409,26 @@ const TokenProvider = (props) => {
     return jsx(TokenContext.Provider, Object.assign({}, props));
 };
 
+/**
+ * Hook for filtering a list of items by text search, client side search in a list.
+ *
+ * @param items The list of items to filter.
+ * @param props The properties to search in each item.
+ * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @example
+ * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
+ */
+function useTextSearch(items, props) {
+    const [searchText, setSearchText] = useState("");
+    const result = useMemo(() => {
+        if (!searchText) {
+            return items;
+        }
+        return filterByMultiple(items, props, searchText);
+    }, [items, props, searchText]);
+    return [result, searchText, setSearchText];
+}
+
 const CurrentUserContext = React.createContext(null);
 /**
  * This is a provider for the CurrentUserContext.
@@ -437,4 +458,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.80",
+  "version": "0.2.83-alpha-bfdefa6ec9.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,9 +9,10 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.65",
-    "@trackunit/iris-app-runtime-core-api": "0.3.58",
-    "@trackunit/react-core-contexts-api": "0.2.52",
+    "@trackunit/iris-app-runtime-core": "0.3.67-alpha-bfdefa6ec9.0",
+    "@trackunit/iris-app-runtime-core-api": "0.3.60-alpha-bfdefa6ec9.0",
+    "@trackunit/react-core-contexts-api": "0.2.53-alpha-bfdefa6ec9.0",
+    "@trackunit/shared-utils": "0.0.3-alpha-bfdefa6ec9.0",
     "react": "18.2.0",
     "react-router-dom": "6.11.2"
   },

package/src/index.d.ts

@@ -13,4 +13,5 @@ export * from "./runtimes/useSiteRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";
+export * from "./useTextSearch";
 export * from "./user/CurrentUserProvider";

package/src/useTextSearch.d.ts

@@ -0,0 +1,12 @@
+import { Maybe } from "@trackunit/shared-utils";
+import { Dispatch } from "react";
+/**
+ * Hook for filtering a list of items by text search, client side search in a list.
+ *
+ * @param items The list of items to filter.
+ * @param props The properties to search in each item.
+ * @returns A tuple with the filtered items, the search text and a setter for the search text.
+ * @example
+ * const [result, searchText, setSearchText] = useTextSearch(items, item => [item.name, item.description]);
+ */
+export declare function useTextSearch<T>(items: T[], props: (item: T) => Maybe<string>[]): [T[], string, Dispatch<string>];