Download the PHP package sitegeist/stampede without Composer
On this page you can find all versions of the php package sitegeist/stampede. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sitegeist/stampede
More information about sitegeist/stampede
Files in sitegeist/stampede
Package stampede
Short Description svg-sprite icons for Neos
License GPL-3.0-or-later
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 stampede
Sitegeist.Stampede
Svg Icons for Neos
The package renders icons based on svg files. The rendering is done inline or via an svg sprite that combines all svgs of a collection into one request.
Attention: This package use the external svg references for svg-sprites which are not supported in some older browsers. Please check this and use polyfills like this https://github.com/Keyamoon/svgxuse if needed.
Authors & Sponsors
- Wilhelm Behncke - [email protected]
- Martin Ficzel - [email protected]
The development and the public-releases of this package is generously sponsored by our employer https://www.sitegeist.de.
Configuration
The package manages icon collections that are defined via Neos settings. It is possible to configure an
collection from a path or by referenceing each item individually.
The generated svg sprites are cached for each collection in Production context. For the Development context the sprite cache is disabled. You can control this via setting:
The svg sprite sheet will get a cache-control header in Production context. You can adjust the value or disable this via setting:
A custom data source is included to allow editors to select icons in the Neos Inspector:
Mixins, Presets, Silhouettes
The package contains the Mixin Sitegeist.Silhouette:Mixin.Icon and the property-preset / silhouette stampede.icon.
Fusion
Sitegeist.Stampede:Icon has the following options:
identifier: string (required) combined identifier of collection and icon separated by a colon. Will override collection and icon values
collection: string (deprecated, use identifier in future) name of the icon collection
icon: string (deprecated, use identifier in future) name of the icon
class: string (optional) class to add to the svg tag
style: string (optional) style to add to the svg tag. Default is fill: currentColor; height: 1em;
inline: boolean render the svg inline. Default is false
To render icons the prototype Sitegeist.Stampede:Icon is used via afx like this.
If the inline option is set the svg content is directly put into the html instead of referencing
the spritesheet. This can improve the performance if many icons exist but only very few are used on a single page.
ATTENTION: It is highly recommended to create a wrapper prototype for icons that sets the required class and unsets the default style.
Additionally the prototype Sitegeist.Stampede:Icon.Preview renders a list of all iconCollections
as table to be viewed in the Sitegeist.Monocle styleguide.
Installation
Sitegeist.Stampede is available via packagist. Just run composer require sitegeist/stampede to install it. We use semantic-versioning so every breaking change will increase the major-version number.
Contribution
We will gladly accept contributions. Please send us pull requests.
