https://github.com/sjelfull/craft3-templateselect
A fieldtype that allows you to select a template from the site templates folder.
https://github.com/sjelfull/craft3-templateselect
craft-plugin craft3 craftcms craftcms-plugin fieldtype
Last synced: 4 months ago
JSON representation
A fieldtype that allows you to select a template from the site templates folder.
- Host: GitHub
- URL: https://github.com/sjelfull/craft3-templateselect
- Owner: sjelfull
- License: mit
- Created: 2017-10-29T00:56:13.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T21:39:52.000Z (about 2 years ago)
- Last Synced: 2025-06-05T01:31:05.646Z (about 1 year ago)
- Topics: craft-plugin, craft3, craftcms, craftcms-plugin, fieldtype
- Language: PHP
- Homepage: https://superbig.co
- Size: 1.14 MB
- Stars: 17
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Template Select plugin for Craft CMS
A fieldtype that allows you to select a template from the site templates folder.
## Requirements
This plugin requires Craft CMS 4.0 or later.
## Installation
To install the plugin, follow these instructions.
1. Open your terminal and go to your Craft project:
cd /path/to/project
2. Then tell Composer to load the plugin:
composer require superbig/craft3-templateselect
3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Template Select.
## Configuring template select
Create a new field and choose field type Template Select.
In the field settings, you can limit the list of available templates to a subfolder of the Craft templates folder. The path is relative, i.e. _subfolder/anotherfolder_. This may also be set to an ENV variable.
In the field settings, you can choose to make the template names more user friendly. In the field, the list will be improved by changing the following:
- file extensions will be removed
- the file names will be capitalized and spaced for readability
- folders will be separated by ›
## Adding descriptions to templates
You can add descriptions to your templates to help users understand what each template does. This is especially useful when you have many templates to choose from.
To add a description to a template, add a special comment at the beginning of your template file:
```twig
{# @description: Displays a paginated list of blog posts with thumbnails and excerpts #}
```
The description will appear in the dropdown next to the template name, making it easier for content editors to select the right template.
**Examples:**
```twig
{# @description: Contact form with validation and CAPTCHA support #}
...
```
```twig
{# @description: Hero section with background image and call-to-action button #}
...
```
Descriptions can also span multiple lines:
```twig
{# @description: Complex product grid layout
Includes filters, sorting, and pagination
Supports up to 4 columns #}
```
**Note:** Templates without descriptions will still work normally and appear in the dropdown without any description text.
## Using template select
### Output the chosen template name:
```twig
{{ entry.fieldHandle }}
```
### Include/Embed the chosen template:
```twig
{% include entry.fieldHandle %}
```
### Include the template including subfolder if set:
```twig
{% include entry.fieldHandle.withSubfolder() %}
```
This is a alias for the following:
```twig
{{ entry.templateWithSubfolder.template(true) }}
```
### Output the subfolder name:
```twig
{{ entry.fieldHandle.subfolder() }}
```
### Output the filename without path:
```twig
{{ entry.fieldHandle.filename() }}
```
Brought to you by [Superbig](https://superbig.co)