Xatframe

From xat wiki
Revision as of 13:22, 16 June 2020 by LaFleur (talk | contribs)

To further customize the outer background of your group, you can provide a link to an HTML document that will be embedded via iframe (known as a "xatframe") behind your chat. Within the embedded page, you can use any combination of HTML/CSS/JavaScript that you like including animations, generated content, etc.

This replaces the custom CSS styling that is currently used to customize chats, which no longer works on the new website.

xatframe library

The xatframe library provides a list of user-submitted xatframes free to use by the community.

Adding a xatframe to your group

Figure 1: Adding a xatframe to your group

1. Go the xatframe library.

2. Click “copy” on any xatframe. This will copy the xatframe url. (Figure 1)

3. Hover over "group" at the top right of your group, click "customize" and enter your group password. Alternatively, you can use the direct edit group link.

4. Add the url to the "xatframe" field on the appearance tab. (Figure 1)

5. Save changes and the xatframe will be live on your group.

Note: You must also use an outer background when using a xatframe so that there is a fallback if users have xatframes disabled.

Submitting a xatframe

You can submit a xatframe so that it will appear in the library (forum account required). Your xatframe must follow the rules mentioned on the forum and below in order to be approved.

Making your own xatframe

If you want to create your own embedded webpage, you will first need to have somewhere to host your webpage. For this, we recommend you use github.io as it is easy to set up and is already pre-unblocked. If you wish to use your own domain, you will need to have it unblocked by making a ticket.

For more information on setting up GitHub pages, you can visit their website.

xatframe settings

xatframe rules

You must ensure the xatframe you use complies with the rules below, even if taken from a third party.

Note: xat reserves the right to change these rules without notice.

IMPORTANT: Failure to follow these rules may result in your chat group being deleted or permanently delisted and having all of its media removed. xat may also apply a block to your account, depending on the offence.

  • Must be suitable for viewing by all ages.
  • No IP trackers or content that can be used to track IP addresses.
  • Do not store any cookies etc. without permission.
  • No chats to be embedded in iframe.
  • Do not use animations that may be intrusive to the chatting experience.
  • Flashing images should not be used.
  • Do not use malicious code of any kind (e.g. with mouse clicks or key presses).
  • No commercial adverts or content of that nature.