Skip to content

Commit

Permalink
feat(radio): support radio button sharing a control
Browse files Browse the repository at this point in the history
  • Loading branch information
kara committed Jun 15, 2016
1 parent 54c577c commit 39e0b49
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 103 deletions.
2 changes: 1 addition & 1 deletion modules/@angular/forms/src/directives.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export {NgForm} from './directives/ng_form';
export {NgModel} from './directives/ng_model';
export {NgModelGroup} from './directives/ng_model_group';
export {NumberValueAccessor} from './directives/number_value_accessor';
export {RadioButtonState, RadioControlValueAccessor} from './directives/radio_control_value_accessor';
export {RadioControlValueAccessor} from './directives/radio_control_value_accessor';
export {FormControlDirective} from './directives/reactive_directives/form_control_directive';
export {FormControlName} from './directives/reactive_directives/form_control_name';
export {FormGroupDirective} from './directives/reactive_directives/form_group_directive';
Expand Down
14 changes: 8 additions & 6 deletions modules/@angular/forms/src/directives/ng_form.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {NG_ASYNC_VALIDATORS, NG_VALIDATORS} from '../validators';
import {ControlContainer} from './control_container';
import {Form} from './form_interface';
import {NgControl} from './ng_control';
import {NgModel} from './ng_model';
import {NgModelGroup} from './ng_model_group';
import {composeAsyncValidators, composeValidators, setUpControl, setUpFormGroup} from './shared';

