Fragments 101

[honstar]

It'd be great if the fragments feature can be documented in more depth. I'd be happy to contribute a corresponding documentation and best practices once we have gathered all relevant information here.

Thanks @chrischrischris for providing the following high-level steps how to setup and use fragments:

1. Create a fragment by placing it in a /fragments/ folder (folder can be any depth, just needs to have that as part of the path)
2. Preview the fragment and copy the .page link
3. Paste the link into the document you want the fragment to appear in

A few code pointers:
https://github.com/adobecom/milo/blob/main/libs/utils/utils.js#L408
https://github.com/adobecom/milo/blob/main/libs/blocks/fragment/fragment.js

[vhargrave]

@honstar that sounds great :)

What I'd contribute to this is that you can also use blocks as normal within a fragment. They're going to be wrapped within the fragment on the main page though.
That means that if you want certain section-metadata to effect the blocks within the fragment for example, you'll need to place that section-metadata within the fragment file :).

Additionally, for most modals in milo, the content is defined within fragments.
A good example is the region modal:
https://milo.adobe.com/about/#langnav
If you look in the network tab you'll see that this modal is being loaded from the regions file in the fragments folder.