Download the PHP package aoe/imgix without Composer
On this page you can find all versions of the php package aoe/imgix. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package imgix
Short Description Provides the Auto Responsive Images feature of imgix called imgix.fluid()
License GPL-3.0
Homepage https://github.com/AOEpeople/TYPO3-Imgix
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package imgix
TYPO3-Imgix
The "imgix" TYPO3 extension provides the Auto Responsive Images feature of imgix called imgix.fluid(). This allows you to deliver perferctly custom sized images for the client without using local capaticities. For more details have a look at imgix, imgix.fluid() and the JS library imgix.js.
In addition this extension provides some additional features like:
- Supports different integrations (jQuery and AngularJS)
- Fallback scenario if you disable the fluid feature
- Observation of asynchronously added images
Missing/Upcoming features:
- Currently this extension is limited to images on which you have access to manipulate the way the image is outputted to the browser. The reason for that is that img tags must have a specific class set and a data-src attribute in which the image url is stored. In future releases we will implement this in TYPO3´s standard rendering.
- Version 3 of imgix.js is not supported yet
Download / Installation
Documentation
Activate Extension
Once the "imgix" extension is installed you have to activate the extension in the TYPO3 "Extension Manager". You can do that by using the the TYPO3 Backend Module or using the comand line tool.
Configure Extension
Click the "configure" action button to open the configuration. You can also do that by clicking the extension title.
The configuration is seperated in two parts: "basic" and "imgix"
basic
The basic configuration includes specific settings of the extension which you need to set up for your project.
basic.apiKey
This is the apiKey you have specified in the imgix webapp. The API-key must be configured when you want to purge images in imgix. For further information have a look at the imigx doumentation.
basic.host
This is the host you have specified in the imgix webapp as source for your project. Be aware that you have to use the "Web Folder" source in imgix. For further information have a look at the imigx doumentation.
basic.enabled
If basic.enabeld is set to false, the JS will never be rendered into browser.
basic.enableFluid
Check this configuration if the image urls should be replaced by the configured basic.host configuration. If basic.enabeld is set to false, it will cause a fallback behavior: all image urls will be used as they are. This is helpful if you want to disable the responsive images from imgix using a simple checkbox without having broken or missing images.
basic.enableObservation
If your JS adds images dynamically/asynchroniously, this setting will observe these changes to the DOM and will add the responsive image feature to new HTML image tags. Be careful by enabling this option. This feature is realized by Mutation Observers which is not supported by all browsers at the moment.
imgix
The imigx configurations are imgix.js related settings. For a detailed description about the options, take a look at the documentation.
imgix.defaultUrlParameters
If some of the URL API Parameters should be set by default, list them here as a GET-Parameter string, e.g. q=75&fit=max
Include
To use this extension you have to add a static template file to your template record.
- "imgix: Common Constants (imgix)"
Now you have to take a decision for one of the supported integrations:
AngularJS
For AngularJS you have to add these two static template files to your template record:
- imgix: Load Angular Extbase-Plugin for further usage (imgix)
- imgix: Include Angular-Module files into page (imgix)
jQuery
For jQuery you have to add these two static template files to your template record:
- imgix: Load Jquery Extbase-Plugin for further usage (imgix)
- imgix: Include Jquery-Plugin files into page (imgix)
Usage
AngularJS Module
Add the module dependency
Use the "aoe-imgix" directive for images
jQuery Plugin
To use responsive images you have to add the following class and attribute to you HTML image tag:
- add the "image-fluid" class defined in fluidClass
- add the the data-src attribute.
License
License: GPLv3 or later. See LICENSE.
Contributing
1. Fork the repository on Github
2. Create a named feature / bugfix branch (like `feature/add-something-new` or `bugfix/thing-which-does-not-work`)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using GithubAll versions of imgix with dependencies
ext-json Version *
ext-curl Version *
typo3/cms-backend Version ^11.5
typo3/cms-core Version ^11.5
typo3/cms-fluid Version ^11.5
typo3/cms-extbase Version ^11.5