@hortiview/default-components 0.0.11919 → 0.0.11933

package/README.md

@@ -31,10 +31,46 @@ This library provides form components using [react-hook-form](https://react-hook
 
 Number input field that formats the users input depending on the input language. The component automatically sets the language specific thousand separators and only allows the language specific decimal separator.
 
+```tsx
+import { DefaultFormNumber } from '@hortiview/default-components';
+import { FormProvider, SubmitHandler, useForm } from 'react-hook-form';
+
+const formMethods = useForm<{ birthday: string }>({
+  mode: 'onSubmit',
+});
+
+const { handleSubmit } = formMethods;
+
+<FormProvider {...formMethods}>
+  <form onSubmit={handleSubmit(onSubmit)}>
+    <DefaultFormNumber<{ price: number }>
+      propertyName='price'
+      label='module.price'
+      decimalScale={5}
+      fixedDecimalScale={true}
+      allowNegative={false}
+      allowLeadingZeros={false}
+      prefix=' €'
+    />
+  </form>
+</FormProvider>;
+```
+
 ### DefaultLoadingSpinner
 
 Renders a loading spinner. The loading spinner can be customized in size and color. It can also be centered.
 
+```TSX
+import { DefaultLoadingSpinner } from  '@hortiview/default-components';
+
+const [isLoading, setIsLoading] = useState(false)
+
+/** add logic that changes state of isLoading */
+
+if (isLoading) return <DefaultLoadingSpinner />
+return <DefaultComponent />
+```
+
 ### HealthCheckComponents
 
 A screen that shows a health check failed message. It can be used if the check for database health, iot health or HV platform health fails. Please use the default components provided here to ensure a consistent user experience for the HV platform.
@@ -43,13 +79,68 @@ If a custom text and type should be displayed please use the shared component `<
 
 #### DataBaseHealthCheck
 
-#### DefaultHealthCheck
+```TSX
+import { DataBaseHealthCheck } from  '@hortiview/default-components';
+
+const [isHealthy, setIsHealthy] = useState(false)
+
+/** add logic that changes state of isHealthy */
+
+if (!isHealthy) return <DataBaseHealthCheck />
+return <DefaultComponent />
+```
+
+#### DataBaseHealthCheck
+
+```TSX
+import { DataBaseHealthCheck } from  '@hortiview/default-components';
+
+const [isHealthy, setIsHealthy] = useState(false)
+
+/** add logic that changes state of isHealthy */
+
+if (!isHealthy) return <DataBaseHealthCheck />
+return <DefaultComponent />
+```
 
 #### IotServiceHealthCheck
 
+```TSX
+import { IotServiceHealthCheck } from  '@hortiview/default-components';
+
+const [isHealthy, setIsHealthy] = useState(false)
+
+/** add logic that changes state of isHealthy */
+
+if (!isHealthy) return <IotServiceHealthCheck />
+return <DefaultComponent />
+```
+
 #### PlatformHealthCheck
 
+```TSX
+import { PlatformHealthCheck } from  '@hortiview/default-components';
+
+const [isHealthy, setIsHealthy] = useState(false)
+
+/** add logic that changes state of isHealthy */
+
+if (!isHealthy) return <PlatformHealthCheck />
+return <DefaultComponent />
+```
+
 ### ImpatienceLoadingSpinner
 
 This Loading spinner will automatically change to a specific text, after a certain waiting time, the time is adjustable.
 The default waiting time are 10 seconds.
+
+```TSX
+import { ImpatienceLoadingSpinner } from  '@hortiview/default-components';
+
+const [isLoading, setIsLoading] = useState(false)
+
+/** add logic that changes state of isLoading */
+
+if (isLoading) return <ImpatienceLoadingSpinner />
+return <DefaultComponent />
+```

package/dist/components/DefaultFormNumber/DefaultFormNumber.d.ts

@@ -0,0 +1,5 @@
+import { FormNumberProps } from '@hortiview/shared-components/dist/components/FormComponents/FormNumber/FormNumber';
+import { FieldValues } from 'react-hook-form';
+
+export type DefaultFormNumberProps<T extends FieldValues> = Omit<FormNumberProps<T>, 'languageCode' | 'helperText'>;
+export declare const DefaultFormNumber: <T extends FieldValues>({ ...props }: DefaultFormNumberProps<T>) => import("react/jsx-runtime").JSX.Element;

package/dist/components/DefaultLoadingSpinner/DefaultLoadingSpinner.d.ts

@@ -0,0 +1,5 @@
+import { LoadingSpinnerProps } from '@hortiview/shared-components';
+
+type DefaultLoadingSpinnerProps = Omit<LoadingSpinnerProps, 'text'>;
+export declare const DefaultLoadingSpinner: ({ ...props }: DefaultLoadingSpinnerProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/HealthChecks/DataBaseHealthCheck.d.ts

@@ -0,0 +1,5 @@
+import { HealthCheckFailedProps } from '@hortiview/shared-components';
+
+type DataBaseHealthCheckProps = Omit<HealthCheckFailedProps, 'title' | 'subtitle' | 'type'>;
+export declare const DataBaseHealthCheck: ({ ...props }: DataBaseHealthCheckProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/HealthChecks/DefaultHealthCheck.d.ts

@@ -0,0 +1,5 @@
+import { HealthCheckFailedProps } from '@hortiview/shared-components';
+
+type DefaultHealthCheckProps = Omit<HealthCheckFailedProps, 'title' | 'subtitle' | 'type'>;
+export declare const DefaultHealthCheck: ({ ...props }: DefaultHealthCheckProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/HealthChecks/IotServiceHealthCheck.d.ts

@@ -0,0 +1,5 @@
+import { HealthCheckFailedProps } from '@hortiview/shared-components';
+
+type IotServiceHealthCheckProps = Omit<HealthCheckFailedProps, 'title' | 'subtitle' | 'type'>;
+export declare const IotServiceHealthCheck: ({ ...props }: IotServiceHealthCheckProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/HealthChecks/PlatformHealthCheck.d.ts

@@ -0,0 +1,5 @@
+import { HealthCheckFailedProps } from '@hortiview/shared-components';
+
+type PlatformHealthCheckProps = Omit<HealthCheckFailedProps, 'title' | 'subtitle' | 'type'>;
+export declare const PlatformHealthCheck: ({ ...props }: PlatformHealthCheckProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/ImpatienceLoadingSpinner/ImpatienceLoadingSpinner.d.ts

@@ -0,0 +1,5 @@
+import { LoadingSpinnerProps } from '@hortiview/shared-components';
+
+type ImpatienceLoadingSpinnerProps = Omit<LoadingSpinnerProps, 'impatienceMessage' | 'text'>;
+export declare const ImpatienceLoadingSpinner: ({ ...props }: ImpatienceLoadingSpinnerProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/InternationalizationWrapper/InternationalizationWrapper.d.ts

@@ -0,0 +1,15 @@
+import { PropsWithChildren } from 'react';
+import { AVAILABLE_LOCALES } from '@hortiview/shared-components';
+
+export type InternationalizationWrapperProps = PropsWithChildren;
+/**
+ * Warpper to provide i18n context to children
+ * @param children
+ * @returns
+ */
+export declare const InternationalizationWrapper: ({ children }: InternationalizationWrapperProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * a hook to handle the language change of this i18next instance
+ * @param currentLanguage
+ */
+export declare const useChangeDefaultComponentsLanguage: (currentLanguage: (typeof AVAILABLE_LOCALES)[number]) => void;

package/dist/i18n.d.ts

@@ -0,0 +1,2 @@
+declare const i18n: import('i18next').i18n;
+export default i18n;

package/dist/locales/en-US.json.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+  "loadingSpinner": {
+    "baseMessage": "Loading...",
+    "impatienceMessage": "This is taking longer than expected. Please be patient."
+  },
+  "healthCheck": {
+    "default": "Sorry, something went wrong!",
+    "defaultSubtitle": "The problem is being addressed by our technical team. Please come back later.",
+    "dataBase": "The data for this module is loading!",
+    "dataBaseSubtitle": "Please wait or come back later.",
+    "platform": "The platform data used by this module cannot be retrieved currently.",
+    "platformSubtitle": "Please wait or come back later.",
+    "iotService": "The data of your devices cannot be retrieved currently.",
+    "iotServiceSubtitle": "The problem is being addressed by our technical team. Please come back later."
+  },
+  "formNumber": {
+    "separator": "Please use a period as a decimal separator, e.g. 12,345.67"
+  }
+}
+;
+
+export default _default;

package/dist/locales/es-MX.json.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+  "formNumber": {
+    "separator": "Utilice un período como separador decimal, p. 12,345.67"
+  },
+  "healthCheck": {
+    "basic": "Lo siento, algo salió mal!",
+    "basicSubtitle": "El problema está siendo abordado por nuestro equipo técnico. Vuelve más tarde.",
+    "dataBase": "¡Los datos para este módulo se están cargando!",
+    "dataBaseSubtitle": "Espere o vuelva más tarde.",
+    "iotService": "Los datos de sus dispositivos no se pueden recuperar actualmente.",
+    "iotServiceSubtitle": "El problema está siendo abordado por nuestro equipo técnico. Vuelve más tarde.",
+    "platform": "Los datos de la plataforma utilizados por este módulo no se pueden recuperar actualmente.",
+    "platformSubtitle": "Espere o vuelva más tarde."
+  },
+  "loadingSpinner": {
+    "baseMessage": "Cargando...",
+    "impatienceMessage": "Esto está tardando más de lo esperado. Por favor, sea paciente."
+  }
+}
+;
+
+export default _default;

package/dist/locales/tr-TR.json.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+  "formNumber": {
+    "separator": "Lütfen ondalık ayırıcı olarak virgül kullanın, ör. 12.345,67"
+  },
+  "healthCheck": {
+    "basic": "Üzgünüm, bir şeyler ters gitti!",
+    "basicSubtitle": "Sorun teknik ekibimiz tarafından ele alınmaktadır. Lütfen daha sonra tekrar gelin.",
+    "dataBase": "Bu modül için veriler yükleniyor!",
+    "dataBaseSubtitle": "Lütfen bekleyin veya daha sonra geri dönün.",
+    "iotService": "Cihazlarınızın verileri şu anda alınamaz.",
+    "iotServiceSubtitle": "Sorun teknik ekibimiz tarafından ele alınmaktadır. Lütfen daha sonra tekrar gelin.",
+    "platform": "Bu modül tarafından kullanılan platform verileri şu anda alınamaz.",
+    "platformSubtitle": "Lütfen bekleyin veya daha sonra geri dönün."
+  },
+  "loadingSpinner": {
+    "baseMessage": "Yükleme ...",
+    "impatienceMessage": "Bu beklenenden daha uzun sürüyor. Lütfen sabırlı olun."
+  }
+}
+;
+
+export default _default;

package/dist/main.d.ts

@@ -0,0 +1,14 @@
+export { DefaultFormNumber } from './components/DefaultFormNumber/DefaultFormNumber';
+export { DefaultLoadingSpinner } from './components/DefaultLoadingSpinner/DefaultLoadingSpinner';
+export { ImpatienceLoadingSpinner } from './components/ImpatienceLoadingSpinner/ImpatienceLoadingSpinner';
+/** default health checks */
+export { DataBaseHealthCheck } from './components/HealthChecks/DataBaseHealthCheck';
+export { DefaultHealthCheck } from './components/HealthChecks/DefaultHealthCheck';
+export { IotServiceHealthCheck } from './components/HealthChecks/IotServiceHealthCheck';
+export { PlatformHealthCheck } from './components/HealthChecks/PlatformHealthCheck';
+/**
+ * the following hook is called in the HV main frame to
+ * set the language from the default components accordingly
+ * to the main i18next instance
+ */
+export { useChangeDefaultComponentsLanguage } from './components/InternationalizationWrapper/InternationalizationWrapper';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hortiview/default-components",
   "description": "This is a component library that should be used in the HortiView platform and its modules. The components provided here have default translation strings.",
-  "version": "0.0.11919",
+  "version": "0.0.11933",
   "type": "module",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -15,6 +15,12 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "keywords": [
+    "HortiView",
+    "React",
+    "TranslatedComponents",
+    "ComponentLibrary"
+  ],
   "scripts": {
     "dev": "vite",
     "build": "tsc --p ./tsconfig-build.json && vite build",
@@ -30,7 +36,8 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-hook-form": "^7.51.2",
-    "react-router-dom": "^6.22.3"
+    "react-router-dom": "^6.22.3",
+    "@hortiview/shared-components": "^0.0.11881"
   },
   "devDependencies": {
     "@element-public/react-components": "2.0.0-alpha.1",
@@ -39,14 +46,14 @@
     "@hortiview/shared-components": "^0.0.11881",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
-    "@storybook/addon-essentials": "^8.5.3",
-    "@storybook/addon-interactions": "^8.5.3",
-    "@storybook/addon-links": "^8.5.3",
-    "@storybook/addon-onboarding": "^8.5.3",
-    "@storybook/blocks": "^8.5.3",
-    "@storybook/react": "^8.5.3",
-    "@storybook/react-vite": "^8.5.3",
-    "@storybook/test": "^8.5.3",
+    "@storybook/addon-essentials": "8.5.3",
+    "@storybook/addon-interactions": "8.5.3",
+    "@storybook/addon-links": "8.5.3",
+    "@storybook/addon-onboarding": "8.5.3",
+    "@storybook/blocks": "8.5.3",
+    "@storybook/react": "8.5.3",
+    "@storybook/react-vite": "8.5.3",
+    "@storybook/test": "8.5.3",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.2.0",
@@ -78,11 +85,11 @@
     "react-number-format": "^5.4.3",
     "react-router-dom": "^6.22.3",
     "rollup-plugin-copy": "^3.5.0",
-    "storybook": "^8.5.3",
+    "storybook": "8.5.3",
     "typescript": "~5.6.2",
     "typescript-eslint": "^8.18.2",
-    "vite": "^6.0.5",
-    "vite-plugin-dts": "^4.5.0",
+    "vite": "6.1.0",
+    "vite-plugin-dts": "3.9.1",
     "vite-plugin-lib-inject-css": "^2.2.1",
     "vite-plugin-svgr": "^4.3.0",
     "vitest": "^3.0.5"