@zhongruigroup/ngx-query v5.0.0-beta.2

ngx-query

Demo

http://ngx-query.sharekudu.lunztech.cn/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

ngx-query is a component for Angular 4+. A person searches data easily through ngx-query.

Features

• Quick search panel
• Quick Collapse search panel
• Advanced search panel
• Query templates
• Custom value input box
• Custom Toolbar
• Multi-language

Installation

• Install through npm:

npm install --save @zhongruigroup/ngx-query

• Then include in your apps module:

  import { Component, NgModule } from '@angular/core';
  import { NgxQueryModule } from 'ngx-query';
  
  @NgModule({
    imports: [
      NgxQueryModule.forRoot({
        labels:{
          buttons: {
            'quick': 'Quick',
            ...
          },
          ...
        },
        ...
      })
    ]
  })
  export class MyModule {}

  You may also find it useful to view the demo source.

• Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template:
    '<ng-query #ngxQuery [title]="queryTitle" [fields]="fields" [queryTemplates]="queryTemplates" (query)="search($event)"></ng-query>'
})
export class MyComponent {}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/ngx-query/bundles/ngx-query.umd.js"></script>
<script>
    // everything is exported ngxQuery namespace
</script>

Documentation

https://gitlab.lunz.cn/lunz-ui-library/ngx-query

api

1. ngx-query

input property

output event

property

method

2. ngx-query-field

input property

3. ngx-query-disable-input

input property

4. foRoot config

Development

Prepare your environment

• Install Node.js and NPM
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

npm run release

License

MIT