Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

add repeater security notes #1981

Merged
merged 3 commits into from
May 31, 2017
Merged

add repeater security notes #1981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
087ab82
update ruby dependencies via Gemfile.lock
swilliamset May 23, 2017
06b3873
cleanup repeater documentation (spelling, dataSource options, code
swilliamset May 23, 2017
64ac6f7
add repeater dataSource security note
swilliamset May 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,9 @@ DEPENDENCIES
bundler
jekyll
rack-jekyll

RUBY VERSION
ruby 2.1.1p76

BUNDLED WITH
1.15.0
20 changes: 18 additions & 2 deletions _includes/js/repeater.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ <h3 id="repeater-dataSource">Data Source</h3>
</div><!-- ./fu-table-responsive -->


<p>The <code>dataSource's callback</code> function should run after gathering the desired data for rendering. This function requires the code to pass a
<p>The <code>dataSource</code>'s <code>callback</code> function should run after gathering the desired data for rendering. This function requires the code to pass a
<code>data</code> object as an argument. Contents of the object will vary depending on the view
extension used. The attributes below include common expected attributes:</p>
<div class="table-responsive">
Expand All @@ -534,6 +534,11 @@ <h3 id="repeater-dataSource">Data Source</h3>
<code>.repeater-end</code> element.
</td>
</tr>
<tr>
<td>items</td>
<td>array</td>
<td>Array of objects representing the item data that will be displayed within the repeater. Use this value to populate the records in the <code>.repeater-list</code> element. The item objects can contain any number of attributes. Necessary attributes are defined by the <a href="/extensions.html">repeater extension</a>.</td>
</tr>
<tr>
<td>page</td>
<td>number</td>
Expand All @@ -560,6 +565,17 @@ <h3 id="repeater-dataSource">Data Source</h3>
</div><!-- ./fu-table-responsive -->
<p>The default values are <code>{ count: 0, end: 0, items: [], page: 0, pages: 1, start: 0 }</code>.</p>

<div class="fu-callout fu-callout-warning">
<h4 id="repeater-dataSource-security">Security</h4>
<p>
Use the <code>dataSource</code> method to keep your page safe from XSS.
<ul>
<li>Do not include markup in the <code>data</code> object argument passed to <code>dataSource</code>'s <code>callback</code> function.</li>
<li>Use the <code>cleanInput</code> utility while gathering your data use the data is safely encoded.</li>
</ul>
</p>
</div>

<h3 id="repeater-usage-events">Events</h3>
<div class="table-responsive">
<table class="table table-bordered table-striped">
Expand Down Expand Up @@ -604,7 +620,7 @@ <h3 id="repeater-usage-events">Events</h3>
</tr>
<tr>
<td>rendered.fu.repeater</td>
<td>Fires whenever the repeater has rendered data returned from the dataSource. Passses an <code>object</code> containing
<td>Fires whenever the repeater has rendered data returned from the dataSource. Passes an <code>object</code> containing
<code>data</code>, <code>options</code>, and <code>renderOptions</code>.</td>
</tr>
<tr>
Expand Down