Files
gancio/docs/embed.md

62 lines
2.3 KiB
Markdown
Raw Normal View History

2021-12-07 01:24:13 +01:00
---
layout: default
2021-12-07 16:34:42 +01:00
title: Embed events in webpages
2021-12-07 01:24:13 +01:00
permalink: /usage/embed
nav_order: 1
parent: Usage
---
2022-01-26 09:54:25 +01:00
## Embed a single event or a list of events in your webpage
{: .no_toc }
2021-12-07 01:24:13 +01:00
You can embed a list of filtered events or a specific event card in your webpage using a classic old-school `iframe` or a shiny new webcomponent.
2022-01-26 09:54:25 +01:00
1. TOC
{:toc}
2021-12-07 16:34:42 +01:00
## Webcomponents
2022-01-26 09:54:25 +01:00
[Webcomponents](https://www.webcomponents.org/introduction) usage requires a small (~5kB gzipped) js script to be loaded in your page (note that you should use your instance name):
2021-12-07 16:34:42 +01:00
```html
2021-12-07 01:24:13 +01:00
<script src='https://demo.gancio.org/gancio-events.es.js'></script>
```
2021-12-07 16:34:42 +01:00
### Embed a single event
To embed an event in webpages you use `<gancio-event>` custom element, you can copy the required code in **event's page > Embed > Copy**, should be like the following:
```html
<gancio-event id=17 baseurl='https://demo.gancio.org'></gancio-event>
```
2021-12-07 01:24:13 +01:00
<script src='https://demo.gancio.org/gancio-events.es.js'></script>
<gancio-event id=17 baseurl='https://demo.gancio.org'></gancio-event>
2021-12-07 16:34:42 +01:00
### Embed event lists
You can also embed a list of events using `<gancio-events>` custom element, you can copy the required code in **Export > List > Copy**
```html
2022-01-26 09:54:25 +01:00
<gancio-events baseurl='https://demo.gancio.org'>
<a href='https://demo.gancio.org'>Gancio Events</a>
</gancio-events>
2021-12-07 01:24:13 +01:00
```
2022-01-26 09:54:25 +01:00
<gancio-events baseurl='https://demo.gancio.org'><a href='https://demo.gancio.org'>Gancio Events</a></gancio-events>
2021-12-07 16:34:42 +01:00
> info "Customize"
> Note that you can modify the title (or completely remove it using an empty `title` param) and the icon,
> you can limit the list to a maximum number of events using the `maxlength` parameter and filter events by `tags` or `places` using that parameters (it's easier using **gancio** than to explain it here)
2022-01-26 09:54:25 +01:00
## IFrame
You can also use the old iframe method
<iframe src='https://demo.gancio.org/embed/17' style="width: 410px; border: none; height: 210px; overflow: hidden;"></iframe>
```html
<iframe src='https://demo.gancio.org/embed/17' style="width: 410px; border: none; height: 210px; overflow: hidden;"></iframe>
```
## Wordpress
To embed an event or a list of events into a [WordPress](https://wordpress.com) website you can use the [WPGancio](https://wordpress.org/plugins/wpgancio/) plugin, this allows you to use webcomponents and shortcodes and automatically includes the needed script in each page and post.