Git Product home page Git Product logo

vanilla-include's Introduction

vanilla-include

npm npm bundle size (minified) npm

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-include

Docs

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.

1. Create your file to include

<!-- path/to/file.html -->

<h1>Hello from vanilla-include!</h1>

2. Add vanilla-include and refer to file with data-include attribute

<!-- index.html -->

<body>
    <br data-include="path/to/file.html">
</body>
...
<script src="vanilla-include.min.js"></script>

3. 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.

License

MIT

vanilla-include's People

Contributors

seanmcp avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.