Download the PHP package goldfinch/loadable without Composer
On this page you can find all versions of the php package goldfinch/loadable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download goldfinch/loadable
More information about goldfinch/loadable
Files in goldfinch/loadable
Package loadable
Short Description Load more implementation for Silverstripe with front-end component
License MIT
Informations about the package loadable
🦅 Loadable objects for Silverstripe
Load more implementation ⏳ for Silverstripe with front-end component 🌀. Easy to use and customize.
Available Taz commands
If you haven't used Taz🌪️ before, taz file must be presented in your root project folder cp vendor/goldfinch/taz/taz taz
Extend model making it loadable
Create loadable template
Install
1. Install module
2. Add key to your .env
Use Taz🌪️ to generate and add the key.
3. Generate config file
Use Taz🌪️ to generate the config. It will quickly lead you through the setup and take care of it for you.
4. Make sure these meta tags are presented in your header
5. Implement JavaScript front-end component
via Silverstripe Requirements PHP
via template require
via ES6 module
6. Create a loadable template (FYI)
The Taz command in the third step above would create the loadable template for your model so you don't really need to do anything here. Just for your information, if you are curious about how the templates initiate:
All loadable templates are stored within a single folder templates/Loadable
. The name should be the same as your targeted model's name.
Example:
Loadable template for app/Models/MyLoadableModel.php
would be themes/my_theme/templates/Loadable/MyLoadableModel.ss
(❗) The content in each template must start with a tag that has data-loadable-list-item
attribute which represents a single loadable item
Real-case example:
Usage
To call the loadable area use one of the examples below for further customization
Method 1 (quick preview for test)
Method 2 (basic)
Method 3 (fully customizable)
Method 4 (bridge - list through class method)
To use this method, we need to do a few more settings:
1) Call loadable instance passing $ID and $Method
Projects
in this example is a method inProjectCategory
model that returnsDataList
. It could be basic custom method orhas_many
/many_many
/belongs_many_many
2) Add bridge
to our config:
Other options
Properties like initial_loaded
, per_each_load
can be declared in database instead. Using SomeConfig. If you use Taz🌪️ command php taz loadable
, it will handle this setup for you anyway, but for your reference:
1) We need to specify dbconfig
in our config as shown in the example below
2) Based on the example above, our MyConfig class would look like this:
Sidenotes
manually extended model
If you don't want to use LoadableExtension
extension, you can prepare your loadable model
Events
Available JavaScript callback events
License
The MIT License (MIT)
All versions of loadable with dependencies
silverstripe/framework Version ^5.0
silverstripe/admin Version ^2.0
goldfinch/taz Version ^2.0
goldfinch/helpers Version ^2.0