Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support iframes in container media content #1487

Merged
merged 6 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pages/container/common.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import * as React from 'react';
import { useState } from 'react';
import { ContainerProps } from '~components/container';
import Container from '~components/container';
import Header from '~components/header';
import Link from '~components/link';
import SpaceBetween from '~components/space-between';
import Button from '~components/button';

let nextIframeIndex = 0;
export const PermutationIframe = () => {
const [iframeIndex] = useState(() => nextIframeIndex++);
return <iframe title={`iframe ${iframeIndex}`} srcDoc="<h1>This is an iframe</h1>"></iframe>;
};

export const PermutationContainer = ({ permutation }: { permutation: ContainerProps.Media }) => {
return (
<Container
Expand Down
3 changes: 2 additions & 1 deletion pages/container/media-side-permutations.page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import image169 from './images/16-9.png';
import image43 from './images/4-3.png';
import image916 from './images/9-16.png';
import imageVideo from './images/video.png';
import { PermutationContainer } from './common';
import { PermutationContainer, PermutationIframe } from './common';

const permutations = createPermutations<ContainerProps.Media>([
{
Expand All @@ -20,6 +20,7 @@ const permutations = createPermutations<ContainerProps.Media>([
<img key={'image43'} src={image43} alt="placeholder" />,
<img key={'image916'} src={image916} alt="placeholder" />,
<img key={'imageVideo'} src={imageVideo} alt="placeholder" />,
<PermutationIframe key="iframe" />,
],
width: ['', '33%', '50%'],
},
Expand Down
3 changes: 2 additions & 1 deletion pages/container/media-top-permutations.page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import image169 from './images/16-9.png';
import image43 from './images/4-3.png';
import image916 from './images/9-16.png';
import imageVideo from './images/video.png';
import { PermutationContainer } from './common';
import { PermutationContainer, PermutationIframe } from './common';

const permutations = createPermutations<ContainerProps.Media>([
{
Expand All @@ -20,6 +20,7 @@ const permutations = createPermutations<ContainerProps.Media>([
<img key={'image43'} src={image43} alt="placeholder" />,
<img key={'image916'} src={image916} alt="placeholder" />,
<img key={'imageVideo'} src={imageVideo} alt="placeholder" />,
<PermutationIframe key="iframe" />,
],
height: ['', 100, 200, 300],
},
Expand Down
3 changes: 3 additions & 0 deletions src/__a11y__/axe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ export const spec: Axe.Spec = {
rules: [
// Skip the empty table header rule which fails for the single selection table header
{ id: 'empty-table-header', enabled: false },
// Skip the rule which enforces that axe is included in all iframes, which fails on
// very basic iframes on media container tests
{ id: 'frame-tested', enabled: false },
],
};

Expand Down
2 changes: 1 addition & 1 deletion src/__tests__/__snapshots__/documenter.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -5007,7 +5007,7 @@ all containers to the height of the longest one, to avoid extra vertical scroll
Object {
"description": "Use this slot to render a media element. Supported element types are 'img', 'video', and 'picture'.
You can define different positions and sizes for the media element within the container.
* \`content\` - Use this slot to render your media element. We support \`img\`, \`video\` and \`picture\` elements.
* \`content\` - Use this slot to render your media element. We support \`img\`, \`video\`, \`picture\`, and \`iframe\` elements.

* \`position\` - Defines the media slot's position within the container. Defaults to \`top\`.

Expand Down
6 changes: 2 additions & 4 deletions src/container/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export interface ContainerProps extends BaseComponentProps {
* Use this slot to render a media element. Supported element types are 'img', 'video', and 'picture'.
* You can define different positions and sizes for the media element within the container.
*
* * `content` - Use this slot to render your media element. We support `img`, `video` and `picture` elements.
* * `content` - Use this slot to render your media element. We support `img`, `video`, `picture`, and `iframe` elements.
*
* * `position` - Defines the media slot's position within the container. Defaults to `top`.
*
Expand Down Expand Up @@ -72,9 +72,7 @@ export interface ContainerProps extends BaseComponentProps {
export namespace ContainerProps {
export interface Media {
/**
*
* Use this slot to render your media element. We support `img`, `video` and `picture` elements.
*
* Use this slot to render your media element. We support `img`, `video`, `picture`, and `iframe` elements.
*/
content: React.ReactNode;

Expand Down
7 changes: 7 additions & 0 deletions src/container/styles.scss
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,13 @@
object-position: center;
}

// stylelint-disable-next-line @cloudscape-design/no-implicit-descendant, selector-max-type
iframe {
width: 100%;
height: 100%;
border: 0;
}

&-top {
max-height: 66%;
border-top-left-radius: awsui.$border-radius-container;
Expand Down
Loading