From ca8785bc768151cc266898ec137fbdcda97c8118 Mon Sep 17 00:00:00 2001 From: peterpeterparker Date: Sat, 19 Jun 2021 08:31:12 +0200 Subject: [PATCH] docs: note regarding slot render usage --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d72be7..0e6cfc0 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,21 @@ This file describes the `properties` and `slots` of your template. Using these, ##### Slots -Each `slot` which can be edited by the users should be documented. It contains the `name` (if apply) and a `description`. +`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. + +For example, the following would render an editable element identified by the name `title`. + +``` +render() { + return ( + + + + ); +} +``` + +In addition, each of these `slot` have to be documented too. The documentation should contain the `name` (if apply) and a `description`. ``` /**