@enigmatry/entry-components 1.2.64 → 1.2.66

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enigmatry/entry-components",
-  "version": "1.2.64",
+  "version": "1.2.66",
   "author": "Enigmatry",
   "description": "Enigmatry entry angular material components",
   "homepage": "https://github.com/enigmatry/entry-angular-building-blocks/tree/master/projects/entry-components#readme",

package/search-filter/README.md

@@ -0,0 +1,59 @@
+# Entry Search Filter
+
+Entry component for providing standard filtering capabilities that can be consumed by entry-table component, but also any other list data represetation component like Angular material table component.
+
+## Imports
+
+```ts
+import { EntrySearchFilterModule } from '@enigmatry/entry-components/search-filter';
+```
+
+## Basic usage
+
+`entry-search-filter` is used to provide simple configuration and usage of data filtering:
+
+```html
+<entry-search-filter
+    [searchFilters]="query.filters"
+    (searchFilterChange)="searchFilterChange($event)">
+</entry-search-filter>
+```
+
+## Configuration
+
+`ENTRY_SEARCH_FILTER_CONFIG`: `InjectionToken<EntrySearchFilterConfig>` - Optional configuration used to override defaults.
+
+```ts
+import {
+  EntrySearchFilterModule,
+  ENTRY_SEARCH_FILTER_CONFIG,
+  EntrySearchFilterConfig
+} from '@enigmatry/entry-components/search-filter';
+// ...
+
+@NgModule({
+  imports: [
+    EntrySearchFilterModule
+  ],
+  providers: [
+    {
+      provide: ENTRY_SEARCH_FILTER_CONFIG,
+      useFactory: () => new EntrySearchFilterConfig({
+        applyButtonText: 'Filter'
+      })
+    }
+  ]
+})
+export class AppModule { }
+```
+
+## Classes and Interfaces
+
+| `EntrySearchFilterComponent` |  |
+| - | - |
+| @Input() searchFilters: `SearchFilterBase<string>[]` | Accepts the configuration of the search filters inputs that will be displayed in the search-filter component. |
+| @Output() searchFilterChange: `EventEmitter<SearchFilterParams>` | Emits the change in SearchFilterParams so the containing component can apply them and retreive the filtered results. SearchFilterParams are the same type as @angular/router type Params for easy integration. |
+
+| `EntryDialogConfig` |  |
+| - | - |
+| applyButtonText: `string` | Apply filters button text (default: 'Apply') |