shopp('storefront.views')

Displays buttons to allow the shopper to change the current category view style to grid or list.

shopp('storefront', 'views', 'options')

@param string $object the object or object.tag combination, if object.tag is used, the tag parameter can be omitted
@param string $tag the tag, can be hyphenated or not. Prefix with 'get' as shorthand for the return=true option
@param mixed $options associative array, or url-style name=value pairs separated by ampersands (&). Each pair is passed to the theme api tag as an option.
@returns string Markup for the views controls

Displays buttons to allow the shopper to change the current category view style to grid or list. Changes to the view setting are stored in a cookie so that the view is used for displaying all categories across the entire site until changed again. Clicking a view button toggles the grid or list class on the catalog container element and can have custom styles applied to it in the shopp.css template file.

The behavior of this control is dependent upon Javascript functioning properly. If it does not work as expected, it is most likely a result of broken Javascript. See the Knowledge Base article Broken JavaScript Errors

Options

  • label: Default is empty. Allows you to specify a custom label for the button controls.

Universal Options

All Theme API calls have these options.

  • return: when set to true, 1, or on, this option forces the tag to return the value instead of displaying/echoing the value to the page. Alternatively, prefix the tag parameter with get to get the same effect. All theme api tags that return a boolean value will return by default.
  • echo: when set to false, 0, or off, this option forces the tag to display the value to the page. This is the default for all non-boolean tags.
  • is: when set to true, 1, or on, this option will evaluate the return of the theme api call as a boolean true or false value. See how values are converted to boolean.

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar