Download the PHP package silber/client-templates without Composer
On this page you can find all versions of the php package silber/client-templates. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download silber/client-templates
More information about silber/client-templates
Files in silber/client-templates
Package client-templates
Short Description Renders client templates from separate files into the main view of your application
License
Informations about the package client-templates
Client Templates
This package provides a simple mechanism for you to load up all your client template views into your main application view.
What? Why?
Single page applications (SPAs) usually work by having the templates rendered on the client. For bigger applications, those templates might be loaded asynchronously as you need them. For smaller applications, it may make more sense to load all of your templates with the initial page load.
Since HTML templates are pretty new and not yet widely supported, most frameworks rely on the templates being served within script
tags, marked up with some special type
attribute to indicate that it is in fact a template.
Using this package, you can keep your templates nicely organized, with each template in its own separate file. With one simple call, you can then inject all of your templates into your main application view.
Documentation
This is a framework-agnostic package. It also comes with special Laravel integration classes, but those are optional.
Begin by installing this package through Composer. Open your terminal to your project's root directory, and enter this at the prompt:
composer require "silber/client-templates:dev-master"
Laravel Integration
Once the composer installation completes, you can add the service provider and the alias. Open app/config/app.php
, and make the following changes:
1) Add a new item to the providers
array:
2) Add a new item to the aliases
array:
That's it! You're all set to go.
Usage
Now that you're all set up, you can start by actually creating your templates. Within the views
directory, create a new templates
directory. This is where you will keep all of your templates.
Here's a sample directory structure:
Within each of those files, you will have only the HTML for that particular template.
Then, within your main index.blade.php
file - right before the closing <body>
tag - add this tiny piece of code:
This will automatically render all of your templates, as follows:
You can now use these templates in your favorite JS framework!
Configuration
If you wish to change any of the package's default options, you will first need to publish the configuration file to your app's config
directory. You can do this by running the following artisan command:
This will create a new config file at config/templates.php
. You can now edit this file to change the default options.
Template Type
By default, the type
attribute is set to text/ng-template
, which is what AngularJS uses. This can be changed in the package's configuration file. For example:
Strip Extension
By default, the template file's extension will be stripped from the HTML id
attribute. If you wish to leave it in there, set it to false
:
This will then output templates with their file's extension intact. For example:
Exclude Pattern
Sometimes you may wish to exclude some files or directories from being rendered as their own templates:
Views Directory
By default, the base directory for the templates is in the views directory. If you wish to change that, you can do so by setting it here:
Contributing
Thank you for considering contributing! This project follows Laravel's coding style.
License
The client-templates
package is open-sourced software licensed under the MIT license.