DataCollection

The DataCollection component is the component we use for searching, filtering and sorting. It does not dictate any rendering of your data, but it does provide two different states/contextual components for rendering: when there are some results, when there are no results and also (by not using the contextual components) when the amount of results does not matter to what you want to render (say a count of number of results).

The component should be configured with the @type attribute, the component will use this to lookup 'specifications' for searching, sorting and filtering in the respective app/search/predicates, app/sort/comparators and app/filter/predicates folders. These specifications define what is searched when you search a list of objects (for example searching Name could mean searching model.Name whereas searching Role could mean searching through an array of item.RoleDefaults).

The component can also be further configured by specifications for how to search, for example we currently only use Exact searching (pretty much an indexOf search), but we also have fuzzy and regexp searching methods available (but disabled until needed). These search 'methods' will use the above specifications again to define what to search. Searching methods (the how) are in utils/search/{exact,fuzzy,regexp}.js and any new ones should implement at least a single search method.

Lastly, a SearchService in services/search.js configures what is available for what to search and how to search, so if you need to add new models or search methods, that is where to look.

<figure>
  <figcaption>Provide a widget to search with</figcaption>
  <input
    oninput={{action (mut this.term) value="target.value"}}
    type="text"
  />
</figure>

<figure>
  <figcaption>Get some data to search on</figcaption>
  <DataSource @src="/partition/nspace/dc-1/services" as |source|>

    <figure>
      <figcaption>and show the complete set of data</figcaption>
      {{#each source.data as |item|}}
        {{item.Name}},
      {{/each}}
    </figure>

    <hr />

    <figure>
      <figcaption>Use the component</figcaption>

      <DataCollection
        @type="service"
        @search={{this.term}}
        @sort={{'Name:asc'}}
        @filter={{hash
          searchproperties=(array 'Name')
        }}
        @items={{source.data}}
      as |collection|>
        Has {{collection.items.length}} results:

        <collection.Collection>
          {{#each collection.items as |item|}}
            {{item.Name}},
          {{/each}}
        </collection.Collection>
        <collection.Empty>
          Is Empty
        </collection.Empty>
      </DataCollection>

    </figure>

  </DataSource>
</figure>

Arguments

Yields

The DataCollection yields an object containing the following:

See

• Component Source Code
• Template Source Code