@ng-formworks/bootstrap5 15.2.7

package/README.md

@@ -0,0 +1,228 @@
+# @ng-formworks/bootstrap5
+This module is a dependency of the [ng-formworks project][npm_core_ver] and is meant to work as a framework installation module for using Bootstrap 5 in the forms.
+
+## Getting started
+
+If you are unfamiliar with with the ng-formworks project, it is highly recommended to 
+first have a look at the [@ng-formworks pages][npm_core_ver] for examples, demos, options and documentation.
+
+```shell
+npm install @ng-formworks/core@latest @ng-formworks/cssframework@latest @ng-formworks/bootstrap5@latest
+```
+
+With YARN, run the following:
+
+```shell
+yarn add @ng-formworks/core@latest @ng-formworks/cssframework@latest @ng-formworks/bootstrap5@latest
+```
+
+Then import `Bootstrap5FrameworkModule` in your main application module if you want to use `bootstrap5` UI, like this:
+
+```javascript
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+
+import { Bootstrap5FrameworkModule } from '@ng-formworks/bootstrap5';
+
+import { AppComponent } from './app.component';
+
+@NgModule({
+  declarations: [ AppComponent ],
+  imports: [
+    Bootstrap5FrameworkModule
+  ],
+  providers: [],
+  bootstrap: [ AppComponent ]
+})
+export class AppModule { }
+```
+
+For basic use, after loading JsonSchemaFormModule as described above, to display a form in your Angular component, simply add the following to your component's template:
+
+```html
+<json-schema-form
+  loadExternalAssets="true"
+  [schema]="yourJsonSchema"
+  framework="bootstrap-5"
+  [theme]="yourTheme"
+  (onSubmit)="yourOnSubmitFn($event)">
+</json-schema-form>
+```
+
+Where `schema` is a valid JSON schema object, and `onSubmit` calls a function to process the submitted JSON form data. If you don't already have your own schemas, you can find a bunch of samples to test with in the `demo/assets/example-schemas` folder, as described above.
+
+`framework` is for the template you want to use, the default value is `no-framwork`. The possible values are:
+
+* `material-design` for  Material Design (if installed).
+* `bootstrap-3` for Bootstrap 3 (if installed).
+* `bootstrap-4` for Bootstrap 4 (if installed).
+* `bootstrap-5` for Bootstrap 5.
+* `daisyui` for DaisyUi (if installed).
+* `no-framework` for (plain HTML).
+
+`theme` is for the framework theme you want to use. 
+The possible values for this framework are:
+
+* `bootstrap5_default` for the default theme.
+* `light` for the light theme.
+* `dark` for the dark theme.
+
+the list of available themes can also be gotten using the 
+FrameworkLibraryService(found in '@ng-formworks/core'): 
+ ```typescript
+ getFrameworkThemes()
+ ``` 
+ method 
+
+## Custom theming
+
+Custom theming can be achieved in two ways:
+
+* the simplest is to overwrite the default theme(or any other themes) with css rules:
+css changes can be made using the `data-bs-theme` attribute selector
+so for example to change the .btn class of the default theme, you would
+include the following rule in your application's styles
+
+```css
+[data-bs-theme="bootstrap5_default"] .btn {
+    border-radius: 1rem
+}
+```
+
+* the other method is to add a new theme:
+the first step will be to create the entire theme (see the specific frameworks underlying documentation for how this can be done) and have it use the `data-bs-theme` attribute selector for example:
+
+```css
+[data-bs-theme="bootstrap5_custom"] {
+    background-color: green;
+    font: 15px Arial, sans-serif;
+    .
+    .
+    .
+}
+[data-bs-theme="bootstrap5_custom"] .btn {
+    border-color: coral;
+    .
+    .
+    .
+}
+
+```
+after making the css available, the theme will need to be registered using the  
+FrameworkLibraryService(found in '@ng-formworks/core'):
+for example 
+
+```typescript
+  constructor(
+    .
+    private frameworkLibrary: FrameworkLibraryService,
+    .
+    .
+  ) { 
+
+    frameworkLibrary.registerTheme({name:'bootstrap5_custom',text:'Bootstrap5 custom theme'})
+
+  }
+
+```
+
+## Framework assets
+
+Framework assets are typically third party assets (mainly js and css files) that are loaded at runtime for the particular framework's styling and effects to activate.
+By default these assets are loaded from built in cdn urls. These assets can also be self hosted or loaded from different urls if need be.
+To use custom urls the following steps must be followed:
+
+
+* create a file called assets.json somewhere in your app src folder
+* edit the assets.json file so that it contains both 'stylesheets' and 'scripts' properties-ex:
+
+```
+{
+
+    "stylesheets": [
+      "http://some.domain/css/style1.css",
+      "http://some.domain/css/style2.css",
+      "localstyle.css",
+      ...
+      ],
+    "scripts": [
+      "http://some.domain/css/script1.js",
+      "localscript.js",
+      ...
+    ]
+
+}
+
+```
+* adapt your apps angular.json assets config accordingly, for example:
+    
+```
+	"projects": {
+        "<your project name>": {
+			...
+            "architect": {
+                "build": {
+                    "builder": "@angular-devkit/build-angular:browser",
+                    "options": {
+                        ...
+                        "assets": [
+                            ...
+                            {
+                                "glob": "assets.json",
+                                "input": "src",
+                                "output": "/assets/bootstrap-5"
+                            },
+                            {
+                                "glob": "localstyle.css",
+                                "input": "./some/path/to/framework/cssfolder/",
+                                "output": "/assets/bootstrap-5/cssframework"
+                            },
+                            {
+                                "glob": "localscript.js",
+                                "input": "./some/path/to/framework/jsfolder/",
+                                "output": "/assets/bootstrap-5/cssframework"
+                            }
+                        ],
+						...
+```
+Note that relative asset urls will be assumed to reside under "/assets/bootstrap-5/cssframework" and the assets.json file must output to "/assets/bootstrap-5"
+
+for convenince a default assets.json file is included for including the framework assets
+from the node_modules folder, this assumes that the third party libraries were installed locally with npm and that they will reside in the "/assets/bootstrap-5/cssframework" deployment folder. In this case, the following config can be used and adapted similar to above:
+
+```
+...
+                        "assets": [
+                            ...
+                           {
+                                "glob": "**/*",
+                                "input": "./node_modules/@ng-formworks/bootstrap5/assets",
+                                "output": "/assets/bootstrap-5"
+                            },
+                            {
+                                "glob": "bootstrap.bundle.min.js",
+                                "input": "./node_modules/bootstrap/dist/js/",
+                                "output": "/assets/bootstrap-5/cssframework"
+                            },
+                            {
+                                "glob": "bootstrap.min.css",
+                                "input": "./node_modules/bootstrap/dist/css/",
+                                "output": "/assets/bootstrap-5/cssframework"
+                            }
+                        ],
+```
+
+## Code scaffolding
+
+Run `ng generate component component-name --project @ng-formworks/bootstrap5` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project @ng-formworks/bootstrap5`.
+> Note: Don't forget to add `--project @ng-formworks/bootstrap5` or else it will be added to the default project in your `angular.json` file.
+
+## Build
+
+Run `ng build @ng-formworks/bootstrap5` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Running unit tests
+
+Run `ng test @ng-formworks/bootstrap5` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+[npm_core_ver]:https://www.npmjs.com/package/@ng-formworks/core

package/assets/cssframework/assets.json

@@ -0,0 +1,6 @@
+{
+
+    "stylesheets": ["bootstrap.min.css"],
+    "scripts": ["bootstrap.bundle.min.js"]
+
+}

package/assets/cssframework/assets_cdn.json

@@ -0,0 +1,10 @@
+{
+
+    "scripts": [
+        "//cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"
+    ],
+    "stylesheets": [
+        "//cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css"
+    ]
+
+}

package/ng-package.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+    "dest": "../../dist/@ng-formworks/bootstrap5",
+    "lib": {
+        "entryFile": "src/public_api.ts"
+    },
+    "assets": ["./assets"],
+    "allowedNonPeerDependencies": [
+        "lodash-es",
+        "@ng-formworks/core",
+        "@ng-formworks/cssframework"
+    ]
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@ng-formworks/bootstrap5",
+    "version": "15.2.7",
+    "description": "Angular ng-formworks - JSON Schema Form builder using Bootstrap 5 UI",
+    "author": "https://github.com/zahmo/ng-formworks/graphs/contributors",
+    "keywords": [
+        "Angular",
+        "ng",
+        "Angular15",
+        "Angular 15",
+        "Angular16",
+        "Angular 16",
+        "Angular17",
+        "Angular 17",
+        "ng15",
+        "ng16",
+        "ng17",
+        "JSON Schema",
+        "form",
+        "forms",
+        "form builder",
+        "form themes",
+        "form generator",
+        "bootstrap",
+        "bootstrap 5",
+        "ajsf",
+        "ng-formworks",
+        "ng formworks",
+        "formworks",
+        "angular json schema form"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/zahmo/ng-formworks"
+    },
+    "bugs": {
+        "url": "https://github.com/zahmo/ng-formworks/issues"
+    },
+    "private": false,
+    "dependencies": {
+        "lodash-es": "~4.17.21",
+        "@ng-formworks/core": "~15.2.7",
+        "@ng-formworks/cssframework": "~15.2.7",
+        "tslib": "^2.0.0"
+    },
+    "peerDependencies": {
+        "@angular/common": ">=15.0.0",
+        "@angular/core": ">=15.0.0"
+    },
+    "devDependencies": {
+        "@types/lodash-es": "^4.17.6"
+    }
+}

package/src/lib/bootstrap5-cssframework.scss

@@ -0,0 +1,41 @@
+/*adapted from bootstrap 3 to fix input groups */
+
+.input-group .form-control:first-child,
+.input-group-text:first-child,
+.input-group-btn:first-child>.btn,
+.input-group-btn:first-child>.btn-group>.btn,
+.input-group-btn:first-child>.dropdown-toggle,
+.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle),
+.input-group-btn:last-child>.btn-group:not(:last-child)>.btn {
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+}
+
+.input-group-text:first-child {
+    border-right: 0;
+}
+
+.input-group .form-control:last-child,
+.input-group-text:last-child,
+.input-group-btn:last-child>.btn,
+.input-group-btn:last-child>.btn-group>.btn,
+.input-group-btn:last-child>.dropdown-toggle,
+.input-group-btn:first-child>.btn:not(:first-child),
+.input-group-btn:first-child>.btn-group:not(:first-child)>.btn {
+    border-top-left-radius: 0;
+    border-bottom-left-radius: 0;
+}
+
+.input-group-text:last-child {
+    border-left: 0;
+}
+
+.input-group .form-control:not(:first-child):not(:last-child),
+.input-group-text:not(:first-child):not(:last-child),
+.input-group-btn:not(:first-child):not(:last-child) {
+    border-radius: 0
+}
+
+.btn-close>span:first-child {
+    display: none;
+}

package/src/lib/bootstrap5-cssframework.ts

@@ -0,0 +1,107 @@
+import { css_fw } from "@ng-formworks/cssframework";
+
+export const cssFrameworkCfgBootstrap5:css_fw.frameworkcfg={
+
+    "name": "bootstrap-5",
+    "text":"Bootstrap 5",
+    "scripts": [
+        "//cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"
+    ],
+    "stylesheets": [
+        "//cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css",
+    ],
+    "widgetstyles": {
+        "__themes__": [
+            {"name":"bootstrap5_default","text":"Bootstrap5 default"},
+            {"name":"dark","text":"Dark"},
+            {"name":"light","text":"Light"}
+        ],
+        "$ref": {
+            "fieldHtmlClass": "btn float-end btn-info"
+        },
+        "__array_item_nonref__": {
+            "htmlClass": "list-group-item"
+        },
+        "__form_group__": {
+            "htmlClass": "form-group"
+        },
+        "__control_label__": {
+            "labelHtmlClass": "control-label"
+        },
+        "__active__": {
+            "activeClass": "active"
+        },
+        "__required_asterisk__": "text-danger",
+        "__screen_reader__": "visually-hidden",
+        "__remove_item__": "btn-close  float-end",
+        "__help_block__": "help-block",
+        "__field_addon_left__": "input-group-text",
+        "__field_addon_right__": "input-group-text",
+        "alt-date": {},
+        "alt-datetime": {},
+        "__array__": {
+            "htmlClass": "list-group"
+        },
+        "array": {},
+        "authfieldset": {},
+        "advancedfieldset": {},
+        "button": {
+            "fieldHtmlClass": "btn btn-sm btn-primary"
+        },
+        "checkbox": { "fieldHtmlClass": "checkbox" },
+        "checkboxes": {
+            "fieldHtmlClass": "checkbox"
+        },
+        "checkboxbuttons": {
+            "fieldHtmlClass": "visually-hidden",
+            "htmlClass": "btn-group",
+            "itemLabelHtmlClass": "btn"
+        },
+        "checkboxes-inline": {
+            "htmlClass": "checkbox",
+            "itemLabelHtmlClass": "checkbox-inline"
+        },
+        "date": {},
+        "datetime-local": {},
+        "fieldset": {},
+        "integer": {},
+        "number": {},
+        "optionfieldset": {},
+        "password": {},
+        "radiobuttons": {
+            "fieldHtmlClass": "visually-hidden",
+            "htmlClass": "btn-group",
+            "itemLabelHtmlClass": "btn"
+        },
+        "radio": { "fieldHtmlClass": "radio" },
+        "radios": {
+            "fieldHtmlClass": "radio"
+        },
+        "radios-inline": {
+            "htmlClass": "radio",
+            "itemLabelHtmlClass": "radio-inline"
+        },
+        "range": {},
+        "section": {},
+        "selectfieldset": {},
+        "select": {},
+        "submit": {
+            "fieldHtmlClass": "btn btn-primary"
+        },
+        "text": {},
+        "tabs": {
+            "labelHtmlClass": "nav nav-tabs",
+            "htmlClass": "tab-content",
+            "fieldHtmlClass": "tab-pane"
+        },
+        "tabarray": {
+            "labelHtmlClass": "nav nav-tabs",
+            "htmlClass": "tab-content",
+            "fieldHtmlClass": "tab-pane"
+        },
+        "textarea": {},
+        "default": {
+            "fieldHtmlClass": "form-control"
+        }
+    }
+}

package/src/lib/bootstrap5-framework.component.scss

@@ -0,0 +1,28 @@
+:host ::ng-deep {
+    .list-group-item .form-control-feedback {
+        top: 40px;
+    }
+    .checkbox,
+    .radio {
+        margin-top: 0;
+        margin-bottom: 0;
+    }
+    .checkbox-inline,
+    .checkbox-inline+.checkbox-inline,
+    .checkbox-inline+.radio-inline,
+    .radio-inline,
+    .radio-inline+.radio-inline,
+    .radio-inline+.checkbox-inline {
+        margin-left: 0;
+        margin-right: 10px;
+    }
+    .checkbox-inline:last-child,
+    .radio-inline:last-child {
+        margin-right: 0;
+    }
+    .ng-invalid.ng-touched {
+        border: 1px solid #f44336;
+    }
+}
+
+@import './bootstrap5-cssframework.scss';

package/src/lib/bootstrap5-framework.component.spec.ts

@@ -0,0 +1,39 @@
+import { CommonModule } from '@angular/common';
+import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
+import {
+  JsonSchemaFormModule,
+  JsonSchemaFormService,
+  WidgetLibraryModule
+} from '@ng-formworks/core';
+import { Bootstrap5FrameworkComponent } from './bootstrap5-framework.component';
+
+describe('Bootstrap5Component', () => {
+  let component: Bootstrap5FrameworkComponent;
+  let fixture: ComponentFixture<Bootstrap5FrameworkComponent>;
+
+  beforeEach(waitForAsync(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        JsonSchemaFormModule,
+        CommonModule,
+        WidgetLibraryModule,
+      ],
+      declarations: [Bootstrap5FrameworkComponent],
+      providers: [JsonSchemaFormService]
+    })
+      .compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(Bootstrap5FrameworkComponent);
+    component = fixture.componentInstance;
+    component.layoutNode = { options: {} };
+    component.layoutIndex = [];
+    component.dataIndex = [];
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

package/src/lib/bootstrap5-framework.component.ts

@@ -0,0 +1,66 @@
+import {
+  ChangeDetectorRef,
+  Component,
+  Input,
+  OnChanges,
+  OnInit,
+  ViewEncapsulation
+} from '@angular/core';
+import { JsonSchemaFormService } from '@ng-formworks/core';
+
+/**
+ * Bootstrap 5 framework for Angular JSON Schema Form.
+ *
+ */
+@Component({
+  // tslint:disable-next-line:component-selector
+  selector: 'bootstrap-5-framework',
+  template: `
+  <div>
+    <css-framework [layoutNode]="layoutNode" 
+    [layoutIndex]="layoutIndex" 
+    [dataIndex]="dataIndex">
+    </css-framework>
+  </div>
+  `,
+  styleUrls: ['./bootstrap5-framework.component.scss'],
+  encapsulation:ViewEncapsulation.None
+})
+export class Bootstrap5FrameworkComponent implements OnInit, OnChanges {
+  frameworkInitialized = false;
+  widgetOptions: any; // Options passed to child widget
+  widgetLayoutNode: any; // layoutNode passed to child widget
+  options: any; // Options used in this framework
+  formControl: any = null;
+  debugOutput: any = '';
+  debug: any = '';
+  parentArray: any = null;
+  isOrderable = false;
+  @Input() layoutNode: any;
+  @Input() layoutIndex: number[];
+  @Input() dataIndex: number[];
+  
+  
+  constructor(
+    public changeDetector: ChangeDetectorRef,
+    public jsf: JsonSchemaFormService
+  ) {
+  }
+  
+  
+  
+  ngOnInit() {
+  
+  }
+  
+  ngOnChanges() {
+  
+  }
+  
+  
+  
+  
+  
+  
+  }
+  

package/src/lib/bootstrap5-framework.module.ts

@@ -0,0 +1,37 @@
+import { CommonModule } from '@angular/common';
+import { NgModule } from '@angular/core';
+import {
+    Framework,
+    FrameworkLibraryService,
+    JsonSchemaFormModule,
+    JsonSchemaFormService,
+    WidgetLibraryModule,
+    WidgetLibraryService
+} from '@ng-formworks/core';
+import { CssFrameworkModule } from '@ng-formworks/cssframework';
+import { Bootstrap5FrameworkComponent } from './bootstrap5-framework.component';
+import { Bootstrap5Framework } from './bootstrap5.framework';
+
+@NgModule({
+    imports: [
+        JsonSchemaFormModule,
+        CommonModule,
+        WidgetLibraryModule,
+        CssFrameworkModule
+    ],
+    declarations: [
+        Bootstrap5FrameworkComponent,
+    ],
+    exports: [
+        JsonSchemaFormModule,
+        Bootstrap5FrameworkComponent,
+    ],
+    providers: [
+        JsonSchemaFormService,
+        FrameworkLibraryService,
+        WidgetLibraryService,
+        { provide: Framework, useClass: Bootstrap5Framework, multi: true },
+    ]
+})
+export class Bootstrap5FrameworkModule {
+}

package/src/lib/bootstrap5.framework.ts

@@ -0,0 +1,17 @@
+import { Injectable } from '@angular/core';
+import { CssFramework, CssframeworkService } from '@ng-formworks/cssframework';
+import { cssFrameworkCfgBootstrap5 } from './bootstrap5-cssframework';
+import { Bootstrap5FrameworkComponent } from './bootstrap5-framework.component';
+
+// Bootstrap 4 Framework
+// https://github.com/ng-bootstrap/ng-bootstrap
+
+@Injectable()
+export class Bootstrap5Framework extends CssFramework {
+  
+  framework = Bootstrap5FrameworkComponent;
+
+  constructor(public cssFWService:CssframeworkService){
+    super(cssFrameworkCfgBootstrap5,cssFWService);
+  }
+}

package/src/public_api.ts

@@ -0,0 +1,8 @@
+/*
+ * Public API Surface of @ng-formworks/bootstrap5
+ */
+
+export * from './lib/bootstrap5-framework.component';
+export * from './lib/bootstrap5-framework.module';
+export * from './lib/bootstrap5.framework';
+

package/src/test.ts

@@ -0,0 +1,17 @@
+// This file is required by karma.conf.js and loads recursively all the .spec and framework files
+
+import 'zone.js';
+import 'zone.js/testing';
+import { getTestBed } from '@angular/core/testing';
+import {
+  BrowserDynamicTestingModule,
+  platformBrowserDynamicTesting
+} from '@angular/platform-browser-dynamic/testing';
+
+// First, initialize the Angular testing environment.
+getTestBed().initTestEnvironment(
+  BrowserDynamicTestingModule,
+  platformBrowserDynamicTesting(), {
+    teardown: { destroyAfterEach: false }
+}
+);

package/tsconfig.lib.json

@@ -0,0 +1,14 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/lib",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "**/*.spec.ts"
+  ]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,10 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}

package/tsconfig.spec.json

@@ -0,0 +1,14 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/spec",
+    "types": [
+      "jasmine"
+    ]
+  },
+  "include": [
+    "**/*.spec.ts",
+    "**/*.d.ts"
+  ]
+}