Skip to content

Commit c9e0749

Browse files
committed
commit
1 parent 30f2243 commit c9e0749

3 files changed

Lines changed: 120 additions & 4 deletions

File tree

.babelrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

app/doc.html

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,119 @@ <h5 id="videojsOptions">videojsOptions</h5>
208208
<h5 id="locationEmbed">locationEmbed</h5>
209209
<span><b>Type</b> : Boolean</span><br>
210210
<span><b>Default</b> : <code>true</code></span>
211-
<p></p>
211+
<p>Set whether you want to embed google maps. The format to follow for embedding google map with a location is <code>@(locationName)</code>. <code>@()</code> will be automatically removed by the plugin.</p>
212+
213+
214+
<h5 id="mapOptions">mapOptions</h5>
215+
<span><b>Type</b> : object</span><br>
216+
<div class="obj">
217+
<h5>mode</h5>
218+
<b>Type</b> : string <br>
219+
<b>default</b> : <code>'place'</code>
220+
<p>Can be any of <code>'place'</code>, <code>'view'</code> or <code>'streetview'</code></p>.
221+
</div>
222+
223+
<h5 id="googleAuthKey">googleAuthKey</h5>
224+
<span><b>Type</b> : string</span><br>
225+
<span><b>Default</b> : <code>''</code></span>
226+
<p>The google dev auth key needed if the user is using youtube embedding or google map embedding feature of the plugin.</p>
227+
228+
229+
<h5 id="tweetsEmbed">tweetsEmbed</h5>
230+
<b>Type</b> : Boolean <br>
231+
<b>Default</b> : <code>true</code>
232+
<p>Set to <code>true</code> if you want to embed tweets. Make sure you load <a href="http://platform.twitter.com/widgets.js" target="_blank">http://platform.twitter.com/widgets.js</a> if this option is set to <code>true</code> else the plugin will throw an error.</p>
233+
234+
<h5 id="tweetOptions">tweetOptions</h5>
235+
<b>Type</b> : object <br>
236+
<b>Default</b> :
237+
<pre><code>{
238+
maxWidth : 550,
239+
hideMedia : false,
240+
hideThread : false,
241+
align : 'none',
242+
lang : 'en'
243+
}</code></pre>
244+
<p>Options for embedding tweets. Supports the options listed <a href="https://dev.twitter.com/rest/reference/get/statuses/oembed">here</a></p>
245+
246+
<h5 id="imageEmbed">imageEmbed</h5>
247+
<span><b>Type</b> : Boolean</span><br>
248+
<span><b>Default</b> : <code>true</code></span>
249+
<p>Set to <code>false</code> if you want to disable embedding images (jpeg/gif/png/webp).</p>
250+
251+
<h5 id="videoEmbed">videoEmbed</h5>
252+
<span><b>Type</b> : Boolean</span><br>
253+
<span><b>Default</b> : <code>true</code></span>
254+
<p>Set to <code>false</code> if you want to disable embedding supported video formats.</p>
255+
256+
<h5 id="videoHeight">videoHeight</h5>
257+
<span><b>Type</b> : number</span><br>
258+
<span><b>Default</b> : <code>null</code></span>
259+
<p>Set the height of the videos that are to be embedded and most of the other iframe embeds will also take the same dimensions.</p>
260+
261+
<h5 id="videoWidth">videoWidth</h5>
262+
<span><b>Type</b> : number</span><br>
263+
<span><b>Default</b> : <code>null</code></span>
264+
<p>Set the width of the videos that are to be embedded and most of the other iframe embeds will also take the same dimensions.</p>
265+
266+
<h5 id="videoDetails">videoDetails</h5>
267+
<span><b>Type</b> : Boolean</span><br>
268+
<span><b>Default</b> : <code>true</code></span>
269+
<p>If set to <code>false</code> the preview and the description of youtube and vimeo videos will not be shown and instead the whole video will be embedded directly.</p>
270+
271+
<h5 id="audioEmbed">audioEmbed</h5>
272+
<span><b>Type</b> : Boolean</span><br>
273+
<span><b>Default</b> : <code>true</code></span>
274+
<p>Set to <code>false</code> if you want to disable embedding supported audio formats.</p>
275+
276+
<h5 id="excludeEmbed">excludeEmbed</h5>
277+
<span><b>Type</b> : array/string</span><br>
278+
<span><b>Default</b> : <code>[]</code></span>
279+
<p>An array of all the services that you want to exclude from being embed. Eg : <code>['codepen','flickr','spotify']</code>. If you want to exclude all the services then just set it to <code>'all'</code></p>
280+
281+
<h5 id="inlineEmbed">inlineEmbed</h5>
282+
<span><b>Type</b> : array/string</span><br>
283+
<span><b>Default</b> : <code>[]</code></span>
284+
<p>An array of all the services you want to embed inline. If you want to embed all services inline then set it to <code>'all'</code></p>
285+
286+
<h5 id="codeEmbedHeight">codeEmbedHeight</h5>
287+
<span><b>Type</b> : number</span><br>
288+
<span><b>Default</b> : <code>500</code></span>
289+
<p>Set the height of all the code editing services. Eg : codepen , plunker, ideone, jsbin, jsfiddle.</p>
290+
291+
292+
<h5 id="vineOptions">vineOptions</h5>
293+
<span><b>Type</b> : object</span><br>
294+
<span><b>Default</b> :
295+
<pre><code>{
296+
maxWidth : null,
297+
type : 'postcard', // "postcard" or "simple" embedding
298+
responsive : true,
299+
width : 350,
300+
height : 460
301+
}</code></pre>
302+
<p>The options for vine embedding.</p>
303+
304+
<h5 id="soundCloudOptions">soundCloudOptions</h5>
305+
<span><b>Type</b> : object</span><br>
306+
<span><b>Default</b> :
307+
<pre><code>{
308+
height : 160,
309+
themeColor : 'f50000', //Hex Code of the player theme color
310+
autoPlay : false,
311+
hideRelated : false,
312+
showComments : true,
313+
showUser : true,
314+
showReposts : false,
315+
visual : false, //Show/hide the big preview image
316+
download : false //Show/Hide download buttons
317+
}</code></pre>
318+
<p>Options for soundcloud embedding.</p>
319+
320+
212321

213322
</div>
323+
214324
</body>
215325
<script src="/bower_components/jquery/dist/jquery.js"></script>
216326
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.9.1/highlight.min.js"></script>

app/styles/doc.scss

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,12 @@ pre,code{
4949
padding-left: 30px;
5050
margin: 30px;
5151
}
52+
53+
p{
54+
border-bottom: 1px solid #eee;
55+
padding-bottom: 25px;
56+
}
57+
58+
h5{
59+
font-weight: bold;
60+
}

0 commit comments

Comments
 (0)