Skip to content

Commit

Permalink
docs: remove deprecated frameborder, adjust allowFullScreen and u…
Browse files Browse the repository at this point in the history
…pdate the demo (vercel#72644)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change
-->


### What?

Removed the deprecated `iframe` attribute `frameborder`, adjusted
`allowfullscreen` to be `allowFullScreen` and updated the demo video.

### Why?

- `frameborder` is marked as deprecated
([MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#frameborder),
[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react/index.d.ts#L3231-L3232))
- `allowfullscreen` should be `allowFullScreen`
([DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/a5dd14a91255869c8a929284c2531bd0e96d28ff/types/react/index.d.ts#L3229))
- The YouTube `iframe` demo has an invalid embedded URL, fixed and
updated to the latest Next.js Conf as well.

---------

Co-authored-by: Delba de Oliveira <[email protected]>
  • Loading branch information
alfawal and delbaoliveira authored Nov 19, 2024
1 parent a8f1c70 commit 55834d9
Showing 1 changed file with 3 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,7 @@ The HTML `<iframe>` tag allows you to embed videos from external platforms like
```jsx filename="app/page.jsx"
export default function Page() {
return (
<iframe
src="https://www.youtube.com/watch?v=gfU1iZnjRZM"
frameborder="0"
allowfullscreen
/>
<iframe src="https://www.youtube.com/embed/19g66ezsKAg" allowFullScreen />
)
}
```
Expand All @@ -78,8 +74,7 @@ export default function Page() {
| `src` | The URL of the page to embed. | `<iframe src="https://example.com" />` |
| `width` | Sets the width of the iframe. | `<iframe width="500" />` |
| `height` | Sets the height of the iframe. | `<iframe height="300" />` |
| `frameborder` | Specifies whether or not to display a border around the iframe. | `<iframe frameborder="0" />` |
| `allowfullscreen` | Allows the iframe content to be displayed in full-screen mode. | `<iframe allowfullscreen />` |
| `allowFullScreen` | Allows the iframe content to be displayed in full-screen mode. | `<iframe allowFullScreen />` |
| `sandbox` | Enables an extra set of restrictions on the content within the iframe. | `<iframe sandbox />` |
| `loading` | Optimize loading behavior (e.g., lazy loading). | `<iframe loading="lazy" />` |
| `title` | Provides a title for the iframe to support accessibility. | `<iframe title="Description" />` |
Expand Down Expand Up @@ -107,7 +102,7 @@ The first step is to create a [Server Component](https://nextjs.org/docs/app/bui
export default async function VideoComponent() {
const src = await getVideoSrc()

return <iframe src={src} frameborder="0" allowfullscreen />
return <iframe src={src} allowFullScreen />
}
```

Expand Down

0 comments on commit 55834d9

Please sign in to comment.