frctl/fractal-docs

Document specifying a component as collator

mihkeleidast opened this issue · 0 comments

It's possible to specify a component as collator, but it is not documented. See frctl/fractal#593 for reference.

For example, in config:

module.exports = {
    collated: true,
    collator: '@my-collator',
    variants: [...]
};

And my-collator.hbs:

{{#each _variants}}
    {{{ this.markup }}}
    {{ this.item }}
{{/each}}

Needs to mention:

  • _variants special variable and its contents.
  • collator.hbs seems to be a "special" collator name that is automatically applied for a collection etc.

This should allow full customization of the collator, including using the path helper, since it'll be rendered through the engine.