Component Installer has been deprecated. Use one of the following projects instead:
- Composer Installers Extender
- Asset Packagist
- Composer Asset Plugin
- Laravel Mix (Example: eventum/eventum#801 and eventum/eventum#812)
composer require oomphinc/composer-installers-extender
"extra": {
"installer-types": ["component"],
"installer-paths": {
"components/{$name}/": ["type:component"]
}
}
Component Installer for Composer 
Allows installation of Components via Composer.
composer require robloach/component-installer
{
"require": {
"robloach/component-installer": "*"
}
}To install a Component with Composer, add the Component to your composer.json
require key. The following will install jQuery and
normalize.css:
composer require components/jquery
composer require components/normalize.css
{
"require": {
"components/jquery": "2.*",
"components/normalize.css": "3.*",
"robloach/component-installer": "*"
}
}The easiest approach is to use the Component statically. Just reference the
Components manually using a script or link tag:
<script src="components/jquery/jquery.js"></script>
<link href="components/normalize/normalize.css" rel="stylesheet">For complex projects, a RequireJS configuration is available, which allows autoloading scripts only when needed. A require.css file is also compiled, including all Component stylesheets:
<!DOCTYPE html>
<html>
<head>
<link href="components/require.css" rel="stylesheet" type="text/css">
<script src="components/require.js"></script>
</head>
<body>
<h1>jQuery+RequireJS Component Installer Sample Page</h1>
<script>
require(['jquery'], function($) {
$('body').css('background-color', 'green');
});
</script>
</body>
</html>There are a number of ways to alter how Components are installed and used.
It is possible to switch where Components are installed by changing the
component-dir option in your root composer.json's config. The following
will install jQuery to public/jquery rather than components/jquery:
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public"
}
}Defaults to components.
While component-dir depicts where the Components will be installed,
component-baseurl tells RequireJS the base path that will use when attempting
to load the scripts in the web browser. It is important to make sure the
component-baseurl points to the component-dir when loaded externally. See
more about baseUrl in the
RequireJS documentation.
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public/assets",
"component-baseurl": "/assets"
}
}Defaults to components.
{
"require": {
"components/jquery": "*"
},
"config": {
"component-dir": "public/assets",
"component-baseurl": "/assets",
"component-scriptFilters": {
"\\Assetic\\Filter\\GoogleClosure\\CompilerApiFilter": []
},
"component-styleFilters": {
"\\Assetic\\Filter\\CssImportFilter": []
}
}
}To set up a Component to be installed with Component Installer, have it
require the package robloach/component-installer and set the type to
component, but it is not necessary:
{
"name": "components/bootstrap",
"type": "component",
"require": {
"robloach/component-installer": "*"
},
"extra": {
"component": {
"scripts": [
"js/bootstrap.js"
],
"styles": [
"css/bootstrap.css"
],
"files": [
"img/*.png",
"js/bootstrap.min.js",
"css/bootstrap.min.css"
]
}
}
}scripts- List of all the JavaScript files that will be concatenated together and processed when loading the Component.styles- List of all the CSS files that should be concatenated together into the final require.css file.files- Any additional file assets that should be copied into the Component directory.
Components can provide their own Component name. The following will install jQuery to components/myownjquery rather than components/jquery:
{
"name": "components/jquery",
"type": "component",
"extra": {
"component": {
"name": "myownjquery"
}
}
}Defaults to the package name, without the vendor.
Components can alter how RequireJS registers and interacts with them by changing some of the configuration options:
{
"name": "components/backbone",
"type": "component",
"require": {
"components/underscore": "*"
},
"extra": {
"component": {
"shim": {
"deps": ["underscore", "jquery"],
"exports": "Backbone"
},
"config": {
"color": "blue"
}
}
},
"config": {
"component": {
"waitSeconds": 5
}
}
}Current available RequireJS options for individual packages include:
Using repositories
in composer.json allows use of Component Installer in packages that don't
explicitly provide their own composer.json. In the following example, we
define use of html5shiv:
{
"require": {
"afarkas/html5shiv": "3.6.*"
},
"repositories": [
{
"type": "package",
"package": {
"name": "afarkas/html5shiv",
"type": "component",
"version": "3.6.2",
"dist": {
"url": "https://github.com/aFarkas/html5shiv/archive/3.6.2.zip",
"type": "zip"
},
"source": {
"url": "https://github.com/aFarkas/html5shiv.git",
"type": "git",
"reference": "3.6.2"
},
"extra": {
"component": {
"scripts": [
"dist/html5shiv.js"
]
}
},
"require": {
"robloach/component-installer": "*"
}
}
}
]
}Using extra
in composer.json allows use of Component Installer in packages that don't
explicitly provide support for component, but do ship with their own composer.json.
Using extra with packages that ship with Component Installer, will override component's settings for that package.
{
"require": {
"datatables/datatables": "~1.10"
},
"extra": {
"component": {
"datatables/datatables": {
"scripts": [
"media/js/jquery.dataTables.js"
],
"styles": [
"media/css/jquery.dataTables.css"
],
"files": [
"media/js/jquery.dataTables.min.js",
"media/css/jquery.dataTables.min.css",
"media/images/*.png"
]
}
}
}
}There are many other amazing projects from which Component Installer was inspired. It is encouraged to take a look at some of the other great package management systems:
Component Installer is licensed under the MIT License - see LICENSE.md for details.