ngx-gp-components-dev-test 0.0.1

package/README.md

@@ -0,0 +1,74 @@
+# GP - Components
+
+A library providing standard UI components to be used in widgets. All widgets should consist of these components to ensure uniform and recognizable UI experience across all widgets.
+
+## Building
+
+To build the library, run:
+
+```bash
+ng build ngx-gp-components
+```
+
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+
+### Publishing the Library
+
+Once the project is built, you can publish your library by following these steps:
+
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/ngx-gp-components
+   ```
+
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
+
+## Running unit tests
+
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+
+```bash
+ng test
+```
+
+## Localization
+
+To use localization, add the following to your `angular.json` file:
+
+```json 
+{
+  "architect": {
+    "build": {
+      "options": {
+        "assets": [
+          "...",
+          {
+            "glob": "**/*.json",
+            "input": "path to localization files in project",
+            "output": "assets/i18n"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+The localization files should be in the following format:
+```json
+{
+  "hello": "Hallo",
+  "world": "Welt"
+}
+```
+The standard localization file is German/'de' and the naming convention is messages.\<language>.json 
+
+To get the localized string, use the following method:
+```typescript
+getLocalizedString(key)
+```
+
+For the above json file, calling `getLocalizedString('hello')` will return 'Hallo'.