Expand Down Expand Up @@ -107,20 +108,21 @@ export class NgForm extends ControlContainer implements Form {

get controls(): {[key: string]: AbstractControl} { return this.form.controls; }

addControl(dir: NgControl): FormControl {
addControl(dir: NgModel): FormControl {
const ctrl = new FormControl();
PromiseWrapper.scheduleMicrotask(() => {
const container = this._findContainer(dir.path);
setUpControl(ctrl, dir);
container.registerControl(dir.name, ctrl);
ctrl.updateValueAndValidity({emitEvent: false});
dir._control = <FormControl>container.registerControl(dir.name, ctrl);
setUpControl(dir.control, dir);
dir.control.updateValueAndValidity({emitEvent: false});
});

return ctrl;
}

getControl(dir: NgControl): FormControl { return <FormControl>this.form.find(dir.path); }
getControl(dir: NgModel): FormControl { return <FormControl>this.form.find(dir.path); }

removeControl(dir: NgControl): void {
removeControl(dir: NgModel): void {
PromiseWrapper.scheduleMicrotask(() => {
var container = this._findContainer(dir.path);
if (isPresent(container)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export class RadioControlRegistry {
select(accessor: RadioControlValueAccessor) {
this._accessors.forEach((c) => {
if (this._isSameGroup(c, accessor) && c[1] !== accessor) {
c[1].fireUncheck();
c[1].fireUncheck(accessor.value);
}
});
}
Expand All @@ -48,16 +48,6 @@ export class RadioControlRegistry {
}
}

/**
* The value provided by the forms API for radio buttons.
*
* @experimental
*/
export class RadioButtonState {
constructor(public checked: boolean, public value: string) {}
}


/**
* The accessor for writing a radio control value and listening to changes that is used by the
* {@link NgModel}, {@link FormControlDirective}, and {@link FormControlName} directives.
Expand All @@ -66,13 +56,12 @@ export class RadioButtonState {
* ```
* @Component({
* template: `
* <input type="radio" name="food" [(ngModel)]="foodChicken">
* <input type="radio" name="food" [(ngModel)]="foodFish">
* <input type="radio" name="food" [(ngModel)]="food" value="chicken">
* <input type="radio" name="food" [(ngModel)]="food" value="fish">
* `
* })
* class FoodCmp {
* foodChicken = new RadioButtonState(true, "chicken");
* foodFish = new RadioButtonState(false, "fish");
* food = 'chicken';
* }
* ```
*/
Expand All @@ -85,14 +74,16 @@ export class RadioButtonState {
export class RadioControlValueAccessor implements ControlValueAccessor,
OnDestroy, OnInit {
/** @internal */
_state: RadioButtonState;
_state: boolean;
/** @internal */
_control: NgControl;
@Input() name: string;
/** @internal */
_fn: Function;
onChange = () => {};
onTouched = () => {};
onTouched = () => {}

@Input() name: string;
@Input() value: any;

constructor(
private _renderer: Renderer, private _elementRef: ElementRef,
Expand All @@ -106,21 +97,21 @@ export class RadioControlValueAccessor implements ControlValueAccessor,
ngOnDestroy(): void { this._registry.remove(this); }

writeValue(value: any): void {
this._state = value;
if (isPresent(value) && value.checked) {
this._renderer.setElementProperty(this._elementRef.nativeElement, 'checked', true);
this._state = value === this.value;
if (isPresent(value)) {
this._renderer.setElementProperty(this._elementRef.nativeElement, 'checked', this._state);
}
}

registerOnChange(fn: (_: any) => {}): void {
this._fn = fn;
this.onChange = () => {
fn(new RadioButtonState(true, this._state.value));
fn(this.value);
this._registry.select(this);
};
}

fireUncheck(): void { this._fn(new RadioButtonState(false, this._state.value)); }
fireUncheck(value: any): void { this.writeValue(value); }

registerOnTouched(fn: () => {}): void { this.onTouched = fn; }
}
2 changes: 1 addition & 1 deletion modules/@angular/forms/src/forms.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
*/


export {FORM_DIRECTIVES, REACTIVE_FORM_DIRECTIVES, RadioButtonState} from './directives';
export {FORM_DIRECTIVES, REACTIVE_FORM_DIRECTIVES} from './directives';
export {AbstractControlDirective} from './directives/abstract_control_directive';
export {CheckboxControlValueAccessor} from './directives/checkbox_value_accessor';
export {ControlContainer} from './directives/control_container';
Expand Down
12 changes: 8 additions & 4 deletions modules/@angular/forms/src/model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export abstract class AbstractControl {
*/
export class FormControl extends AbstractControl {
/** @internal */
_onChange: Function;
_onChange: Function[] = [];

constructor(
value: any = null, validator: ValidatorFn|ValidatorFn[] = null,
Expand Down Expand Up @@ -312,7 +312,9 @@ export class FormControl extends AbstractControl {
} = {}): void {
emitModelToViewChange = isPresent(emitModelToViewChange) ? emitModelToViewChange : true;
this._value = value;
if (isPresent(this._onChange) && emitModelToViewChange) this._onChange(this._value);
if (this._onChange.length && emitModelToViewChange) {
this._onChange.forEach((changeFn) => changeFn(this._value));
}
this.updateValueAndValidity({onlySelf: onlySelf, emitEvent: emitEvent});
}

Expand All @@ -329,7 +331,7 @@ export class FormControl extends AbstractControl {
/**
* Register a listener for change events.
*/
registerOnChange(fn: Function): void { this._onChange = fn; }
registerOnChange(fn: Function): void { this._onChange.push(fn); }
}

/**
Expand Down Expand Up @@ -364,9 +366,11 @@ export class FormGroup extends AbstractControl {
/**
* Register a control with the group's list of controls.
*/
registerControl(name: string, control: AbstractControl): void {
registerControl(name: string, control: AbstractControl): AbstractControl {
if (this.controls[name]) return this.controls[name];
this.controls[name] = control;
control.setParent(this);
return control;
}

/**
Expand Down
135 changes: 67 additions & 68 deletions modules/@angular/forms/test/integration_spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {Input, Provider, forwardRef} from '@angular/core';
import {fakeAsync, flushMicrotasks, tick} from '@angular/core/testing';
import {afterEach, beforeEach, ddescribe, describe, expect, iit, inject, it, xdescribe, xit} from '@angular/core/testing/testing_internal';
import {AsyncTestCompleter} from '@angular/core/testing/testing_internal';
import {ControlValueAccessor, FORM_DIRECTIVES, FORM_PROVIDERS, FormControl, FormGroup, NG_ASYNC_VALIDATORS, NG_VALIDATORS, NgControl, NgForm, NgModel, REACTIVE_FORM_DIRECTIVES, RadioButtonState, Validator, Validators, disableDeprecatedForms, provideForms} from '@angular/forms';
import {ControlValueAccessor, FORM_DIRECTIVES, FORM_PROVIDERS, FormControl, FormGroup, NG_ASYNC_VALIDATORS, NG_VALIDATORS, NgControl, NgForm, NgModel, REACTIVE_FORM_DIRECTIVES, Validator, Validators, disableDeprecatedForms, provideForms} from '@angular/forms';
import {By} from '@angular/platform-browser/src/dom/debug/by';
import {getDOM} from '@angular/platform-browser/src/dom/dom_adapter';
import {dispatchEvent} from '@angular/platform-browser/testing';
Expand Down Expand Up @@ -503,29 +503,35 @@ export function main() {
[TestComponentBuilder, AsyncTestCompleter],
(tcb: TestComponentBuilder, async: AsyncTestCompleter) => {
const t = `<form [formGroup]="form">
<input type="radio" formControlName="foodChicken" name="food">
<input type="radio" formControlName="foodFish" name="food">
<input type="radio" formControlName="food" value="chicken">
<input type="radio" formControlName="food" value="fish">
</form>`;

const ctrl = new FormControl('fish');
tcb.overrideTemplate(MyComp8, t)
.overrideProviders(MyComp8, providerArr)
.createAsync(MyComp8)
.then((fixture) => {
fixture.debugElement.componentInstance.form = new FormGroup({
'foodChicken': new FormControl(new RadioButtonState(false, 'chicken')),
'foodFish': new FormControl(new RadioButtonState(true, 'fish'))
});
fixture.debugElement.componentInstance.form = new FormGroup({'food': ctrl});
fixture.detectChanges();

var input = fixture.debugElement.query(By.css('input'));
expect(input.nativeElement.checked).toEqual(false);
var inputs = fixture.debugElement.queryAll(By.css('input'));
expect(inputs[0].nativeElement.checked).toEqual(false);
expect(inputs[1].nativeElement.checked).toEqual(true);

dispatchEvent(input.nativeElement, 'change');
dispatchEvent(inputs[0].nativeElement, 'change');
fixture.detectChanges();

let value = fixture.debugElement.componentInstance.form.value;
expect(value['foodChicken'].checked).toEqual(true);
expect(value['foodFish'].checked).toEqual(false);
expect(value.food).toEqual('chicken');
expect(inputs[1].nativeElement.checked).toEqual(false);

ctrl.updateValue('fish');
fixture.detectChanges();

expect(inputs[0].nativeElement.checked).toEqual(false);
expect(inputs[1].nativeElement.checked).toEqual(true);

async.done();
});
}));
Expand Down Expand Up @@ -1393,77 +1399,70 @@ export function main() {
expect(form.value).toEqual({two: 'some data'});
})));

// TODO(kara): Fix when re-doing radio buttons
xit('should support <type=radio>',
fakeAsync(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
const t = `<form>
<input type="radio" name="food" [(ngModel)]="data['chicken']">
<input type="radio" name="food" [(ngModel)]="data['fish']">
<input type="radio" name="food" [(ngModel)]="data['beef']">
<input type="radio" name="food" [(ngModel)]="data['pork']">
it('should support <type=radio>',
fakeAsync(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
const t = `<form>
<input type="radio" name="food" [(ngModel)]="data.food" value="chicken">
<input type="radio" name="food" [(ngModel)]="data.food" value="fish">
</form>`;

const fixture = tcb.overrideTemplate(MyComp8, t).createFakeAsync(MyComp8);
tick();
const fixture = tcb.overrideTemplate(MyComp8, t).createFakeAsync(MyComp8);
tick();

fixture.debugElement.componentInstance.data = {
'chicken': new RadioButtonState(false, 'chicken'),
'fish': new RadioButtonState(true, 'fish'),
'beef': new RadioButtonState(false, 'beef'),
'pork': new RadioButtonState(true, 'pork')
};
fixture.detectChanges();
tick();
fixture.debugElement.componentInstance.data = {food: 'fish'};
fixture.detectChanges();
tick();

const input = fixture.debugElement.query(By.css('input'));
expect(input.nativeElement.checked).toEqual(false);
const inputs = fixture.debugElement.queryAll(By.css('input'));
expect(inputs[0].nativeElement.checked).toEqual(false);
expect(inputs[1].nativeElement.checked).toEqual(true);

dispatchEvent(input.nativeElement, 'change');
tick();
dispatchEvent(inputs[0].nativeElement, 'change');
tick();

const data = fixture.debugElement.componentInstance.data;
const data = fixture.debugElement.componentInstance.data;

expect(data['chicken']).toEqual(new RadioButtonState(true, 'chicken'));
expect(data['fish']).toEqual(new RadioButtonState(false, 'fish'));
expect(data['beef']).toEqual(new RadioButtonState(false, 'beef'));
expect(data['pork']).toEqual(new RadioButtonState(false, 'pork'));
})));
});
expect(data.food).toEqual('chicken');
expect(inputs[1].nativeElement.checked).toEqual(false);
})));

xit('should support multiple named <type=radio> groups',
fakeAsync(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
const t = `<form>
<input type="radio" name="food" [(ngModel)]="data['chicken']">
<input type="radio" name="food" [(ngModel)]="data['fish']">
<input type="radio" name="drink" [(ngModel)]="data['cola']">
<input type="radio" name="drink" [(ngModel)]="data['sprite']">
it('should support multiple named <type=radio> groups',
fakeAsync(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
const t = `<form>
<input type="radio" name="food" [(ngModel)]="data.food" value="chicken">
<input type="radio" name="food" [(ngModel)]="data.food" value="fish">
<input type="radio" name="drink" [(ngModel)]="data.drink" value="cola">
<input type="radio" name="drink" [(ngModel)]="data.drink" value="sprite">
</form>`;

const fixture = tcb.overrideTemplate(MyComp8, t).createFakeAsync(MyComp8);
tick();
const fixture = tcb.overrideTemplate(MyComp8, t).createFakeAsync(MyComp8);
tick();

fixture.debugElement.componentInstance.data = {food: 'fish', drink: 'sprite'};
fixture.detectChanges();
tick();

fixture.debugElement.componentInstance.data = {
'chicken': new RadioButtonState(false, 'chicken'),
'fish': new RadioButtonState(true, 'fish'),
'cola': new RadioButtonState(false, 'cola'),
'sprite': new RadioButtonState(true, 'sprite')
};
fixture.detectChanges();
tick();
const inputs = fixture.debugElement.queryAll(By.css('input'));
expect(inputs[0].nativeElement.checked).toEqual(false);
expect(inputs[1].nativeElement.checked).toEqual(true);
expect(inputs[2].nativeElement.checked).toEqual(false);
expect(inputs[3].nativeElement.checked).toEqual(true);

dispatchEvent(inputs[0].nativeElement, 'change');
tick();

const input = fixture.debugElement.query(By.css('input'));
expect(input.nativeElement.checked).toEqual(false);
const data = fixture.debugElement.componentInstance.data;

dispatchEvent(input.nativeElement, 'change');
tick();
expect(data.food).toEqual('chicken');
expect(data.drink).toEqual('sprite');
expect(inputs[1].nativeElement.checked).toEqual(false);
expect(inputs[2].nativeElement.checked).toEqual(false);
expect(inputs[3].nativeElement.checked).toEqual(true);

const data = fixture.debugElement.componentInstance.data;
})));

});

expect(data['chicken']).toEqual(new RadioButtonState(true, 'chicken'));
expect(data['fish']).toEqual(new RadioButtonState(false, 'fish'));
expect(data['cola']).toEqual(new RadioButtonState(false, 'cola'));
expect(data['sprite']).toEqual(new RadioButtonState(true, 'sprite'));
})));

describe('setting status classes', () => {
it('should work with single fields',
Expand Down

0 comments on commit 39e0b49

Please sign in to comment.