README.md 2.84 KB
Newer Older
Philipp Müller's avatar
Philipp Müller committed
1
2
# TYPO3 Extension `fancyBox`

3
4
5
6
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/pmlavitto)
[![Latest Stable Version](https://img.shields.io/packagist/v/lavitto/typo3-fancybox?style=for-the-badge)](https://packagist.org/packages/lavitto/typo3-fancybox)
[![TYPO3](https://img.shields.io/badge/TYPO3-fancybox-%23f49700?style=for-the-badge)](https://extensions.typo3.org/extension/fancybox/)
[![License](https://img.shields.io/packagist/l/lavitto/typo3-fancybox?style=for-the-badge)](https://packagist.org/packages/lavitto/typo3-fancybox)
Philipp Müller's avatar
Philipp Müller committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

> This extension adds a fancybox to your TYPO3 website.

- **Demo**: [www.lavitto.ch/typo3-ext-fancybox](https://www.lavitto.ch/typo3-ext-fancybox)
- **Gitlab Repository**: [gitlab.com/lavitto/typo3-fancybox](https://gitlab.com/lavitto/typo3-fancybox)
- **TYPO3 Extension Repository**: [extensions.typo3.org/extension/fancybox](https://extensions.typo3.org/extension/fancybox/)
- **Found an issue?**: [gitlab.com/lavitto/typo3-fancybox/issues](https://gitlab.com/lavitto/typo3-fancybox/issues)

## 1. Introduction

### Features

- Based on extbase & fluid
- Simple and fast installation
- No configuration needed
- Fully responsive

## 2. Installation

### Installation using Composer

The recommended way to install the extension is by using [Composer](https://getcomposer.org/). In your Composer based 
TYPO3 project root, just do `composer req lavitto/typo3-fancybox`.

### Installation from TYPO3 Extension Repository (TER)

Download and install the extension `fancybox` with the extension manager module.

## 3. Setup

1)  Simple include the static TypoScript of the extension.

## 4. Configuration

### Constants

This default properties can be changed by **Constant Editor**:

| Property           | Description                                    | Type      | Default value   |
| ------------------ | ---------------------------------------------- | --------- | --------------- |
| enableJquery       | Includes jQuery to the page                    | boolean   | false           |

49
50
51
52
53
54
55
56
57
58
## 6. fancybox License

**Please note the license requirements of the fancybox, which is used by this extension!**

fancybox is licensed under the GPLv3 license for all open source applications but a commercial license is required for all commercial applications (including sites, themes and apps you plan to sell).

More information about the fancybox license can be found here:
https://fancyapps.com/fancybox/3/#license

## 7. Contribute
Philipp Müller's avatar
Philipp Müller committed
59
60

Please create an issue at https://gitlab.com/lavitto/typo3-fancybox/issues.
61
62
63
64
65
66
67
68

**Please use GitLab only for bug-reporting or feature-requests. For support use the TYPO3 community channels or contact us by email.**

## 7. Support

If you need private or personal support, contact us by email on [info@lavitto.ch](mailto:info@lavitto.ch). 

**Be aware that this support might not be free!**