Download the PHP package somardesignstudios/silverstripe-sft-embed without Composer
On this page you can find all versions of the php package somardesignstudios/silverstripe-sft-embed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download somardesignstudios/silverstripe-sft-embed
More information about somardesignstudios/silverstripe-sft-embed
Files in somardesignstudios/silverstripe-sft-embed
Package silverstripe-sft-embed
Short Description Enables embedding the MSD Service Finder Tool in Silverstripe projects
License BSD-3-Clause
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 silverstripe-sft-embed
MSD Service Finder Tool Embed
This module facilitates the inclusion of the Service Finder Tool in a Silverstripe website.
About minified js file and its source code
In order to make updating the embed javascript doable, a source code file embed_source.js is added to the code repo, and the embed.js file is re-minified and compressed by online JS minify tool from https://www.toptal.com/developers/javascript-minifier.
The embed.js is then fully tested and behave as exactly as before.
Usage
Include the module code with composer require somardesignstudios/silverstripe-sft-embed.
You can then bind buttons to the Service Finder Tool by adding the default trigger class (.js-service-finder-tool-trigger) to relevant elements via the template helper $ServiceFinderToolTrigger:
The SomarDesignStudios\ServiceFinderTool\ControllerExtension will inject the necessary Javascript into the page when the trigger is used.
Cached content
The normal method will not work correctly if the element is wrapped with partial caching, in which case you will need to follow the steps below to trigger the injection manually.
Via configuration
To force the JavaScript to load on every page; add a configuration file service-finder-tool.yml with the following
Via manual implementation
If you want to attach the trigger to an element manually (for example, if the target element does not exist in the DOM during page load):
- Call
SomarDesignStudios\ServiceFinderTool\ControllerExtension::requireCoreJS()from your controller to inject the necessary Javascript - Bind the tool to a button element by calling
window.initServiceFinderTool('<element-css-selector>')
If you need to open the tool from your own Javascript, you can call window.openServiceFinderTool() directly, and you can close it by calling window.closeServiceFinderTool().
Security
This module can allow Javascript from a third-party source, and as such should be treated with a level of caution. Theoretically, this could change at any time. As a result, a copy of the Javascript has been included in the module, which will be periodically updated when the remote script is.
By default, the module will use the baked-in version of the Javascript. To shift to using the remote version, add the following to your config:
Special Thanks
- andrewandante/silverstripe-womens-refuge-shield for the base module structure
