Download the PHP package medienbaecker/kirby-modules without Composer
On this page you can find all versions of the php package medienbaecker/kirby-modules. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download medienbaecker/kirby-modules
More information about medienbaecker/kirby-modules
Files in medienbaecker/kirby-modules
Package kirby-modules
Short Description Easily add modules to your pages
License MIT
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 kirby-modules
Kirby Modules
This plugin makes it super easy to create modular websites with Kirby.
Features
📦 Module Creation
- 🗂️ Create modules in
site/blueprints/modules/[module].ymlandsite/snippets/modules/[module].php - 📁 Alternatively:
site/modules/[module]/folder with[module].ymland[module].phpinside - 🔧 Use the
make:moduleCLI command to generate new modules
🧩 Core Functionality
- 🔄 Automatically creates a hidden modules storage page for pages with a modules section
- 🎨 Keeps
changeTemplateoptions up to date - 🚚 Allows moving modules to other modules storage pages
- 🧭 Sets the
navigationoption so you can use the arrows to move between modules - 📄 Easily render modules with
<?= $page->modules() ?> - 🧰 Useful methods like
hasModules(),isModule()andmoduleId() - 🏷️ Optionally auto-generate unique slugs for modules
- 👁️ View draft modules on parent pages via the panel preview button
- 🔗 Extended
url()method with anchor links on the parent page - 🚦 Accessing Module URLs directly redirects to the parent page with an anchor
⚙️ Customization Options
- 🎛️ Set a default module type
- 🚫 Exclude specific module types
- 🚀 Option to auto-publish modules
- 🔀 Control redirect behavior after module creation
Installation
Download this repository to /site/plugins/kirby-modules.
Alternatively, you can install it with composer: composer require medienbaecker/kirby-modules
Quick Start
- Install the plugin
- Set up your first module in
site/blueprints/modules/[module].ymlandsite/snippets/modules/[module].php - Add a
modulessection to a page blueprint and create some modules - Render the modules in your template with
<?= $page->modules() ?>
I created an example repository with Kirby's plainkit, this plugin and three very simple modules.
Usage
What's a Module?
A module is a regular page, differentiated from other pages by being inside a modules container. This approach makes it possible to use pages as modules without sacrificing regular subpages.
Creating Modules
Similar to blocks, you can create module blueprints in site/blueprints/modules/ and module templates in site/snippets/modules/. E.g. site/blueprints/modules/text.yml and site/snippets/modules/text.php.
It's also possible to use a separate site/modules/ folder. In this case, you create your module blueprint in site/modules/text/text.yml and the module template in site/modules/text/text.php.
Adding Modules to Pages
Add a modules section to any page blueprint and a modules container will be automatically created.
Rendering Modules
In the template you can use <?= $page->modules() ?> to render the modules.
Example
site/blueprints/pages/default.yml
site/templates/default.php
site/blueprints/modules/text.yml
site/snippets/modules/text.php
You can access the module page object with $module and the parent page object with $page.
The $module->moduleId() method returns the module ID as a BEM class, e.g. module--text or module--gallery.
Configuration
The following options are available to add to your site/config/config.php:
Default Module Blueprint
Exclude Module Blueprints
Automatically generate slug
Autopublish Modules
Enable redirect
Customization
Custom Module Model
This plugin creates a ModulePage model, overwriting certain methods.
You can extend this model with your own model:
Manually define available modules
By default, this plugin automatically populates the create option of the modules section with all modules. If you want to manually define the available modules, you can do so in your blueprint:
License
This project is licensed under the terms of the MIT license.
