This repository has been archived by the owner on Nov 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(vue): add docs for embed-content and embed-instagram component
- Loading branch information
1 parent
782d96d
commit 929ca2f
Showing
4 changed files
with
60 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,28 @@ | ||
# Component for rendering arbitrary html content | ||
# Component for rendering arbitrary (OEmbed) html content | ||
|
||
This component can be used to process and display arbitrary (OEmbed) content. | ||
|
||
## Props | ||
|
||
| Name | Type | Required | Description | | ||
| ------- | ------ | -------- | ----------- | | ||
| content | string | true | HTML embed content for given vendor that usually comes from Iframely (OEmbed format) | | ||
|
||
## Example | ||
|
||
```vue | ||
<template> | ||
<embed-content :content="content"></embed-content> | ||
</template> | ||
<script> | ||
import { EmbedContent } from '@spring-media/red-sourcepoint-cmp/dist/esm/vue/components'; | ||
export default { | ||
components: { EmbedContent }, | ||
data: () => ({ | ||
content: 'some oembed/iframely html content' | ||
}), | ||
}; | ||
</script> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,31 @@ | ||
# Component for Instagram Embeds | ||
|
||
This component can be used to process and display Instagram (OEmbed format) content. | ||
|
||
> Instagram needs to run some code after embedding content into the page. For other vendors consider using the provided generic embed component [EmbedContent](../EmbedContent/README.md). | ||
|
||
## Props | ||
|
||
| Name | Type | Required | Description | | ||
| ------- | ------ | -------- | ----------- | | ||
| content | string | true | HTML embed content for given vendor that usually comes from Iframely (OEmbed format) | | ||
|
||
## Example | ||
|
||
```vue | ||
<template> | ||
<embed-instagram :content="content"></embed-instagram> | ||
</template> | ||
<script> | ||
import { EmbedInstagram } from '@spring-media/red-sourcepoint-cmp/dist/esm/vue/components'; | ||
export default { | ||
components: { EmbedInstagram }, | ||
data: () => ({ | ||
content: 'some oembed/iframely html content' | ||
}), | ||
}; | ||
</script> | ||
``` |