ngx-property-grid
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

License: MIT npm version Build Status

NgxPropertyGrid

A small and simple property grid in angular to view/edit POJOs, excellent if you have a "settings" object you want to give the user to edit (that's why I have created it). Play online.

Dependencies

  • angular

Usage

  • The metadata options
export interface PropertyItemMeta {
    name: string; // The display name of the property in the grid
    description?: string; // A description of the property, will be used as tooltip on an hint element (a span with text "[?]")
    order?: number; // The display order.
    group?: string; //  The group this property belongs to
    hidden?: boolean; // Whether this property should be hidden in the grid, default is false (can be omitted).
    initState?: string; // - hidden/visible.
    componentType?: Type<ControlValueAccessor | ICustomDynamicComponent<any>>; // an custom component should be implement
    // ControlValueAccessor or ICustomDynamicComponent<any>
    componentOptions?: any;
    colSpan2?: boolean; //  - true/false. If true then property input will span both columns and will have no name/label
    // (useful for textarea custom type)
    type?: string; // boolean number options label color
    valueConvert?: (value: any) => any; // convert the value, eg. parseInt
}
  • The Example Options
export class ExampleEditorOptions {
    @meta({name: 'Font', description: 'The font editor to use', componentType: SimpleTextEditorComponent, group: 'Editor', hidden: false})
    font = 'Source Code Pro';

    @meta({name: 'Font size', group: 'Editor', type: 'number', valueConvert: parseInt})
    fontSize = 14;

    @meta({name: 'Font color', group: 'Editor', type: 'color'})
    fontColor = '#51f41c';

    @meta({name: 'jQuery', group: 'Plugins', type: 'checkbox'})
    jQuery = true;

    @meta({name: 'modernizr', description: 'Whether or not to include modernizr on the page', group: 'Plugins', type: 'checkbox'})
    modernizr = false;

    @meta({
        name: 'Framework',
        description: 'Whether to include any additional framework',
        type: 'options',
        options: ['None', {text: 'AngularJS', value: 'angular'}, {text: 'Backbone.js', value: 'backbone'}]
    })
    framework = 'None';
}
  • The html part:

    • Basic

      <ngx-property-grid [width]="'300px'" [options]="editor"></ngx-property-grid>
    • template

      <ngx-property-grid [width]="'300px'" [options]="editor">
          <ng-template propertyType="text" let-p>
              <input type="text" [value]="p.value" (change)="p.value = $event.target.value">
          </ng-template>
          <ng-template propertyType="color" let-p>
              <input type="color" [value]="p.value" (change)="p.value = $event.target.value">
          </ng-template>
      </ngx-property-grid>
  • The result would be: See here

The metadata object

As seen from the example above the metadata object can be used (it's optional) in order to describe the object properties. Each proprty in the metadata object could have the following:

  • name - The display name of the property in the grid
  • description - A description of the property, will be used as tooltip on an hint element (a span with text "[?]")
  • hidden - Whether this property should be hidden in the grid, default is false (can be omitted).
  • group - The group this property belongs to
  • type - The type of the property, supported are:
    • boolean or checkbox - A checkbox would be used
    • number - simple textbox
    • color - simple textbox
    • options - A dropdown list would be used in case the metadata contains the options array property
    • label - A label will be used, useful for uneditable / read-only properties
  • componentType - An angular component
  • colspan2 - true/false. If true then property input will span both columns and will have no name/label (useful for textarea custom type, see example/index.html)

Package Sidebar

Install

npm i ngx-property-grid@1.0.1

Version

1.0.1

License

MIT

Unpacked Size

13.5 MB

Total Files

114

Last publish

Collaborators

  • mokeyish