2015-12-11 04:29:47 +01:00
|
|
|
title: IFrame page
|
2019-02-01 10:37:59 +01:00
|
|
|
summary: Embed IFrames in your website without adding custom code
|
2015-12-11 04:29:47 +01:00
|
|
|
|
|
|
|
|
# IFrame
|
|
|
|
|
|
|
|
|
|
## In this section:
|
|
|
|
|
|
|
|
|
|
* Create and modify an IFrame
|
|
|
|
|
|
|
|
|
|
## Before we begin
|
2019-02-01 10:37:59 +01:00
|
|
|
Make sure that your SilverStripe installation has the [IFrame](https://addons.silverstripe.org/add-ons/silverstripe/iframe) module installed.
|
2013-02-27 05:09:14 +01:00
|
|
|
|
|
|
|
|
This module provides a page type that you can use to embed IFrames in your website.
|
|
|
|
|
|
|
|
|
|
## Creating an IFrame
|
|
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
IFrame pages are created like any other page. When you create a new page, select the **IFrame Page** from the list of
|
|
|
|
|
available page types.
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
There are a few extra fields on an IFrame page which can help you to customise the IFrame that gets created on the
|
|
|
|
|
frontend of your website.
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
The most important is *IFrame URL*: this is the URL that wish you display inside the IFrame. This can be an absolute
|
|
|
|
|
path (e.g. `http://example.com/`) or a relative path (e.g. `/about-us/`). If it is a relative path then it will be assumed to
|
|
|
|
|
be from the root of your site (e.g `http://mysite.com/about-us/`).
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
"Auto height" will change the height of the IFrame to match the total height of the remote page.
|
2017-11-22 22:47:30 +01:00
|
|
|
_This will only work if the remote page is hosted on the same domain._
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
If you check "Auto width" the IFrame will take up the entire width of the content area that it is in.
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
You can manually set the height and width with the "Fixed height" and "Fixed width" fields.
|
|
|
|
|
The "Auto width/height" options must not be enabled for these fields to work.
|
2013-02-27 05:09:14 +01:00
|
|
|
|
2019-02-01 10:37:59 +01:00
|
|
|
The "Content" field has been broken up into three separate fields: one to display above the IFrame, one to display
|
2013-02-27 05:09:14 +01:00
|
|
|
beneath the IFrame, and another to display instead of the IFrame if the user has disabled them.
|
|
|
|
|
|
|
|
|
|
## Known Issues
|
|
|
|
|
|
|
|
|
|
A common test case is to enter "http://google.com" as the IFrame URL. This won't work! Google's website has the
|
|
|
|
|
*X-Frame-Options: SAMEORIGIN* header which means that it can only be displayed in an IFrame with a bit of technical
|
|
|
|
|
hackery. If you experience a white box displaying with any other website, check if it has that option set in the
|
2017-11-22 22:47:30 +01:00
|
|
|
header.
|
