Skip to content

Commit

Permalink
Add main JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
mirka committed Dec 12, 2022
1 parent 2eac8cf commit 957bdbd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions packages/components/src/sandbox/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,17 @@ const style = `
}
`;

/**
* This component provides an isolated environment for arbitrary HTML via iframes.
*
* ```jsx
* import { SandBox } from '@wordpress/components';
*
* const MySandBox = () => (
* <SandBox html="<p>Content</p>" title="SandBox" type="embed" />
* );
* ```
*/
function SandBox( {
html = '',
title = '',
Expand Down

0 comments on commit 957bdbd

Please sign in to comment.