1. class
  2. Waterhole
  3. \
  4. Layouts
  5. \
  6. ListLayout

ListLayout

class ListLayout extends Layout (View source)

Methods

string
label()

The text label for the layout.

string|null
icon()

The icon representing the layout.

string|null
wrapperClass()

Class to apply to the wrapper element.

string
itemComponent()

The name of the component used to display a post in the layout.

void
scope(Builder $query)

Apply a scope to the post feed query when this layout is active.

from  Layout
string|null
configField()

Name of the Waterhole\Forms\Field class for configuration of the layout.

Details

at line 9
string label()

The text label for the layout.

Return Value

string

at line 14
string|null icon()

The icon representing the layout.

Return Value

string|null

at line 19
string|null wrapperClass()

Class to apply to the wrapper element.

Return Value

string|null

at line 24
string itemComponent()

The name of the component used to display a post in the layout.

Return Value

string

in Layout at line 41
void scope(Builder $query)

Apply a scope to the post feed query when this layout is active.

Parameters

Builder $query

Return Value

void

at line 29
string|null configField()

Name of the Waterhole\Forms\Field class for configuration of the layout.

Return Value

string|null