Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit acf90a1

Browse files
doc(#36): add note regarding QR code
1 parent be421d9 commit acf90a1

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

doc/components/components.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@
44

55
## Table of contents
66

7-
- [Gif](#gif)
87
- [Chart](#chart)
8+
- [Gif](#gif)
99
- [Highlight Code](#highlight-code)
10-
- [Youtube](#youtube)
10+
- [QR Code](#qr-code)
1111
- [Social](#social)
12+
- [Youtube](#youtube)
13+
14+
## Chart
15+
16+
The "Chart" component is an extra component which let you draw charts easily. This Web Component could be use in [DeckDeckGo] or in any other web projects. See its [documentation](https://github.com/fluster/deckdeckgo-charts) for the details.
1217

1318
## Gif
1419

@@ -56,41 +61,13 @@ The following theming options will affect this component if set on its host or p
5661

5762
Of course, as other images added to a presentation build with [DeckDeckGo], gifs are lazy loaded too.
5863

59-
## Chart
60-
61-
The "Chart" component is an extra component which let you draw charts easily. This Web Component could be use in [DeckDeckGo] or in any other web projects. See its [documentation](https://github.com/fluster/deckdeckgo-charts) for the details.
62-
6364
## Highlight Code
6465

6566
The "Highlight Code" component is an extra component which let you highlight code easily. This Web Component could be use in [DeckDeckGo] or in any other web projects. See its [documentation](https://github.com/fluster/deckdeckgo-highlight-code) for the details.
6667

67-
## Youtube
68-
69-
The "Youtube" component allows you to easily add a [Youtube](https://youtube.com) video in almost any slide of your presentation.
70-
71-
### Usage
68+
## QR Code
7269

73-
The "Youtube" slide's Web Component could be integrated using the tag `<deckgo-youtube/>`.
74-
75-
```
76-
<deckgo-youtube src="https://www.youtube.com/watch?v=oUOjJIfPIjw">
77-
</deckgo-youtube>
78-
```
79-
80-
#### Slots
81-
82-
No slots are available for this component.
83-
84-
### Attributes
85-
86-
This component offers the following options which could be set using attributes:
87-
88-
| Attribute | Type | Default | Description |
89-
| -------------------------- |:-----------------:|:-----------------:|:-----------------:|
90-
| src | string | | The source url, the Youtube url, of the video. Not embeddable url will be automatically converted to embeddable url supported by Youtube. |
91-
| width | number | | The width of the video player. |
92-
| height | number | | The height of the video player. |
93-
| frame-title | string | | A title for the frame, could be use for accessibility reason. |
70+
The "QR Code" component is an extra component which let you add QR code in your slides, useful for example to display links and url and if you wish your audience to easily access them. This Web Component could be use in [DeckDeckGo] or in any other web projects. See its [documentation](https://github.com/fluster/deckdeckgo-qr-code) for the details.
9471

9572
## Social
9673

@@ -141,4 +118,32 @@ With for example `ion-icon`:
141118
<deckgo-social github="fluster/deckdeckgo"><ion-icon slot="icon" name="logo-github"></ion-icon> DeckDeckGo on Github</deckgo-social>
142119
```
143120

121+
## Youtube
122+
123+
The "Youtube" component allows you to easily add a [Youtube](https://youtube.com) video in almost any slide of your presentation.
124+
125+
### Usage
126+
127+
The "Youtube" slide's Web Component could be integrated using the tag `<deckgo-youtube/>`.
128+
129+
```
130+
<deckgo-youtube src="https://www.youtube.com/watch?v=oUOjJIfPIjw">
131+
</deckgo-youtube>
132+
```
133+
134+
#### Slots
135+
136+
No slots are available for this component.
137+
138+
### Attributes
139+
140+
This component offers the following options which could be set using attributes:
141+
142+
| Attribute | Type | Default | Description |
143+
| -------------------------- |:-----------------:|:-----------------:|:-----------------:|
144+
| src | string | | The source url, the Youtube url, of the video. Not embeddable url will be automatically converted to embeddable url supported by Youtube. |
145+
| width | number | | The width of the video player. |
146+
| height | number | | The height of the video player. |
147+
| frame-title | string | | A title for the frame, could be use for accessibility reason. |
148+
144149
[DeckDeckGo]: https://deckdeckgo.com

0 commit comments

Comments
 (0)