vanilla-include
v1.0.1
Published
A JavaScript implementation of php's include function for HTML templating.
Maintainers
seanmcpReadme
vanilla-include
A JavaScript implementation of php's include function for HTML templating.
Why?
php's include function is incredibly useful for simple HTML templating. This library seeks to implement a similar functionality with just vanilla JavaScript.
Install
Get CDN from UNPKG:
<script src="https://unpkg.com/vanilla-include"></script>Install via npm or yarn:
npm install --save vanilla-include
# or
yarn add vanilla-includeDocs
Basic
When your document loads, vanilla-include will look for all elements that have a data-include attribute and replace them with the target HTML file.
- Create your file to include
<!-- path/to/file.html -->
<h1>Hello from vanilla-include!</h1>- Add
vanilla-includeand refer to file withdata-includeattribute
<!-- index.html -->
<body>
<br data-include="path/to/file.html">
</body>
...
<script src="vanilla-include.min.js"></script>- Voila!
index.html will render like so:
<body>
<h1>Hello from vanilla-include!</h1>
</body>Details
The data-include attribute can be added to any element in your document. That means you can use vanilla-include to add things like <title> or <meta> tags.
In practice, the <br> tag is useful because it is both short and self-closing, but you can use whatever tag best fits your scenario.
Should the resource fail to load, vanilla-include will fail "silently" by setting the element's display style to none.