openhab-webui/bundles/org.openhab.ui/doc/components/oh-swiper-card.md

134 lines
3.2 KiB
Markdown

---
title: oh-swiper-card - Swiper Card
component: oh-swiper-card
label: Swiper Card
description: Display a swiper allowing to browse slides, in a card
source: https://github.com/openhab/openhab-webui/edit/main/bundles/org.openhab.ui/doc/components/oh-swiper-card.md
prev: /docs/ui/components/
---
# oh-swiper-card - Swiper Card
<!-- Put a screenshot here if relevant:
![](./images/oh-swiper-card/header.jpg)
-->
[[toc]]
<!-- Note: you can overwrite the definition-provided description and add your own intro/additional sections instead -->
<!-- DO NOT REMOVE the following comments if you intend to keep the definition-provided description -->
<!-- GENERATED componentDescription -->
Display a swiper allowing to browse slides, in a card
<!-- GENERATED /componentDescription -->
## Configuration
<!-- DO NOT REMOVE the following comments -->
<!-- GENERATED props -->
### Card
<div class="props">
<PropGroup name="card" label="Card">
Parameters of the card
<PropBlock type="TEXT" name="title" label="Title">
<PropDescription>
Title of the card
</PropDescription>
</PropBlock>
<PropBlock type="TEXT" name="footer" label="Footer text">
<PropDescription>
Footer of the card
</PropDescription>
</PropBlock>
<PropBlock type="BOOLEAN" name="noBorder" label="No Border">
<PropDescription>
Do not render the card border
</PropDescription>
</PropBlock>
<PropBlock type="BOOLEAN" name="noShadow" label="No Shadow">
<PropDescription>
Do not render a shadow effect to the card
</PropDescription>
</PropBlock>
<PropBlock type="BOOLEAN" name="outline" label="Outline">
<PropDescription>
Show the card outline
</PropDescription>
</PropBlock>
</PropGroup>
</div>
### Swiper
<div class="props">
<PropGroup name="swiper" label="Swiper">
<PropBlock type="BOOLEAN" name="pagination" label="Pagination">
<PropDescription>
Enable pagination
</PropDescription>
</PropBlock>
<PropBlock type="BOOLEAN" name="navigation" label="Navigation">
<PropDescription>
Enable navigation
</PropDescription>
</PropBlock>
<PropBlock type="BOOLEAN" name="scrollbar" label="Scrollbar">
<PropDescription>
Enable scrollbar
</PropDescription>
</PropBlock>
</PropGroup>
</div>
<!-- GENERATED /props -->
<!-- If applicable describe how properties are forwarded to a underlying component from Framework7, ECharts, etc.:
### Inherited Properties
-->
<!-- If applicable describe the slots recognized by the component and what they represent:
### Slots
#### `default`
The contents of the oh-swiper-card.
-->
<!-- Add as many examples as desired - put the YAML in a details container when it becomes too long (~150/200+ lines):
## Examples
### Example 1
![](./images/oh-swiper-card/example1.jpg)
```yaml
component: oh-swiper-card
config:
prop1: value1
prop2: value2
```
### Example 2
![](./images/oh-swiper-card/example2.jpg)
::: details YAML
```yaml
component: oh-swiper-card
config:
prop1: value1
prop2: value2
slots
```
:::
-->
<!-- Try to clean up URLs to the forum (https://community.openhab.org/t/<threadID>[/<postID>] should suffice)
## Community Resources
- [Community Post 1](https://community.openhab.org/t/12345)
- [Community Post 2](https://community.openhab.org/t/23456)
-->