xatframe

From xat wiki

To further customize the outer background of your group or xatspace, you can provide a link to an HTML document that will be embedded via iframe (known as a "xatframe") behind your chat or xatspace respectively. 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 was previously used on Flash chats and xatspaces.

Me power is required to use a xatframe on your xatspace.

Library

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

Submitting a xatframe

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

Adding a xatframe to your group

1. Go to the xatframe library. (Figure 1)

2. Click “copy” on any xatframe. (Figure 2)

3. Then, hover over "group" at the top right of your group, click "customize" and enter your group password. Alternatively, visit the edit group page.

4. Add the URL to the "xatframe" field on the appearance tab. (Figure 3)

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.

Adding a xatframe to your xatspace

1. Go to the xatframe library. (Figure 1)

Figure 4: xatframe field on the xatspace edit page

2. Click “copy” on any xatframe. (Figure 2)

3. Then, hover over "account" at the top right of a group, click "edit" and enter your password. Alternatively, visit the edit xatspace page.

4. Add the URL to the "xatframe" field. (Figure 4)

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

Making your own xatframe

If you want to create your own xatframe, you will first need to have somewhere to host it. For this, we recommend you use https://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.

Once you have a webpage set up, you can combine HTML/CSS/JavaScript code to create your design and then use it on your chat or xatspace, or submit it to the xatframe library.

Clickable content

With chat groups, while JavaScript events are disabled for the majority of the window, you are able to capture events starting from below the chat banner. You can put things like navigation, buttons, etc. here to allow further customisation of your xatframe.

Note: If you have chat tabs enabled, you must minimise the navigation by clicking "close" to access the clickable area. If there are no chat tabs, events will be enabled by default as there will be no navigation below the chat.

Settings

Figure 5: xatframe setting options

You can disable or enable xatframes used on a chat group through an automatic pop-up window or by hovering over "group" at the top right of a group and clicking "xatframe". You can do this for all groups (global), the current group or both. (Figure 5)

Changes will not take effect until you refresh the page.

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 xatspace being deleted or 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 an 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.