@hortiview/shared-components 0.0.9178 → 0.0.9183

package/README.md

@@ -21,7 +21,7 @@ For the best experience use [react-router](https://reactrouter.com/en/main) in y
 
 Additionally the library provides form components using [react-hook-form](https://react-hook-form.com/get-started). When you want to use these components please install `react-hook-form` before using them.
 
-## Available packages:
+## Available Components:
 
 1. [AlertBanner](#alertbanner)
 1. [BaseView](#baseview)
@@ -53,6 +53,14 @@ Additionally the library provides form components using [react-hook-form](https:
 1. [SearchBar](#searchbar)
 1. [VerticalDivider](#verticaldivider)
 
+## Available Utility Functions:
+
+1. [useBreakpoints](#usebreakpoints)
+1. [capitalizeFirstLetters](#capitalizefirstletters)
+1. [trimLeadingAndTrailingSpaces](#trimleadingandtrailingspaces)
+
+## Available Components:
+
 ### AlertBanner
 
 Presents an Banner containing important messages. Can used in different colors and you can add an optional action.
@@ -773,3 +781,56 @@ import { VerticalDivider } from '@hortiview/shared-components';
 
 <VerticalDivider className={'custom'} height='3rem' />;
 ```
+
+## Available Utility Functions:
+
+### useBreakpoints
+
+Hook that returns the current breakpoint. It uses the following breakpoints:
+
+- xs: 0-599px
+- sm: 600-719px
+- md: 720-839px
+- lg: 840-1023px
+- xl: 1024-1439px
+- xxl: 1440px and up
+
+Additional breakpoints considering the navbar width
+
+- lg-nav: (840 + 256) - (1023 + 256)px
+- xl-nav: (1024 + 256) - (1439 + 256)px
+- xxl-nav: (1440 + 256)px and up
+
+They are combined as follows:
+
+- isMobile: xs
+- isTablet: sm, md
+- isDesktop: lg, xl, xxl
+- isDesktopNavbar: lg-nav, xl-nav, xxl-nav
+
+### capitalizeFirstLetters
+
+Capitalizes the first letter of every word in a given text string
+
+### trimLeadingAndTrailingSpaces
+
+This function can be used when sending form data to the BE (see the example below).
+It removes leading and trailing spaces from all object properties that are typeof string.
+
+```typescript
+const onSubmit = async (data: Record<string, string>) => {
+  const trimmedData = trimLeadingAndTrailingSpaces(data);
+
+  const loginResponse = await login(trimmedData.email, trimmedData.password);
+  if (loginResponse.ok) {
+    console.log('logged in');
+  }
+};
+```
+
+Important note: If the type from the data is an interface the data need to be spread to avoid the following error.
+https://github.com/microsoft/TypeScript/issues/15300
+
+```typescript
+const trimmedData = trimLeadingAndTrailingSpaces({ ...data });
+```

package/dist/main.d.ts

@@ -29,7 +29,7 @@ export { FormText } from './components/FormComponents/FormText/FormText';
 export { AvailableCustomIcons } from './enums/AvailableCustomIcons';
 export { ThemeColor } from './enums/ThemeColor';
 export { useBreakpoints } from './hooks/useBreakpoints';
-export { capitalizeFirstLetters } from './services/UtilService';
+export { capitalizeFirstLetters, trimLeadingAndTrailingSpaces } from './services/UtilService';
 export type { ActionProps } from './components/ContextMenu/ContextMenu';
 export type { FormSelectOption } from './components/FormComponents/FormSelect/FormSelect';
 export type { FormTextProps } from './components/FormComponents/FormText/FormText';

package/dist/main.js

@@ -3,18 +3,18 @@ import { AlertBanner as t } from "./components/AlertBanner/AlertBanner.js";
 import { BaseView as p } from "./components/BaseView/BaseView.js";
 import { BasicHeading as x } from "./components/BasicHeading/BasicHeading.js";
 import { BlockView as a } from "./components/BlockView/BlockView.js";
-import { ChipCard as c } from "./components/ChipCard/ChipCard.js";
+import { ChipCard as n } from "./components/ChipCard/ChipCard.js";
 import { ContextMenu as s } from "./components/ContextMenu/ContextMenu.js";
 import { DeleteModal as F } from "./components/DeleteModal/DeleteModal.js";
-import { Disclaimer as C } from "./components/Disclaimer/Disclaimer.js";
-import { EmptyView as b } from "./components/EmptyView/EmptyView.js";
-import { Filter as u } from "./components/Filter/Filter.js";
-import { GenericTable as T } from "./components/GenericTable/GenericTable.js";
-import { HashTabView as k } from "./components/HashTabView/HashTabView.js";
-import { HeaderFilter as I } from "./components/HeaderFilter/HeaderFilter.js";
-import { I as A } from "./Iconify-DV7QhHmp.js";
-import { InfoGroup as L } from "./components/InfoGroup/InfoGroup.js";
-import { ListArea as g } from "./components/ListArea/ListArea.js";
+import { Disclaimer as S } from "./components/Disclaimer/Disclaimer.js";
+import { EmptyView as T } from "./components/EmptyView/EmptyView.js";
+import { Filter as h } from "./components/Filter/Filter.js";
+import { GenericTable as w } from "./components/GenericTable/GenericTable.js";
+import { HashTabView as g } from "./components/HashTabView/HashTabView.js";
+import { HeaderFilter as A } from "./components/HeaderFilter/HeaderFilter.js";
+import { I } from "./Iconify-DV7QhHmp.js";
+import { InfoGroup as v } from "./components/InfoGroup/InfoGroup.js";
+import { ListArea as M } from "./components/ListArea/ListArea.js";
 import { LoadingSpinner as G } from "./components/LoadingSpinner/Default/LoadingSpinner.js";
 import { Modal as E } from "./components/Modal/Modal.js";
 import { OverflowTooltip as P } from "./components/OverflowTooltip/OverflowTooltip.js";
@@ -30,31 +30,31 @@ import { FormText as mr } from "./components/FormComponents/FormText/FormText.js
 import { AvailableCustomIcons as fr } from "./enums/AvailableCustomIcons.js";
 import { ThemeColor as ir } from "./enums/ThemeColor.js";
 import { u as lr } from "./useBreakpoints-MzTZ0tCT.js";
-import { capitalizeFirstLetters as nr } from "./services/UtilService.js";
+import { capitalizeFirstLetters as cr, trimLeadingAndTrailingSpaces as sr } from "./services/UtilService.js";
 export {
   t as AlertBanner,
   fr as AvailableCustomIcons,
   p as BaseView,
   x as BasicHeading,
   a as BlockView,
-  c as ChipCard,
+  n as ChipCard,
   s as ContextMenu,
   F as DeleteModal,
-  C as Disclaimer,
-  b as EmptyView,
-  u as Filter,
+  S as Disclaimer,
+  T as EmptyView,
+  h as Filter,
   Q as FormCheckBox,
   W as FormDatePicker,
   _ as FormRadio,
   rr as FormSelect,
   er as FormSlider,
   mr as FormText,
-  T as GenericTable,
-  k as HashTabView,
-  I as HeaderFilter,
-  A as Iconify,
-  L as InfoGroup,
-  g as ListArea,
+  w as GenericTable,
+  g as HashTabView,
+  A as HeaderFilter,
+  I as Iconify,
+  v as InfoGroup,
+  M as ListArea,
   G as LoadingSpinner,
   E as Modal,
   P as OverflowTooltip,
@@ -63,6 +63,7 @@ export {
   q as SearchBar,
   ir as ThemeColor,
   K as VerticalDivider,
-  nr as capitalizeFirstLetters,
+  cr as capitalizeFirstLetters,
+  sr as trimLeadingAndTrailingSpaces,
   lr as useBreakpoints
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hortiview/shared-components",
   "description": "This is a shared component library. It should used in the HortiView platform and its modules.",
-  "version": "0.0.9178",
+  "version": "0.0.9183",
   "type": "module",
   "repository": "https://dev.azure.com/sdundc/HV%20Platform/_git/HortiView-Frontend-Shared",
   "author": "Falk Menge <falk.menge.ext@bayer.com>",