Add docs about inline templates interpolation (#1874)

* Add docs about inline templates interpolation * Changelog
ViewComponent · Oct 18, 2023 · 6ed8d7f · 6ed8d7f
1 parent 2427ce7
commit 6ed8d7f
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -18,6 +18,10 @@ nav_order: 5
 
     *Alexandre Ignjatovic*
 
+* Improve docs about inline templates interpolation
+
+    *Hans Lemuet*
+
 ## 3.6.0
 
 * Refer to `helpers` in `NameError` message in development and test environments.

diff --git a/docs/guide/templates.md b/docs/guide/templates.md
@@ -27,6 +27,28 @@ class InlineErbComponent < ViewComponent::Base
 end
 ```
 
+### Interpolations
+
+When using Slim, interpolations have to be escaped, or they'll be evaluated in the context of the ViewComponent class.
+
+```ruby
+class InlineSlimComponent < ViewComponent::Base
+  slim_template <<~SLIM
+    p Hello, #{name}!
+    p Hello, \#{name}!
+  SLIM
+
+  def name
+    "World"
+  end
+end
+```
+
+will render:
+
+    <p>Hello InlineSlimComponent!</p>
+    <p>Hello World!</p>
+
 ## Sibling file
 
 Place template file next to the component: