README.html

<h1 id="entity-reference-ajax-formatter">Entity Reference Ajax Formatter</h1>
<h2 id="about">ABOUT</h2>
<p>Entity Reference Ajax Formatter provides a new configurable field formatter for entity reference fields. This formatter lets you select how many entities to render as well as providing some extra sorting options for display only. However the standout feature is an AJAX enabled Load More link. This lets you initially load say 3 references and then if the user wants to see more, click the link and display more inline. <img src="images/example.png" alt="Example" /></p>
<p>The widget has the same option of selecting the desired view mode to render the entities with and provides 4 extra settings:</p>
<ul>
<li><code>Number</code>(6): Number of entities to render to start with.</li>
<li><code>Sort</code> (Default): Provides a few extra sorting options that only affects this view mode.</li>
<li><code>Load More</code> (FALSE): Provide an AJAX link to load more referenced entities.</li>
<li><code>Max</code> (0): Maximum number to render. 0 is all entities referenced by the field. (Only visible if Load More is selected.)</li>
</ul>
<figure>
<img src="images/settings.png" alt="Form" /><figcaption>Form</figcaption>
</figure>
<h2 id="requirements">REQUIREMENTS</h2>
<p>Drupal 8 is required, Drupal 8.6.x or higher is suggested - automatic tests only on Drupal 8.6+, manually tested on 8.5.x.</p>
<h2 id="installation">INSTALLATION</h2>
<p>Install as you would normally install a contributed Drupal module. See the <a href="//drupal.org/documentation/install/modules-themes/modules-8">install docs</a> if required in the Drupal documentation for further information.</p>
<h2 id="configuration">CONFIGURATION</h2>
<p>Configuration can be set as normal for field formatters through the Field UI for example, for a entity reference feild on the article node type, that would be on <code>/admin/structure/types/manage/article/form-display</code>.</p>
<h2 id="credits">CREDITS</h2>
<p>Primarily developed as part of a <a href="https://northstudios.com">North Studios</a> project - thanks for the permission to release this back to the community. Major thanks to the rest of my team for code review, feedback and discussion.</p>
<h2 id="faq">FAQ</h2>
<p>Any questions? Ask away on the issue queue or contact the maintainer <a href="https://drupal.org/u/nickwilde">Nick Wilde</a>.</p>