Skip to content
Open
Changes from all commits
Commits
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
16 changes: 14 additions & 2 deletions lib/liquid/tags/break.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,31 @@
module Liquid
# Break tag to be used to break out of a for loop.
#
# == Basic Usage:
# == Iteration usage:
# {% for item in collection %}
# {% if item.condition %}
# {% break %}
# {% endif %}
# {% endfor %}
#
# == Theme file rendering usage:
# {% if condition %}
# {% break %}
# {% endif %}
#
# @liquid_public_docs
# @liquid_type tag
# @liquid_category iteration
# @liquid_name break
# @liquid_summary
# Stops a [`for` loop](/docs/api/liquid/tags/for) from iterating.
# Stops a [`for` loop](/docs/api/liquid/tags/for) from iterating, or stops the
# rest of a file from rendering when used outside of a loop.
# @liquid_description
# Inside a `for` or `tablerow` loop, `break` stops the loop.
#
# Outside of a loop, `break` stops the rest of the current file from
# rendering. Sections, blocks, and snippets each render in their own context, so
# rendering continues normally in the file that rendered them.
# @liquid_syntax
# {% break %}
class Break < Tag
Expand Down
Loading