@hortiview/default-components 0.0.11202 → 0.0.11919

package/README.md

@@ -1,50 +1,55 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
-```
-
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
-```
+# Hortiview Default Components
+
+This is a component library that provides default components that posess default translations for the basic languages used in the HortiView Platform.
+
+Supported languages are currently: English, spanish and turkish.
+
+## Install
+
+`npm i @hortiview/default-components`
+
+`yarn add @hortiview/default-components`
+
+## Remarks
+
+This 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 Components
+
+1. [DefaultFormNumber](#defaultformnumber)
+1. [DefaultLoadingSpinner](#defaultloadingspinner)
+1. [HealthCheckComponents](#healthcheckcomponents)
+   1. [DataBaseHealthCheck](#databasehealthcheck)
+   1. [DefaultHealthCheck](#defaulthealthcheck)
+   1. [IotServiceHealthCheck](#iotservicehealthcheck)
+   1. [PlatformHealthCheck](#platformhealthcheck)
+1. [ImpatienceLoadingSpinner](#impatienceloadingspinner)
+
+## Available Components
+
+### DefaultFormNumber
+
+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.
+
+### DefaultLoadingSpinner
+
+Renders a loading spinner. The loading spinner can be customized in size and color. It can also be centered.
+
+### 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.
+
+If a custom text and type should be displayed please use the shared component `<HealthCheckFailed />` and provide a custom `title` and `subtitle`.
+
+#### DataBaseHealthCheck
+
+#### DefaultHealthCheck
+
+#### IotServiceHealthCheck
+
+#### PlatformHealthCheck
+
+### 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.