Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create carousel.html.twig #104

Merged
merged 5 commits into from
Aug 31, 2022
Merged

Create carousel.html.twig #104

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df87d96
Create carousel.html.twig
wucherpfennig Jul 5, 2022
d07c67b
Merge branch 'kevinpapst:main' into carousel
wucherpfennig Jul 7, 2022
dbd0399
Create components-carousel.md
wucherpfennig Aug 23, 2022
aee7037
Update components-carousel.md
wucherpfennig Aug 23, 2022
1710f93
updated docs and changed underscore to camelCase
kevinpapst Aug 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions docs/components-carousel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Components

This theme ships some components (as twig macros) that hide the complexity of rendering the same elements over and over again with the correct HTML.

See Tabler documentation at https://preview.tabler.io/carousel.html

## Carousel

### Parameters
`carousel()` macro, waits for 2 parameters:

| Parameter | Description | Type | Default |
|:---------:|:---------------------------|:---------:|:-------:|
| items | Array of [Item](#Step) | `array` | `[]` |
| options | [Options](#Options) object | `object` | `{}` |

#### Item
| Parameter | Description | Type | Default |
|:-----------:|--------------------------------------------|:---------:|:-----------------:|
| image | Path to an image | `string` | |
| custom_content | Custom html content. overrides `image` if set. | `html (raw)` | `null` |
| title | Item title. | `string` | `null` |
| description | Item description. | `string` | `null` |

#### Options
| Parameter | Description | Type | Default |
|:----------:|------------------------------------------------------|:---------:|:--------------:|
| id | Custom `id` to apply to the carousel | `mixed` | `rand(Number)` |
| extraClass | Add extra classes on steps container | `string` | _empty string_ |
| interval | Interval to change the slides | `int` | 5000 |
| touch | Support touch input. See: https://getbootstrap.com/docs/5.2/components/carousel/#options | `boolean` | `true` |
| pause | Auto stop sliding. See: https://getbootstrap.com/docs/5.2/components/carousel/#options | `mixed` | `false` |
| wrap | Restart again. See: https://getbootstrap.com/docs/5.2/components/carousel/#options | `boolean` | `true` |
| controls | Show controls | `boolean` | `false` |
| caption_custom_class | Apply custom class to caption | `string` | `d-none d-md-block` |
| caption_background | Show caption background | `boolean` | `true` |
| indicators | Show indicators | `boolean` | `true` |
| indicators_type | Set indicators type: `dots`, `thumbs` | `string` | _empty string_ |
| indicators_ratio | Set indicators ratio. See docs tabler | `string` | _empty string_ |
| indicators_orientation | Set indicators orientation. See docs tabler | `string` | `horizontal` |

### Usage

```twig
{% from '@Tabler/components/carousel.html.twig' import carousel %}

{% set items =
{
'key0':
{
'image': 'https://via.placeholder.com/640x360/1485bc/ffffff?text=Image+0',
},
'keyContent':
{
'custom_content': '<h1>Hello World</h1>',
},
'key1':
{
'image': 'https://via.placeholder.com/640x360/9dbf00/ffffff?text=Image+1',
'title': 'SOME Fancy Title',
'description': 'Lorem Ipsum NO HTML',
},
'key2':
{
'image': 'https://via.placeholder.com/640x360/bc147a/ffffff?text=Image+2',
},
'key3':
{
'image': 'https://via.placeholder.com/640x360/1454bc/ffffff?text=Image+3',
}
}
%}

{% set options =
{
'interval': false,
'controls': true,
'indicators': true,
'indicators_type': 'thumbs',
'indicators_orientation': 'vertical',
}
%}

{ { carousel(items, options) } }
```

## Next steps

Please go back to the [Tabler bundle documentation](index.md) to find out more about using the theme.
88 changes: 88 additions & 0 deletions templates/components/carousel.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
{% macro carousel(items, options) %}
{% set _id = options.id ?? ('carousel-' ~ random(0, 999)) %}
{% set _extraClass = options.extraClass ?? '' %}

{% set _interval = options.interval ?? 5000 %}
{% set _touch_enabled = options.touch ?? true %}
{% set _pause = options.pause ?? false %}
{% set _wrap = options.wrap ?? true %}

{% set _show_controls = options.controls ?? false %}

{% set _caption_class = options.caption_custom_class ?? 'd-none d-md-block' %}
{% set _show_caption_background = options.caption_background ?? true %}

{% set _show_indicators = options.indicators ?? true %}
{% set _indicators_type = options.indicators_type ?? '' %}
{% set _indicators_ratio = options.indicators_ratio ?? '' %}
{% set _indicators_orientation = options.indicators_orientation ?? 'horizontal' %}

<div id="{{ _id }}" class="carousel slide {{ _extraClass }}" data-bs-ride="carousel"
data-bs-interval="{{ _interval == false ? 'false' : _interval }}"
data-bs-touch="{{ _touch_enabled ? 'true' : 'false' }}"
data-bs-pause="{{ _pause == true ? 'true' : 'hover' }}" data-bs-wrap="{{ _wrap ? 'true' : 'false' }}">
{% if _show_indicators %}
{{ _self.carousel_indicators(items, _id, _indicators_type, _indicators_orientation, _indicators_ratio) }}
{% endif %}
{% if _show_controls %}
<button class="carousel-control-prev" type="button" data-bs-target="#{{ _id }}" data-bs-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
</button>
<button class="carousel-control-next" type="button" data-bs-target="#{{ _id }}" data-bs-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
</button>
{% endif %}
<div class="carousel-inner">
{% for item in items %}
{% set _has_custom = item.custom_content is defined %}
{% if _has_custom %}
{# This is useless: breaks contents and no additional value as making everything same size is cumbersome #}
<div class="carousel-item">
{{ item.custom_content | raw }}
</div>
{% else %}
<div class="carousel-item {% if loop.first %}active{% endif %}">
<img src="{{ item.image }}" class="d-block w-100">
{% if item.title is defined or item.description is defined %}
{% if _show_caption_background %}
<div class="carousel-caption-background {{ _caption_class }}"></div>
{% endif %}
<div class="carousel-caption {{ _caption_class }}">
{% if item.title %}
<h3>{{ item.title }}</h3>
{% endif %}
{% if item.description %}
{{ item.description }}
{% endif %}
</div>
{% endif %}
</div>
{% endif %}
{% endfor %}
</div>
</div>
{% endmacro %}

{% macro carousel_indicators(items, id, type, orientation, ratio) %}
{% set _typeClass = '' %}
{% if type == 'dots' %}{% set _typeClass = 'carousel-indicators-dot' %}{% endif %}
{% if type == 'thumbs' %}{% set _typeClass = 'carousel-indicators-thumb' %}{% endif %}

{% set _orientationClass = '' %}
{% if orientation == 'vertical' %}{% set _orientationClass = 'carousel-indicators-vertical' %}{% endif %}
{% set _ratio = 'ratio ' ~ (ratio == '' ? 'ratio-1x1' : ratio) %}

<div class="carousel-indicators {{ _typeClass }} {{ _orientationClass }}">
{% for item in items %}
{% set _item_class = loop.first ? 'active' : '' %}
{% set _item_style = '' %}
{% if type == 'thumbs' %}
{% set _item_image = item.image ?? '' %}
{% set _item_class = _item_class ~ ' ' ~ _ratio %}
{% set _item_style = 'background-image: url(\'' ~ _item_image ~ '\');' %}
{% endif %}
<button type="button" data-bs-target="#{{ id }}" data-bs-slide-to="{{ loop.index - 1 }}"
class="{{ _item_class }}" style="{{ _item_style }}"></button>
{% endfor %}
</div>
{% endmacro %}