From 67946303c935f050cf6f89dcf52d02d624a2748c Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Sun, 7 May 2017 14:48:03 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index d3572bd..0b12a8e 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,28 @@ console.log(output); ## Options +Option | Type | Default | Description +:--------------------|:---------------------|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------ +`containerClassName` | `string` \| `null` | `'block-embed'` | Class name for image container element. +`serviceClassPrefix` | `string` | `'block-embed-service-'` | Prefix for service name in CSS class. +`outputPlayerSize` | `boolean` | `true` | Indicates if 'width' and 'height' attributes are written to output. +`allowFullScreen` | `boolean` | `true` | Indicates whether embed iframe should be allowed to enter full screen mode. +`filterUrl` | `function` \| `null` | `null` | A function that customizes url output. Signature: `function (url: string, serviceName: string, videoID: string, options: object): string` +`services.{name}` | `function` | - | A function that constructs a new instance of the service. Can extend `VideoServiceBase`. +`services.youtube` | `function` | `YouTubeService` | Implementation of the 'youtube' embed service. Can be overridden by a custom implementation. +`services.vimeo` | `function` | `VimeoService` | Implementation of the 'vimeo' embed service. Can be overridden by a custom implementation. +`services.vine` | `function` | `VineService` | Implementation of the 'vine' embed service. Can be overridden by a custom implementation. +`services.prezi` | `function` | `PreziService` | Implementation of the 'prezi' embed service. Can be overridden by a custom implementation. +`{service-name}` | `object` | - | Options can be supplied to embed services. +`youtube.width` | `number` | `640` | Width of YouTube embed. +`youtube.height` | `number` | `390` | Height of YouTube embed. +`vimeo.width` | `number` | `500` | Width of Vimeo embed. +`vimeo.height` | `number` | `281` | Height of Vimeo embed. +`vine.width` | `number` | `600` | Width of Vine embed. +`vine.height` | `number` | `600` | Height of Vine embed. +`vine.embed` | `string` | `'simple'` | Type of embed; for instance, `'simple'` or `'postcard'` (see https://dev.twitter.com/web/vine). +`prezi.width` | `number` | `550` | Width of Prezi embed. +`prezi.height` | `number` | `400` | Height of Prezi embed. Option | Type | Default | Description :--------------------|:---------------------|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------ `containerClassName` | `string` \| `null` | `'block-embed'` | Class name for image container element. From 27cedce556b693de6ca87739055d5f4aa10138ee Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Sun, 7 May 2017 14:49:24 +0200 Subject: [PATCH 2/2] Fix table in readme --- README.md | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/README.md b/README.md index 0b12a8e..3383ba2 100644 --- a/README.md +++ b/README.md @@ -81,34 +81,6 @@ Option | Type | Default | Descrip `vine.embed` | `string` | `'simple'` | Type of embed; for instance, `'simple'` or `'postcard'` (see https://dev.twitter.com/web/vine). `prezi.width` | `number` | `550` | Width of Prezi embed. `prezi.height` | `number` | `400` | Height of Prezi embed. -Option | Type | Default | Description -:--------------------|:---------------------|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------ -`containerClassName` | `string` \| `null` | `'block-embed'` | Class name for image container element. -`serviceClassPrefix` | `string` | `'block-embed-service-'` | Prefix for service name in CSS class. -`outputPlayerSize` | `boolean` | `true` | Indicates if 'width' and 'height' attributes are written to output. -`allowFullScreen` | `boolean` | `true` | Indicates whether embed iframe should be allowed to enter full screen mode. -`filterUrl` | `function` \| `null` | `null` | A function that customizes url output. Signature: `function (url: string, serviceName: string, videoID: string, options: object): string` - | | | -`services.{name}` | `function` | - | A function that constructs a new instance of the service. Can extend `VideoServiceBase`. -`services.youtube` | `function` | `YouTubeService` | Implementation of the 'youtube' embed service. Can be overridden by a custom implementation. -`services.vimeo` | `function` | `VimeoService` | Implementation of the 'vimeo' embed service. Can be overridden by a custom implementation. -`services.vine` | `function` | `VineService` | Implementation of the 'vine' embed service. Can be overridden by a custom implementation. -`services.prezi` | `function` | `PreziService` | Implementation of the 'prezi' embed service. Can be overridden by a custom implementation. - | | | -`{service-name}` | `object` | - | Options can be supplied to embed services. - | | | -`youtube.width` | `number` | `640` | Width of YouTube embed. -`youtube.height` | `number` | `390` | Height of YouTube embed. - | | | -`vimeo.width` | `number` | `500` | Width of Vimeo embed. -`vimeo.height` | `number` | `281` | Height of Vimeo embed. - | | | -`vine.width` | `number` | `600` | Width of Vine embed. -`vine.height` | `number` | `600` | Height of Vine embed. -`vine.embed` | `string` | `'simple'` | Type of embed; for instance, `'simple'` or `'postcard'` (see https://dev.twitter.com/web/vine). - | | | -`prezi.width` | `number` | `550` | Width of Prezi embed. -`prezi.height` | `number` | `400` | Height of Prezi embed. ## Supported Services