Skip to content

Commit a8e9651

Browse files
jmartinmjmartinm
committed
@output naming styling
* Renames @output to follow convention from https://angular.io/docs/ts/latest/guide/style-guide.html#!#05-16
1 parent d350a0e commit a8e9651

17 files changed

+34
-35
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ Then add it to your module's `imports`.
3838
### Use
3939

4040
```html
41-
<json-editor [config]="config" [schema]="mySchema" [record]="myRecord" (onRecordChange)="doStuffWithNewRecord($event)"></json-editor>
41+
<json-editor [config]="config" [schema]="mySchema" [record]="myRecord" (recordChange)="doStuffWithNewRecord($event)"></json-editor>
4242
```
4343

4444
- `config` : configuration object. See [configuration docs](https://inveniosoftware-contrib.github.io/ng2-json-editor/docs/interfaces/_json_editor_config_.jsoneditorconfig.html) for options.
4545
- `schema` : valid json-schema for the record. See [json schema limitations](#json-schema-limitations)
4646
- `record` : valid json to be edited.
47-
- `onRecordChange` emitted when record change, `$event` is the edited record.
47+
- `recordChange` emitted when record change, `$event` is the edited record.
4848
- `errorMap (={})`: errors for individual parts of the record (format should be [errors-map.json](./example/assets/mock-data/error-map.json)
4949
- `templates: { [templateName: string]: TemplateRef<any> }`: Templates with name, to be used by configured fields for example autocomplete result item.
5050

‎example/app/app.component.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import { AppConfig } from './app.config';
3737
<json-editor *ngIf="record && schema"
3838
[config]="config.jsonEditorConfig"
3939
[record]="record"
40-
(onRecordChange)="onRecordChange($event)"
40+
(recordChange)="onRecordChange($event)"
4141
[schema]="schema">
4242
</json-editor>
4343
`

‎src/add-field-dropdown/add-field-dropdown.component.spec.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ describe('AddFieldToObjectDropdownComponent', () => {
102102
showDropdownButton.dispatchEvent(new Event('click'));
103103
let anchor = nativeEl.querySelector('li a') as HTMLAnchorElement;
104104
expect(component.fields.has(anchor.textContent)).toBeFalsy();
105-
spyOn(component.onFieldAdd, 'emit');
105+
spyOn(component.fieldAdd, 'emit');
106106
anchor.dispatchEvent(new Event('click'));
107-
expect(component.onFieldAdd.emit).toHaveBeenCalledWith(anchor.textContent);
107+
expect(component.fieldAdd.emit).toHaveBeenCalledWith(anchor.textContent);
108108
});
109109
});

‎src/add-field-dropdown/add-field-dropdown.component.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class AddFieldDropdownComponent {
4040
@Input() fields: Set<string>;
4141
@Input() pathString: string;
4242

43-
@Output() onFieldAdd: EventEmitter<string> = new EventEmitter<string>();
43+
@Output() fieldAdd: EventEmitter<string> = new EventEmitter<string>();
4444

4545
expression = '';
4646

@@ -59,7 +59,7 @@ export class AddFieldDropdownComponent {
5959
}
6060

6161
onFieldSelect(field: string) {
62-
this.onFieldAdd.emit(field);
62+
this.fieldAdd.emit(field);
6363

6464
let newFieldPathString = `${this.pathString}${this.pathUtilService.separator}${field}`;
6565
this.domUtilService.focusAndSelectFirstEditableChildById(newFieldPathString);

‎src/autocomplete-input/autocomplete-input.component.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="autocomplete-container">
2-
<input attr.data-path="{{pathString}}" [ngModel]="value" (ngModelChange)="onModelChange($event)" (keypress)="onKeypress.emit($event)"
3-
(blur)="onBlur.emit()" [typeahead]="dataSource" [typeaheadOptionsLimit]="autocompletionConfig.size" [typeaheadOptionField]="typeaheadOptionField"
2+
<input attr.data-path="{{pathString}}" [ngModel]="value" (ngModelChange)="onModelChange($event)" (keypress)="keypress.emit($event)"
3+
(blur)="blur.emit()" [typeahead]="dataSource" [typeaheadOptionsLimit]="autocompletionConfig.size" [typeaheadOptionField]="typeaheadOptionField"
44
[typeaheadItemTemplate]="customItemTemplate" (typeaheadOnSelect)="onCompletionSelect($event.item)" [typeaheadWaitMs]="200" [tabindex]="tabIndex"
55
placeholder="{{placeholder}}">
66
</div>

‎src/autocomplete-input/autocomplete-input.component.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ export class AutocompleteInputComponent implements OnInit {
4545
@Input() tabIndex: number;
4646
@Input() placeholder: string;
4747

48-
@Output() onValueChange: EventEmitter<string> = new EventEmitter<any>();
49-
@Output() onKeypress: EventEmitter<KeyboardEvent> = new EventEmitter<any>();
50-
@Output() onBlur: EventEmitter<any> = new EventEmitter<any>();
48+
@Output() valueChange: EventEmitter<string> = new EventEmitter<any>();
49+
@Output() keypress: EventEmitter<KeyboardEvent> = new EventEmitter<any>();
50+
@Output() blur: EventEmitter<any> = new EventEmitter<any>();
5151

5252
dataSource: Observable<string> | Array<string>;
5353
typeaheadOptionField: string;
@@ -78,7 +78,7 @@ export class AutocompleteInputComponent implements OnInit {
7878

7979
onModelChange(value: string) {
8080
this.value = value;
81-
this.onValueChange.emit(value);
81+
this.valueChange.emit(value);
8282
}
8383

8484
onCompletionSelect(completionItem: AutocompletionResult) {

‎src/complex-list-field/complex-list-field.component.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<div *ngFor="let pIndex of paginatedIndices; let i = index; trackBy:trackByIndex">
4343
<div class="complex-list-field-wrapper">
4444
<object-field [value]="values.get(pIndex)" [schema]="schema.items" [path]="getElementPath(pIndex)">
45-
<list-action-group (onMove)="moveElement(i, $event)" (onDelete)="deleteElement(i)" [canMove]="schema.sortable"></list-action-group>
45+
<list-action-group (move)="moveElement(i, $event)" (delete)="deleteElement(i)" [canMove]="schema.sortable"></list-action-group>
4646
</object-field>
4747
</div>
4848
</div>

‎src/json-editor.component.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div class="row editor-container" [ngClass]="shorterEditorContainerClass">
22
<div class="col-md-2 menu-container">
33
<tree-menu [record]="_record" [schema]="schema"></tree-menu>
4-
<add-field-dropdown [fields]="keys" [pathString]="''" (onFieldAdd)="onFieldAdd($event)" [schema]="schema">Add field</add-field-dropdown>
4+
<add-field-dropdown [fields]="keys" [pathString]="''" (fieldAdd)="onFieldAdd($event)" [schema]="schema">Add field</add-field-dropdown>
55
<div *ngIf="config.enableAdminModeSwitch" class="admin-mode" tooltip="Allows editing all fields (use with care)">
66
<input id="admin-mode-checkbox" type="checkbox" [(ngModel)]="appGlobalsService.adminMode" />
77
<label class="admin-mode" for="admin-mode-checkbox">Enable Admin Mode</label>
@@ -12,10 +12,10 @@
1212
<tabset *ngIf="config.tabsConfig">
1313
<tab *ngFor="let tabName of tabNames; trackBy:trackByElement" [heading]="tabName" (select)="activeTabName = tabName" [active]="isActiveTab(tabName)">
1414
<sub-record [value]="_record" [tabName]="tabName" [schema]="tabNameToSubSchema[tabName]" [keys]="tabNameToKeys[tabName]"
15-
(onDeleteKey)="onDeleteKey($event)" (onOpenPanelClick)="openPanel($event)"></sub-record>
15+
(deleteKey)="onDeleteKey($event)"></sub-record>
1616
</tab>
1717
</tabset>
18-
<sub-record *ngIf="!config.tabsConfig" [value]="_record" [schema]="schema" (onDeleteKey)="onDeleteKey($event)" [keys]="keys"></sub-record>
18+
<sub-record *ngIf="!config.tabsConfig" [value]="_record" [schema]="schema" (deleteKey)="onDeleteKey($event)" [keys]="keys"></sub-record>
1919
</div>
2020
<div id="right-main-container" *ngIf="!isPreviewerDisabled" [ngClass]="rightContainerColMdClass" class="main-container">
2121
<button id="btn-preview-toggle" type="button" class="btn btn-default btn-toggle" (click)="isPreviewerHidden = !isPreviewerHidden">{{isPreviewerHidden ? "Show Preview" : "Hide Preview"}}</button>

‎src/json-editor.component.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnI
7777

7878
@Input() templates: { [templateName: string]: TemplateRef<any> } = {};
7979

80-
@Output() onRecordChange: EventEmitter<Object> = new EventEmitter<Object>();
80+
@Output() recordChange: EventEmitter<Object> = new EventEmitter<Object>();
8181

8282
private _errorMap: SchemaValidationErrors = {};
8383
_record: Map<string, any>;
@@ -135,7 +135,7 @@ export class JsonEditorComponent extends AbstractTrackerComponent implements OnI
135135
.subscribe(json => {
136136
this._record = json;
137137
// emit the change as plain JS object
138-
this.onRecordChange.emit(json.toJS());
138+
this.recordChange.emit(json.toJS());
139139
});
140140
this.jsonSchemaService.setSchema(this.schema);
141141

‎src/list-action-group/list-action-group.component.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<div>
2-
<button type="button" class="editor-btn-delete" (click)="onDelete.emit()">
2+
<button type="button" class="editor-btn-delete" (click)="delete.emit()">
33
<i class="fa fa-times"></i>
44
</button>
5-
<button *ngIf="canMove" type="button" class="editor-btn-move-up" (click)="onMove.emit(-1)">
5+
<button *ngIf="canMove" type="button" class="editor-btn-move-up" (click)="move.emit(-1)">
66
<i class="fa fa-chevron-up"></i>
77
</button>
8-
<button *ngIf="canMove" type="button" class="editor-btn-move-down" (click)="onMove.emit(1)">
8+
<button *ngIf="canMove" type="button" class="editor-btn-move-down" (click)="move.emit(1)">
99
<i class="fa fa-chevron-down"></i>
1010
</button>
1111
</div>

0 commit comments

Comments
 (0)