> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Storefront Helper Methods
Here you can find a list of helper methods provided by Spree that are available in the Storefront. These methods can be used in every template.
## Context Helpers
### `current_store`
Store name
Example: "My Store"
Store URL
Example: `https://mystore.com`
Unique store identifier
Example: `my-store`
Email address used for sending emails
Example: `store@example.com`
Default store currency
Example: `USD`
List of supported currencies
Example: `USD,EUR,GBP`
Default store locale
Example: `en`
List of supported locales
Example: `en,es,fr`
Default country ID
Example: `1`
Default country
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
Checkout zone ID
Example: `2`
SEO title
Example: `My Amazing Store`
Meta description for SEO
Example: `The best products at the best prices`
Returns the current store [Spree::Store](https://github.com/spree/spree/blob/master/core/app/models/spree/store.rb) instance.
### `current_theme`
Theme ID
Example: 1
Theme name
Example: `Winter Sale Theme`
Checkout sidebar text color
Example: `#000000`
Custom font code
Example: `@import url('https://fonts.googleapis.com/css2?family=Inter&display=swap');`
Font family
Example: `Inter`
Font size scale
Example: `100`
Header font family
Example: `Inter`
Header font size scale
Example: `100`
Headings uppercase
Example: `true`
Button border thickness
Example: `1`
Button border opacity
Example: `100`
Button border radius
Example: `100`
Button shadow opacity
Example: `0`
Button shadow horizontal offset
Example: `0`
Button shadow vertical offset
Example: `4`
Button shadow blur
Example: `5`
Input border thickness
Example: `1`
Input border opacity
Example: `100`
Input border radius
Example: `8`
Input shadow opacity
Example: `0`
Input shadow horizontal offset
Example: `0`
Input shadow vertical offset
Example: `4`
Input shadow blur
Example: `5`
Border width
Example: `1`
Border radius
Example: `6`
Border shadow opacity
Example: `0`
Border shadow horizontal offset
Example: `0`
Border shadow vertical offset
Example: `4`
Border shadow blur
Example: `5`
Product listing image height
Example: `300`
Product listing image width
Example: `300`
Product listing image height mobile
Example: `190`
Product listing image width mobile
Example: `190`
Primary color
Example: `#000000`
Accent color
Example: `#F0EFE9`
Danger color
Example: `#C73528`
Neutral color
Example: `#999999`
Background color
Example: `#FFFFFF`
Text color
Example: `#000000`
Success color
Example: `#00C773`
Button background color
Example: `#000000`
Button text color
Example: `#ffffff`
Button hover background color
Example: `#000000`
Button hover text color
Example: `#ffffff`
Button border color
Example: `#000000`
Border color
Example: `#E9E7DC`
Sidebar border color
Example: `#E9E7DC`
Secondary button background color
Example: `#000000`
Secondary button text color
Example: `#ffffff`
Secondary button hover background color
Example: `#000000`
Secondary button hover text color
Example: `#ffffff`
Input text color
Example: `#6b7280`
Input background color
Example: `#ffffff`
Input border color
Example: `#000000`
Input focus border color
Example: `#000000`
Input focus background color
Example: `#ffffff`
Input focus text color
Example: `#000000`
Checkout sidebar background color
Example: `#f3f4f6`
Checkout divider background color
Example: `#f3f4f6`
Checkout sidebar text color
Example: `#000000`
Returns the current theme [Spree::Theme](https://github.com/spree/spree/blob/master/core/app/models/spree/theme.rb) instance.
### `current_page`
Returns the current [Spree::Page](https://github.com/spree/spree/blob/main/core/app/models/spree/page.rb) instance for the current route.
```erb theme={"theme":"night-owl"}
<%= current_page.name %>
```
### `current_order`
The order number
Example: `R123456789`
The total amount of the order
Example: 99.99
Formatted total with currency
Example: "\$99.99"
Sum of all line item amounts pre-tax
Example: 89.99
Formatted item total with currency
Example: "\$89.99"
Sum of all adjustments
Example: -10.00
Formatted adjustment total with currency
Example: "-\$10.00"
Sum of all tax amounts
Example: 13.25
Formatted tax total with currency
Example: "\$13.25"
Sum of shipment amounts
Example: 10.00
Formatted shipment total with currency
Example: "\$10.00"
Sum of all promotion adjustments
Example: -15.00
Formatted promotion total with currency
Example: "-\$15.00"
Sum of included tax amounts
Example: 8.25
Sum of additional tax amounts
Example: 5.00
Sum of completed payment amounts
Example: 99.99
Current order state
Example: `cart`
Customer email address
Example: `customer@example.com`
Associated user ID
Example: 123
Associated user object
User ID
Example: 123
User email address
Example: `customer@example.com`
User first name
Example: `John`
User last name
Example: `Doe`
Default billing address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
Default shipping address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
User tags (tags are used manageable by store admins)
Example:
```ruby theme={"theme":"night-owl"}
["vip", "wholesale"]
```
When the order was completed (placed and paid). For orders in `cart` state, this will be `nil`.
Example: `2023-06-15 13:45:00`
Billing address ID
Example: 456
Billing address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
Shipping address ID
Example: 457
Shipping address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
Payment state (balance\_due, credit\_owed, failed, paid, void)
Example: `paid`
Shipment state (backorder, canceled, partial, pending, ready, shipped)
Example: `shipped`
Order currency
Example: `USD`
Associated store ID
Example: 1
Line items in the order
Line item ID
Example: 123
Quantity of the variant ordered
Example: 2
Unit price of the variant when ordered
Example: 29.99
Formatted unit price with currency
Example: "\$29.99"
Total price for this line item (quantity \* price)
Example: 59.98
Formatted total price with currency
Example: "\$59.98"
Sum of all adjustments for this line item
Example: -5.00
Formatted adjustment total with currency
Example: "-\$5.00"
Sum of additional tax amounts
Example: 4.50
Sum of included tax amounts
Example: 2.75
Sum of promotion adjustments
Example: -10.00
Formatted promotion total with currency
Example: "-\$10.00"
Associated order ID
Example: 456
Associated product variant
Variant ID
Example: 123
Stock Keeping Unit - unique identifier for the variant
Example: "ABC-123"
Name of the variant (inherited from product)
Example: "Basic T-Shirt"
Formatted string of option values
Example: "Size: Large, Color: Blue"
Full descriptive name including master status or options
Example: "Basic T-Shirt - Size: Large, Color: Blue"
Base price of the variant
Example: 29.99
Formatted price with currency
Example: "\$29.99"
Weight of the variant
Example: 1.5
Height of the variant
Example: 10.0
Width of the variant
Example: 5.0
Depth of the variant
Example: 2.0
Whether this is the master variant of the product
Example: false
Display order position
Example: 1
Whether inventory tracking is enabled for this variant
Example: true
Whether the variant is available for purchase (not discontinued and product is available)
Example: true
Whether the variant currently has stock available
Example: true
ID of the associated tax category
Example: 1
Cost price of the variant
Example: 15.00
Currency of the cost price
Example: "USD"
ID of the associated product
Example: 456
Currency of the line item
Example: "USD"
Returns the current order object. If no order is found, it will return `nil`.
Order is automatically created when a user adds a product to the cart.
### `try_spree_current_user`
User ID
Example: 123
User email address
Example: `customer@example.com`
User first name
Example: `John`
User last name
Example: `Doe`
Default billing address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
Default shipping address object
Address ID
Example: 456
Address line 1
Example: `123 Main St`
Address line 2
Example: `Apt 1`
City
Example: `Anytown`
Zipcode
Example: `12345`
State object, if the country requires a state.
State ID
Example: 1
State name
Example: `California`
State abbreviation
Example: `CA`
Country ID
Example: 1
State name, used when the country doesn't require a state object
Example: `Some Province`
Returns either state.name (if state is present) or state\_name
Example: `California` or `Some Province`
Country name
Example: `United States`
Country ISO code
Example: `US`
Country object
Country ID
Example: 1
Country name
Example: `United States`
Country ISO3 code
Example: `USA`
Country ISO code
Example: `US`
Country ISO name
Example: `UNITED STATES`
Whether states are required for this country
Example: `true`
Whether zipcodes are required for this country
Example: `true`
User tags (tags are used manageable by store admins)
Example:
```ruby theme={"theme":"night-owl"}
["vip", "wholesale"]
```
Returns the current user object (class depends on the `Spree.user_class` configuration). If the user is not signed in, it will return `nil`.
If you want to check if the user is signed in, you can use the following:
```erb theme={"theme":"night-owl"}
<%= try_spree_current_user.present? %>
```
### `current_currency`
Returns the currently selected currency. By default in the Storefront this will be `store.default_currency`. This can be changed in the `Settings -> Store Defaults` page.
```erb theme={"theme":"night-owl"}
<%= current_currency %>
```
will return
```
USD
```
### `current_locale`
Returns the currently selected locale. By default in the Storefront this will be `store.default_locale`. This can be changed in the `Settings -> Store Defaults` page. If there are multiple locales available, it will return the locale that is currently selected by the user.
```erb theme={"theme":"night-owl"}
<%= current_locale %>
```
Locale also affects the storefront URLs. For example, if the default locale is `en` and the user selects `fr`, the URL will be `/fr/products/123`.
### `current_taxon`
Returns the current taxon when viewing a category/collection page.
```erb theme={"theme":"night-owl"}
<%= current_taxon&.name %>
```
### `current_wishlist`
Returns the current user's default wishlist for the current store.
```erb theme={"theme":"night-owl"}
<% if current_wishlist.present? %>
<%= current_wishlist.wished_items.count %> items
<% end %>
```
## Page Rendering Helpers
### `render_page`
Renders a page with all its sections. This is the main method for rendering page content.
```erb theme={"theme":"night-owl"}
<%= render_page(current_page, pickup_locations: @pickup_locations) %>
```
**Parameters:**
* `page` - The page to render (defaults to `current_page`)
* `variables` - Hash of variables to pass to section templates
### `render_section`
Renders a single section.
```erb theme={"theme":"night-owl"}
<%= render_section(section, product: @product) %>
```
### `render_header_sections`
Renders all header sections (announcement bar, header).
```erb theme={"theme":"night-owl"}
<%= render_header_sections %>
```
### `render_footer_sections`
Renders all footer sections (newsletter, footer).
```erb theme={"theme":"night-owl"}
<%= render_footer_sections %>
```
## Section & Block Helpers
### `section_styles`
Returns inline CSS styles for a section based on its preferences (padding, colors, borders).
```erb theme={"theme":"night-owl"}
```
### `block_attributes`
Returns data attributes for a block (used for Page Builder editing).
```erb theme={"theme":"night-owl"}
>
<%= block.text %>
```
### `page_builder_enabled?`
Returns `true` when the page is being viewed in Page Builder preview mode.
```erb theme={"theme":"night-owl"}
<% cache_unless page_builder_enabled?, cache_key do %>
<% end %>
```
### `page_builder_link_to`
Renders a link from a `Spree::PageLink` object.
```erb theme={"theme":"night-owl"}
<%= page_builder_link_to section.link, class: 'btn-primary' %>
<%# With custom content %>
<%= page_builder_link_to section.link do %>
→ Click here
<% end %>
```
## Currency & Price Helpers
### `supported_currencies`
Returns the list of supported currencies for the current store as an array of strings.
```erb theme={"theme":"night-owl"}
<%= supported_currencies %>
```
will return
```ruby theme={"theme":"night-owl"}
["USD", "EUR"]
```
### `display_price`
Displays a formatted price with currency symbol.
```erb theme={"theme":"night-owl"}
<%= display_price(product.price_in(current_currency)) %>
```
## Date & Time Helpers
### `local_time`
Displays a time in the user's timezone in a human readable format (based on the browser's timezone).
```erb theme={"theme":"night-owl"}
<%= local_time(order.sent_to_erp_at) %>
```
Provided by [local\_time gem](https://github.com/basecamp/local_time).
## URL Helpers
### `spree_storefront_resource_url`
Generates a URL for a Spree resource (product, taxon, post, page).
```erb theme={"theme":"night-owl"}
<%= link_to product.name, spree_storefront_resource_url(product) %>
<%= link_to taxon.name, spree_storefront_resource_url(taxon) %>
```
### `spree.nested_taxons_path`
Generates a URL for a taxon using its full permalink.
```erb theme={"theme":"night-owl"}
<%= link_to taxon.name, spree.nested_taxons_path(taxon) %>
<%# => /t/categories/clothing/shirts %>
```
## Image Helpers
### `spree_image_tag`
Renders an optimized image tag with automatic WebP conversion and retina support.
```erb theme={"theme":"night-owl"}
<%= spree_image_tag product.images.first,
width: 400,
height: 400,
alt: product.name,
loading: :lazy %>
```
### `spree_image_url`
Generates a URL for an image with specified dimensions.
```erb theme={"theme":"night-owl"}
<%= spree_image_url(product.images.first, width: 800, height: 600) %>
```
See [Media](/docs/developer/core-concepts/media) for more details on image helpers.
## Product Helpers
### `taxon_products`
Returns products for a given taxon, useful in section templates.
```erb theme={"theme":"night-owl"}
<% taxon_products(section.taxon).limit(4).each do |product| %>
<%= render 'spree/products/card', product: product %>
<% end %>
```
### `storefront_products`
Returns products based on current filters and sorting.
```erb theme={"theme":"night-owl"}
<% storefront_products.each do |product| %>
<%= render 'spree/products/card', product: product %>
<% end %>
```
## Cache Helpers
### `spree_storefront_base_cache_key`
Returns the base cache key for storefront caching.
```erb theme={"theme":"night-owl"}
<% cache [spree_storefront_base_cache_key, product] do %>
<%= render 'product_card', product: product %>
<% end %>
```
### `spree_storefront_base_cache_scope`
Returns a cache scope proc for section caching.
```erb theme={"theme":"night-owl"}
<% cache_unless page_builder_enabled?, spree_storefront_base_cache_scope.call(section) do %>
<% end %>
```
## Preview Helpers
These helpers are used for Page Builder preview functionality:
| Helper | Description |
| -------------------------- | -------------------------------------------- |
| `current_theme_preview` | Returns the theme preview if in preview mode |
| `current_page_preview` | Returns the page preview if in preview mode |
| `current_theme_or_preview` | Returns theme preview or active theme |
| `current_page_or_preview` | Returns page preview or active page |
## Related Documentation
* [Sections](/docs/developer/storefront/rails/sections) - Section rendering and customization
* [Blocks](/docs/developer/storefront/rails/blocks) - Block rendering
* [Media](/docs/developer/core-concepts/media) - Image helper methods