AFT is A2+ module giving a solution for common problem - creation a table with firebase as a backend. It was decided to avoid using third part services as firebase cloud functions or writing own observer servers using node. Before you start it is strongly recommended to read an this article.
-
SortableTableComponentdoc -
SortableTableServicedoc -
SortableItemDirectivedoc -
DialogDirectivedoc -
InfiniteScrollDirectivedoc -
PriorityKeysPipedoc
npm install @nodeart/ngfb-sortable-table --save
Module is supplied with set of features that could be useful while working with tables such as
search, sort, filter and infinite scroll.
Due to limitations of firebase querying there are no complicated logic under the hood.
According to firebase documentation one can use only one orderBy query at a time.
There are 4 types of events could have happen. Each of them has its own querying rules and usage restrictions.
| Events | InfiniteScroll | SortByHeader | FilterByInput | FilterBySelect |
|---|---|---|---|---|
| Reset previous query | false |
true |
true |
true |
| Basic query | {orderByKey: true} |
{limitTo(First/Last): number, orderByChild: field} |
{orderByKey: true} |
orderByChild: field |
| Priority | medium | low | low | high |
-
InfiniteScroll:
InfiniteScroll is a default event and first request to database will be done with it if no config for
FilterBySelectprovided; It is the only event that doesn't reset previous query, only add the offset. Fires when user is reached the bottom of the page.Restrictions:
-
@Input paginationis passed;
-
-
SortByHeader:
SortByHeader is an event that happen after toggling the arrow button on
sortableheader items.Restrictions:
- field to be sorted by has primitive value;
- field to be sorted by is not nested inside the object;
Resets other queries.
-
FilterByInput:
FilterByInput is an event happen when user input some data in a search string. Input is debounced by default.
Restrictions:
- field to be filtered by is a string;
- field to be sorted by is not nested inside the object;
-
@Input filterByInputValueis passed in;
Resets other queries.
-
FilterBySelect:
FilterBySelect event has the greatest priority value. If it is passed in than the first request to database will be made by the rules of this event.
Restrictions:
- field to be filtered by has primitive value;
- field to be filtered by is not nested inside the object;
-
@Input filterBySelectis passed in;
Resets other queries.
- To improve firebase query performance use
.indexOnrule in your database rules. - The selector of
TableItemComponentthat you pass insideSortableTableComponentmust be attributive in order to be properly displayed. Example:tr [sortableTableItem]. - To sort your headers use
PriorityKeysPipeand pass enum with a list of headers as an argument and the list of headers you'd prefer not to show. - Always bind
setHeadersfunction to your container component context (see basic usage) if you usethiskeyword in this function. As child component doesn't not know who his parent actually is, we can't useforward refto done this.