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.

Sign up for GitHub

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

docs: add videoIframe and youtube props description for Media block #227

Merged
merged 1 commit into from
Feb 3, 2025
+15 −13
Merged

docs: add videoIframe and youtube props description for Media block #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 15 additions & 13 deletions src/blocks/Media/README.md
View file
Open in desktop
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)