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

Commit fae5ee5

Browse files
doc(#36): doc for QR code slide
1 parent 25e17f6 commit fae5ee5

File tree

2 files changed

+74
-1
lines changed

2 files changed

+74
-1
lines changed
117 KB
Loading

doc/slides/slides.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Some templates offer extra features as for example the slide [Code](#slide-code)
1515
- [Slide: Youtube](#slide-youtube)
1616
- [Slide: Code](#slide-code)
1717
- [Slide: Author](#slide-author)
18+
- [Slide: QR Code](#slide-qr-code)
1819
- [Background](#background)
1920

2021
## Slides
@@ -55,6 +56,10 @@ Some templates offer extra features as for example the slide [Code](#slide-code)
5556

5657
<img src="https://github.com/fluster/deckdeckgo/blob/master/doc/slides/deckdeckgo-slide-author-layout.png" width="200px">
5758

59+
* [QR Code](#slide-qr-code)
60+
61+
<img src="https://github.com/fluster/deckdeckgo/blob/master/doc/slides/deckdeckgo-slide-qrcode-layout.png" width="200px">
62+
5863
*Note: If you would miss or need further templates, don't hesitate to open an issue and/or submit a PR, it would be my pleasure to add more options*
5964

6065
### Slide: Title
@@ -497,7 +502,7 @@ The [DeckDeckGo] - Hightlight code component is provided in separate extra libra
497502

498503
#### Attributes
499504

500-
At least `src` or the `slot` code should be provided in order to render code in this template. It offers the same attributes as the [DeckDeckGo] charts Web Component, see its [documentation](https://github.com/fluster/deckdeckgo-code) for the details.
505+
At least `src` or the `slot` code should be provided in order to render code in this template. It offers the same attributes as the [DeckDeckGo] code Web Component, see its [documentation](https://github.com/fluster/deckdeckgo-highlight-code) for the details.
501506

502507
##### Example with file URI
503508

@@ -672,4 +677,72 @@ div.circle {
672677
}
673678
```
674679

680+
### Slide: QR Code
681+
682+
The "QR code" slide is an handy slide in case you would like to display a QR code. It could for example be use as the very last slide of your presentation to display an easy link pointing to your deck, you previously published online. It would allow your audience to get easily your slides without any delay on their phone.
683+
684+
#### Layout
685+
686+
<img src="https://github.com/fluster/deckdeckgo/blob/master/doc/slides/deckdeckgo-slide-qrcode-layout.png" width="450px">
687+
688+
#### Usage
689+
690+
The "QR code" slide's Web Component could be integrated using the tag `<deckgo-slide-qrcode/>`.
691+
692+
##### Usage
693+
694+
```
695+
<deckgo-deck>
696+
<deckgo-slide-qrcode content="https://deckdeckgo.com">
697+
<h1 slot="title">My QR code</h1>
698+
<p slot="content">An optional additional content</p>
699+
</deckgo-slide-code>
700+
</deckgo-deck>
701+
```
702+
703+
##### Slots
704+
705+
The slots `title` and `content` are optional.
706+
707+
#### Code components
708+
709+
The slide "QR Code" relies on the code component `<deckgo-qrcode/>` which is described in the components [documentation](https://github.com/fluster/deckdeckgo/blob/master/doc/components/components.md).
710+
711+
#### Installation
712+
713+
The [DeckDeckGo] - QR Code component is provided in separate extra library. If you don't use the [DeckDeckGo] starter kit and wish to add the [DeckDeckGo] QR code to your project, you will need to install and integrate it from a CDN or [npm](https://www.npmjs.com/package/deckdeckgo-qrcode) as described in its [installation guide](https://github.com/fluster/deckdeckgo-qrcode#getting-started).
714+
715+
#### Attributes
716+
717+
The attribute `content` should be provided in order to render a QR code in this template. It offers the same attributes as the [DeckDeckGo] QR code Web Component, see its [documentation](https://github.com/fluster/deckdeckgo-qrcode) for the details.
718+
719+
##### Example without any slots
720+
721+
```
722+
<deckgo-deck>
723+
<deckgo-slide-qrcode content="An encoded text">
724+
</deckgo-slide-code>
725+
</deckgo-deck>
726+
```
727+
728+
#### Theming
729+
730+
The following theming options will affect this component if set on its host or parent.
731+
732+
| CSS4 variable | Default | Note |
733+
| -------------------------- |:-----------------:|:-----------------:|
734+
| --background | | |
735+
| --color | | |
736+
| --slide-padding-top | 16px | Padding top of the all slide |
737+
| --slide-padding-end | 32px | Padding right of the all slide |
738+
| --slide-padding-bottom | 16px | Padding bottom of the all slide |
739+
| --slide-padding-start | 32px | Padding left of the all slide |
740+
| --slide-qrcode-align | center | QR code vertical alignment |
741+
| --slide-qrcode-text-align | center | QR code horizontal alignment |
742+
| --slide-qrcode-background | | QR code column's background |
743+
| --slide-qrcode-title-display | inherit | If you wish to hide the slot="title" |
744+
745+
Furthermore, this slide component offers the exact same CSS4 variables as the [DeckDeckGo] - QR code Web Component, see its [documentation](https://github.com/fluster/deckdeckgo-qrcode) for the details.
746+
747+
675748
[DeckDeckGo]: https://deckdeckgo.com

0 commit comments

Comments
 (0)