Skip to content

Commit

Permalink
docs: add videoIframe and youtube props description for Media block
Browse files Browse the repository at this point in the history
  • Loading branch information
benax-se committed Jan 29, 2025
1 parent ddd0316 commit 82b1bdd
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions src/blocks/Media/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
| Property | Type | Required | Description |
| :------------ | :----------------------- | :------- | :--------------------- |
| className | `string` | `false` | Component className |
| paddingTop | `xs - s - m - l - xl` | `false` | Top padding size |
| paddingBottom | `xs - s - m - l - xl` | `false` | Bottom padding size |
| paddingRight | `xs - s - m - l - xl` | `false` | Right padding size |
| paddingLeft | `xs - s - m - l - xl` | `false` | Left padding size |
| text | `string` | `false` | Text |
| previewImg | `string` | `false` | Image for preview |
| youtube | `MediaProps['youtube']` | `false` | Youtube media content |
| image | `MediaProps['image']` | `false` | Image media content |
| video | `MediaProps['video']` | `false` | Video media content |
| dataLens | `MediaProps['dataLens']` | `false` | dataLens media content |
| Property | Type | Required | Description |
| :------------ | :-------------------------- | :------- | :----------------------------------------- |
| className | `string` | `false` | Component className |
| paddingTop | `xs - s - m - l - xl` | `false` | Top padding size |
| paddingBottom | `xs - s - m - l - xl` | `false` | Bottom padding size |
| paddingRight | `xs - s - m - l - xl` | `false` | Right padding size |
| paddingLeft | `xs - s - m - l - xl` | `false` | Left padding size |
| text | `string` | `false` | Text |
| previewImg | `string` | `false` | Image for preview |
| youtube | `MediaProps['youtube']` | `false` | Youtube media content |
| videoIframe | `MediaProps['videoIframe']` | `false` | Video iframe src |
| autoplay | `MediaProps['autoplay']` | `false` | Enable autoplay for youtube or videoIframe |
| image | `MediaProps['image']` | `false` | Image media content |
| video | `MediaProps['video']` | `false` | Video media content |
| dataLens | `MediaProps['dataLens']` | `false` | dataLens media content |

To get more information about `MediaProps` see this [page](https://preview.gravity-ui.com/page-constructor/?path=/docs/blocks-media--default)

0 comments on commit 82b1bdd

Please sign in to comment.