Miss any of our Open RFC calls?Watch the recordings here! »

@ajsf/bootstrap4

0.3.0-beta.4 • Public • Published

@ajsf/bootstrap4

Getting started

npm install @ajsf/bootstrap4

With YARN, run the following:

yarn add @ajsf/bootstrap4

Then import Bootstrap4FrameworkModule in your main application module if you want to use bootstrap4 UI, like this:

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
 
import { Bootstrap4FrameworkModule } from '@ajsf/bootstrap4';
 
import { AppComponent } from './app.component';
 
@NgModule({
  declarations: [ AppComponent ],
  imports: [
    Bootstrap4FrameworkModule
  ],
  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:

<json-schema-form
  loadExternalAssets="true"
  [schema]="yourJsonSchema"
  framework="bootstrap-4"
  (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.
  • bootstrap-3 for Bootstrap 3.
  • bootstrap-4 for 'Bootstrap 4.
  • no-framework for (plain HTML).

Code scaffolding

Run ng generate component component-name --project @ajsf/bootstrap4 to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project @ajsf/bootstrap4.

Note: Don't forget to add --project @ajsf/bootstrap4 or else it will be added to the default project in your angular.json file.

Build

Run ng build @ajsf/bootstrap4 to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test @ajsf/bootstrap4 to execute the unit tests via Karma.

Install

npm i @ajsf/bootstrap4

DownloadsWeekly Downloads

408

Version

0.3.0-beta.4

License

MIT

Unpacked Size

215 kB

Total Files

20

Last publish

Collaborators

  • avatar