DORF Documentation

annotation

Assignes DorfCheckboxDefinition to a field. Field should be decorated with @DorfCheckbox() with parameters.

example

 //
 @DorfObject()
 class TestDomainObject {
   @DorfCheckbox({
     label: "Is smart?",
     mapping: {
       trueValue: "yes",
       falseValue: "no"
     },
     updateModelOnChange: true
   })
   private _smart: string;
 }

stable

annotation

Allows to render DORF form, which matches provided options. Adds additional behaviors like building metadata, reacting on changes, submitting the value. If no template/templateUrl specified in @Component(), it adds even a default template. @DorfForm() annotation should be added over @Component(), for the class which controls the form.

example

 // order
 @DorfForm()
 @Component({selector: "test-domain-object-form"})
 class TestDomainObjectForm implements IDorfForm {
   @DorfObjectInput()
   private domainObject: Person;

   constructor(public config: DorfConfigService)
 }

stable

annotation

Assignes DorfInputDefinition to a field. Field should be decorated with @DorfInput() with parameters.

example

 //
 @DorfObject()
 class TestDomainObject {
   @DorfInput({
     type: "text",
     label: "Name",
     updateModelOnChange: true
   })
   private _name: string;
 }

stable

annotation

Indicates that field in DorfObject is a nested DorfObject.

experimental

annotation

Adds information to the class, which is interpreted later by DORF mechanisms. Adds fieldDefinitions, based on property annotations. Results in something like DorfDomainObject extension.

Class should be decorated with @DorfObject(). Then, chosen properties should be annotated as well.

example

 //
 @DorfObject()
 class TestDomainObject {
   @DorfInput({
     type: "text",
     label: "Name",
     updateModelOnChange: true
   })
   private _name: string;

   @DorfSelect({
     optionsToSelect: [{
       key: 1,
       value: "red"
     }, {
       key: 2,
       value: "green"
     }, {
       key: 3,
       value: "blue"
     }],
     label: "Favourite color",
     updateModelOnChange: true
   })
   private _favColor: number;

   @DorfRadio({
     optionsToSelect: [{
       key: "m",
       value: "male"
     }, {
       key: "f",
       value: "female"
     }],
     label: "Gender",
     updateModelOnChange: true
   })
   private _gender: string;

   @DorfCheckbox({
     label: "Is smart?",
     mapping: {
       trueValue: "yes",
       falseValue: "no"
     },
     updateModelOnChange: true
   })
   private _smart: string;
 }

stable

annotation

Wrapps [Angular's Input]{@link Input} and stores property name for future processing by DorfForm. One field should be decorated with @DorfObjectInput() within @DorfForm().

example

 // order
 @DorfForm()
 @Component({selector: "test-domain-object-form"})
 class TestDomainObjectForm implements IDorfForm {
   @DorfObjectInput()
   private domainObject: Person;

   constructor(public config: DorfConfigService)
 }

stable

annotation

Assignes DorfRadioDefinition to a field. Field should be decorated with @DorfRadio() with parameters.

example

 //
 @DorfObject()
 class TestDomainObject {
   @DorfRadio({
     optionsToSelect: [{
       key: "m",
       value: "male"
     }, {
       key: "f",
       value: "female"
     }],
     label: "Gender",
     updateModelOnChange: true
   })
   private _gender: string;
 }

stable

annotation

Assignes DorfSelectDefinition to a field. Field should be decorated with @DorfSelect() with parameters.

example

 //
 @DorfObject()
 class TestDomainObject {
   @DorfSelect({
     optionsToSelect: [{
       key: 1,
       value: "red"
     }, {
       key: 2,
       value: "green"
     }, {
       key: 3,
       value: "blue"
     }],
     label: "Favourite color",
     updateModelOnChange: true
   })
   private _favColor: number;
 }

stable

example

 //
 export function CustomDecorator(options: IDorfCustomDefinition) {
   return createPropertyDecorator(new DorfCustomDefinition(options));
 }

stable

stable

stable

It is used internally by decorators and DorfFieldMetadata.

stable

stable