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

Layout

abstract class Layout (View source)

Base class for a Layout.

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.

string|null
configField()

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

Details

at line 15
abstract string label()

The text label for the layout.

Return Value

string

at line 20
string|null icon()

The icon representing the layout.

Return Value

string|null

at line 28
string|null wrapperClass()

Class to apply to the wrapper element.

Return Value

string|null

at line 36
abstract string itemComponent()

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

Return Value

string

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 48
string|null configField()

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

Return Value

string|null