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

Commit ca8785b

Browse files
docs: note regarding slot render usage
1 parent bf29ddd commit ca8785b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,21 @@ This file describes the `properties` and `slots` of your template. Using these,
136136

137137
##### Slots
138138

139-
Each `slot` which can be edited by the users should be documented. It contains the `name` (if apply) and a `description`.
139+
`slot` can be used to make part of your slides editable by the users. These are placeholder inside your template and have to be rendered to the DOM.
140+
141+
For example, the following would render an editable element identified by the name `title`.
142+
143+
```
144+
render() {
145+
return (
146+
<Host class={{'deckgo-slide-container': true}}>
147+
<slot name="title"></slot>
148+
</Host>
149+
);
150+
}
151+
```
152+
153+
In addition, each of these `slot` have to be documented too. The documentation should contain the `name` (if apply) and a `description`.
140154

141155
```
142156
/**

0 commit comments

Comments
 (0)