Skip to content

Commit 3de8cbc

Browse files
authored
Merge pull request #1 from shamoons/master
-
2 parents 55398af + a218512 commit 3de8cbc

17 files changed

+7210
-14819
lines changed

.angular-cli.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
33
"project": {
4-
"name": "angular2-json-schema-form"
4+
"name": "ng-json-schema-form"
55
},
66
"apps": [
77
{

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ typings
3535
.firebaserc
3636
firebase.json
3737
firebase-debug.log
38+
yarn-error.log
3839

3940
# e2e
4041
e2e/*.js

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Angular JSON Schema Form
1+
# Contributing to NG JSON Schema Form
22

3-
We would love for you to contribute to Angular JSON Schema Form!
3+
We would love for you to contribute to NG JSON Schema Form!
44
Here's more information about how to contribute:
55

66
- [Issues and Bugs](#issue)
@@ -33,12 +33,12 @@ This library is released under the [MIT](https://opensource.org/licenses/MIT) Li
3333
## <a name="coc"></a> Code of Conduct
3434
Be courteous to other people. If you're not sure how to do that, please read and follow our [Code of Conduct][code-of-conduct].
3535

36-
[new-issue]: https://github.com/dschnelldavis/angular2-json-schema-form/issues/new
37-
[pull-requests]: https://github.com/dschnelldavis/angular2-json-schema-form/pulls
38-
[github]: https://github.com/dschnelldavis/angular2-json-schema-form
36+
[new-issue]: https://github.com/shamoons/ng-json-schema-form/issues/new
37+
[pull-requests]: https://github.com/shamoons/ng-json-schema-form/pulls
38+
[github]: https://github.com/shamoons/ng-json-schema-form
3939
[js-style-guide]: https://google.github.io/styleguide/jsguide.html
4040
[jsfiddle]: http://jsfiddle.net
4141
[plunker]: http://plnkr.co/edit
4242
[runnable]: http://runnable.com
4343
[stackoverflow]: http://stackoverflow.com/questions/tagged/angular2-json-schema-form
44-
[code-of-conduct]: https://github.com/dschnelldavis/angular2-json-schema-form/CODE_OF_CONDUCT.md
44+
[code-of-conduct]: https://github.com/shamoons/ng-json-schema-form/CODE_OF_CONDUCT.md

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Angular JSON Schema Form
1+
# NG JSON Schema Form
22

3-
[![npm version](https://img.shields.io/npm/v/angular2-json-schema-form.svg?style=plastic)](https://www.npmjs.com/package/angular2-json-schema-form) [![npm downloads](https://img.shields.io/npm/dm/angular2-json-schema-form.svg?style=plastic)](https://www.npmjs.com/package/angular2-json-schema-form) [![GitHub MIT License](https://img.shields.io/github/license/dschnelldavis/angular2-json-schema-form.svg?style=social)](https://github.com/dschnelldavis/angular2-json-schema-form)
4-
[![Dependencies](https://david-dm.org/dschnelldavis/angular2-json-schema-form.svg)](https://david-dm.org/dschnelldavis/angular2-json-schema-form) [![devDependencies](https://david-dm.org/dschnelldavis/angular2-json-schema-form/dev-status.svg)](https://david-dm.org/dschnelldavis/angular2-json-schema-form?type=dev)
3+
[![npm version](https://img.shields.io/npm/v/ng-json-schema-form.svg?style=plastic)](https://www.npmjs.com/package/ng-json-schema-form) [![npm downloads](https://img.shields.io/npm/dm/ng-json-schema-form.svg?style=plastic)](https://www.npmjs.com/package/ng-json-schema-form) [![GitHub MIT License](https://img.shields.io/github/license/shamoons/ng-json-schema-form.svg?style=social)](https://github.com/shamoons/ng-json-schema-form)
4+
[![Dependencies](https://david-dm.org/shamoons/ng-json-schema-form.svg)](https://david-dm.org/shamoons/ng-json-schema-form) [![devDependencies](https://david-dm.org/shamoons/ng-json-schema-form/dev-status.svg)](https://david-dm.org/shamoons/ng-json-schema-form?type=dev)
55

66
A [JSON Schema](http://json-schema.org) Form builder for Angular 4 and 5, similar to, and mostly API compatible with,
77

@@ -18,19 +18,19 @@ For full details, see 'To install from NPM and use in your own project', below.
1818

1919
## Check out the live demo and play with the examples
2020

21-
[Check out some examples here.](https://angular2-json-schema-form.firebaseapp.com/)
21+
[Check out some examples here.](https://ng-json-schema-form.firebaseapp.com/)
2222

2323
This example playground features over 70 different JSON Schemas for you to try (including all examples used by each of the three libraries listed above), and the ability to quickly view any example formatted with Material Design, Bootstrap 3, Bootstrap 4, or without any formatting.
2424

2525
## Installation
2626

2727
### To install from GitHub
2828

29-
To install [the library and the example playground from GitHub](https://github.com/dschnelldavis/angular2-json-schema-form), clone `https://github.com/dschnelldavis/angular2-json-schema-form.git` with your favorite git program. Or, assuming you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Node/NPM](https://nodejs.org/en/download/) installed, enter the following in your terminal:
29+
To install [the library and the example playground from GitHub](https://github.com/shamoons/ng-json-schema-form), clone `https://github.com/shamoons/ng-json-schema-form.git` with your favorite git program. Or, assuming you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Node/NPM](https://nodejs.org/en/download/) installed, enter the following in your terminal:
3030

3131
```shell
32-
git clone https://github.com/dschnelldavis/angular2-json-schema-form.git angular2-json-schema-form
33-
cd angular2-json-schema-form
32+
git clone https://github.com/shamoons/ng-json-schema-form.git ng-json-schema-form
33+
cd ng-json-schema-form
3434
npm install
3535
npm start
3636
```
@@ -50,10 +50,10 @@ If you want detailed documentation describing the individual functions used in t
5050

5151
### To install from NPM and use in your own project
5252

53-
If, after playing with the examples, you decide this library is functional enough to use in your own project, you can [install it from NPM](https://www.npmjs.com/package/angular2-json-schema-form) using either [NPM](https://www.npmjs.com) or [Yarn](https://yarnpkg.com). To install with NPM, run the following from your terminal:
53+
If, after playing with the examples, you decide this library is functional enough to use in your own project, you can [install it from NPM](https://www.npmjs.com/package/ng-json-schema-form) using either [NPM](https://www.npmjs.com) or [Yarn](https://yarnpkg.com). To install with NPM, run the following from your terminal:
5454

5555
```shell
56-
npm install angular2-json-schema-form
56+
npm install ng-json-schema-form
5757
```
5858

5959
Then import JsonSchemaFormModule in your main application module, like this:
@@ -64,7 +64,7 @@ import { NgModule } from '@angular/core';
6464

6565
import {
6666
JsonSchemaFormModule, MaterialDesignFrameworkModule
67-
} from 'angular2-json-schema-form';
67+
} from 'ng-json-schema-form';
6868

6969
import { AppComponent } from './app.component';
7070

@@ -113,7 +113,7 @@ If you use SystemJS, you will also need to make the following changes to your sy
113113

114114
Add these lines to the 'map' section of systemjs.config.js:
115115
```javascript
116-
'angular2-json-schema-form': 'npm:angular2-json-schema-form/bundles/angular2-json-schema-form.umd.js',
116+
'ng-json-schema-form': 'npm:ng-json-schema-form/bundles/ng-json-schema-form.umd.js',
117117
'ajv': 'npm:ajv/dist/ajv.min.js',
118118
'lodash': 'npm:lodash/lodash.min.js'
119119
```
@@ -255,7 +255,7 @@ Combining inputs is useful if you have many unique forms and store each form's d
255255

256256
#### Compatibility modes
257257

258-
If you have previously used another JSON form creation library—Angular Schema Form (for AngularJS), React JSON Schema Form, or JSON Form (for jQuery)—in order to make the transition easier, Angular JSON Schema Form will recognize the input names and custom input objects used by those libraries. It should automatically work with JSON Schemas in [version 6](http://json-schema.org/draft-06/schema), [version 4](http://json-schema.org/draft-04/schema), [version 3](http://json-schema.org/draft-03/schema), or the [truncated version 3 format supported by JSON Form](https://github.com/joshfire/jsonform/wiki#schema-shortcut). So the following will all work:
258+
If you have previously used another JSON form creation library—Angular Schema Form (for AngularJS), React JSON Schema Form, or JSON Form (for jQuery)—in order to make the transition easier, Angular JSON Schema Form will recognize the input names and custom input objects used by those libraries. It should automatically work with JSON Schemas in [version 7](http://json-schema.org/draft-07/schema), [version 6](http://json-schema.org/draft-06/schema), [version 4](http://json-schema.org/draft-04/schema), [version 3](http://json-schema.org/draft-03/schema), or the [truncated version 3 format supported by JSON Form](https://github.com/joshfire/jsonform/wiki#schema-shortcut). So the following will all work:
259259

260260
Angular Schema Form (AngularJS) compatibility:
261261
```html
@@ -434,7 +434,7 @@ let yourNewWidgets = {
434434
```
435435
...or...
436436
```javascript
437-
import { WidgetLibraryService } from 'angular2-json-schema-form';
437+
import { WidgetLibraryService } from 'ng-json-schema-form';
438438
...
439439
constructor(private widgetLibrary: WidgetLibraryService) { }
440440
...
@@ -470,7 +470,7 @@ let yourCustomFramework = {
470470
```
471471
...or...
472472
```javascript
473-
import { FrameworkLibraryService } from 'angular2-json-schema-form';
473+
import { FrameworkLibraryService } from 'ng-json-schema-form';
474474
...
475475
constructor(private frameworkLibrary: FrameworkLibraryService) { }
476476
...
@@ -499,11 +499,11 @@ The two built-in frameworks (in the `/src/lib/src/framework-library` folder) dem
499499

500500
## Contributions and future development
501501

502-
If you find this library useful, I'd love to hear from you. If you have any trouble with it or would like to request a feature, please [post an issue on GitHub](https://github.com/dschnelldavis/angular2-json-schema-form/issues).
502+
If you find this library useful, I'd love to hear from you. If you have any trouble with it or would like to request a feature, please [post an issue on GitHub](https://github.com/shamoons/ng-json-schema-form/issues).
503503

504504
If you're a programmer and would like a fun intermediate-level Angular project to hack on, clone the library and take a look at the source code. I wrote this library both because I needed an Angular JSON Schema Form builder, and also as a way to sharpen my Angular skills. This project is just complex enough to be challenging and fun, but not so difficult as to be overwhelming. One thing I particularly like is that each example in the demo playground is like a little puzzle which provides immediate feedback—as soon as it works perfectly, you know you've solved it.
505505

506-
I've also tried to split things into small modules as much as possible, so even though some code is still a bit messy, most individual parts should be straightforward to work with. (A lot of the code is well commented, though some isn't—but I'm working to fix that. If you run into anything you don't understand, please ask.) If you make improvements, please [submit a pull request](https://github.com/dschnelldavis/angular2-json-schema-form/pulls) to share what you've done.
506+
I've also tried to split things into small modules as much as possible, so even though some code is still a bit messy, most individual parts should be straightforward to work with. (A lot of the code is well commented, though some isn't—but I'm working to fix that. If you run into anything you don't understand, please ask.) If you make improvements, please [submit a pull request](https://github.com/shamoons/ng-json-schema-form/pulls) to share what you've done.
507507

508508
This library is mostly functional (I'm already using it in another large site, where it works well), but it still has many small bugs to fix and enhancements that could be made. Here's a random list of some stuff I know needs to be added or improved:
509509

@@ -513,13 +513,13 @@ This library is mostly functional (I'm already using it in another large site, w
513513

514514
* More widgets—There are lots of great form controls available, such as the [Pikaday calendar](https://github.com/dbushell/Pikaday), [Spectrum color picker](http://bgrins.github.io/spectrum), and [ACE code editor](https://ace.c9.io), which just need small custom wrappers to convert them into Angular JSON Schema Form plug-ins. In addition, there are a few additional features of HTML, JSON Schema, and Material Design which could be fixed by adding new widgets:
515515

516-
* [A file widget](https://github.com/dschnelldavis/angular2-json-schema-form/issues/38)—To support uploading files, this widget would display an HTML file input, and then include the uploaded file in the form's output data, as an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsArrayBuffer) or [DataURL](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL).
516+
* [A file widget](https://github.com/shamoons/ng-json-schema-form/issues/38)—To support uploading files, this widget would display an HTML file input, and then include the uploaded file in the form's output data, as an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsArrayBuffer) or [DataURL](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL).
517517

518-
* [A oneOf widget](https://github.com/dschnelldavis/angular2-json-schema-form/issues/112)—To support schemas using oneOf or anyOf, this widget would enable a user to choose an option from a select list, which would then replace another control on the form.
518+
* [A oneOf widget](https://github.com/shamoons/ng-json-schema-form/issues/112)—To support schemas using oneOf or anyOf, this widget would enable a user to choose an option from a select list, which would then replace another control on the form.
519519

520-
* [An addAdditionalProperties widget](https://github.com/dschnelldavis/angular2-json-schema-form/issues/104)—To support schemas using additionalProperties or patternProperties, this widget would enable users to enter a name to add a new property to an object, and would then add a new control to the form for setting that property's value (similar to the existing [add-reference widget](https://github.com/dschnelldavis/angular2-json-schema-form/blob/master/src/lib/src/widget-library/add-reference.component.ts)).
520+
* [An addAdditionalProperties widget](https://github.com/shamoons/ng-json-schema-form/issues/104)—To support schemas using additionalProperties or patternProperties, this widget would enable users to enter a name to add a new property to an object, and would then add a new control to the form for setting that property's value (similar to the existing [add-reference widget](https://github.com/shamoons/ng-json-schema-form/blob/master/src/lib/src/widget-library/add-reference.component.ts)).
521521

522-
* [A matStepper widget](https://github.com/dschnelldavis/angular2-json-schema-form/issues/123)—To support the [Angular Material Stepper control](https://material.angular.io/components/stepper/overview) (similar to the existing [tabs](https://github.com/dschnelldavis/angular2-json-schema-form/blob/master/src/lib/src/widget-library/tabs.component.ts) widget).
522+
* [A matStepper widget](https://github.com/shamoons/ng-json-schema-form/issues/123)—To support the [Angular Material Stepper control](https://material.angular.io/components/stepper/overview) (similar to the existing [tabs](https://github.com/shamoons/ng-json-schema-form/blob/master/src/lib/src/widget-library/tabs.component.ts) widget).
523523

524524
If you like this library, need help, or want to contribute, let me know. I'm busy, so it sometimes takes me a long time to respond, but I will eventually get back to you. :-)
525525

0 commit comments

Comments
 (0)