Bug: Component preview layout only renders if not in the compound component folder

[paulrobertlloyd]

Given a component (hr.hbs):

<hr>

with the following config (hr.config.yml):

label: "Horizontal rule"
notes: |
  The `hr` element represents a paragraph-level thematic break, e.g., a scene change in a story, or a transition to another topic within a section of a reference book.
preview: "@preview"

and the following preview layout (_preview.hbs):

<p>…</p>

{{{yeild}}}

<p>…</p>

A component is only rendered if the preview layout is in a folder above the compound folder. So this:

├── components
│   └── hr
│   │   ├── _preview.hbs
│   │   ├── hr.config.yml
│   │   ├── hr.hbs

doesn’t work, but this:

├── components
│   ├── _preview.hbs
│   └── hr
│   │   ├── hr.config.yml
│   │   ├── hr.hbs

does. Is this the expected behaviour?

[allmarkedup]

This is actually expected behaviour - a component folder (one in which the name of the folder matches the name of the component view template) can't contain other components, which the preview layout is. regular folders (collections) can contain multiple components however. Should add something to the docs about this though maybe.

Does that make sense? Is the difference between a 'collection' and a component in a directory clear?

[paulrobertlloyd]

Ah right, it does makes sense. I may be trying to be too precise, but if I wanted to have a specific preview for each (or many) components, I would end up with a lot of preview layouts (somewhere). Not a big issue, but worth pointing out.

[allmarkedup]

Yeah I can see that. I guess I just didn't think of preview layouts as much more than just adding stylesheet and JS links so didn't imagine needing more than a couple. I could maybe make it so that if you have a preview.hbs or similarly named layout in the same directory as your component then it's uses that for the preview layout by default.

I'll have a think if that has any other implications...