Documentation

ScrollingSettingsGroup extends SettingsGroup

in package

• footnotes

Class defining the scrolling settings.

Tags

since

2.8.0

Table of Contents

FOOTNOTES_CSS_SMOOTH_SCROLLING  = array('key' => 'footnotes_inputfield_css_smooth_scrolling', 'name' => 'CSS-based Smooth Scrolling', 'description' => 'May slightly disturb jQuery scrolling and is therefore disabled by default. Works in recent browsers.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key to enable CSS smooth scrolling.

FOOTNOTES_SCROLL_DOWN_DELAY  = array('key' => 'footnotes_inputfield_scroll_down_delay', 'name' => 'Scroll-down Delay', 'description' => 'milliseconds. Useful to see the effect on input elements when referrers without hard links are clicked in form labels.', 'default_value' => 0, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 20000, 'input_min' => 0)

Settings container key for scroll-down delay.

FOOTNOTES_SCROLL_DOWN_DURATION  = array('key' => 'footnotes_inputfield_scroll_down_duration', 'name' => 'Scroll-down Duration', 'description' => 'milliseconds', 'default_value' => 150, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 20000, 'input_min' => 0, 'enabled_by' => self::FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY)

Settings container key for scroll duration.

FOOTNOTES_SCROLL_DURATION  = array('key' => 'footnotes_inputfield_scroll_duration', 'name' => 'Scroll Duration', 'description' => 'milliseconds. If asymmetric scroll durations are enabled, this is the scroll-up duration.', 'default_value' => 380, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 20000, 'input_min' => 0)

Settings container key for scroll duration.

FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY  = array('key' => 'footnotes_inputfield_scroll_duration_asymmetricity', 'name' => 'Enable Asymmetric Scroll Durations', 'description' => 'With this option enabled, scrolling up may take longer than down, or conversely.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')

Settings container key for scroll duration asymmetricity

FOOTNOTES_SCROLL_OFFSET  = array('key' => 'footnotes_inputfield_scroll_offset', 'name' => 'Scroll Offset', 'description' => 'per cent viewport height from the upper edge', 'default_value' => 20, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 100, 'input_min' => 0)

Settings container key for scroll offset.

FOOTNOTES_SCROLL_UP_DELAY  = array('key' => 'footnotes_inputfield_scroll_up_delay', 'name' => 'Scroll-up Delay', 'description' => 'milliseconds. Less useful than the scroll-down delay.', 'default_value' => 0, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 20000, 'input_min' => 0)

Settings container key for scroll-up delay.

GROUP_ID  = 'scrolling'

Setting group ID.

GROUP_NAME  = 'Scrolling Behavior'

Setting group name.

$options_group_slug  : string

Setting options group slug.

$section_slug  : string

Setting section slug.

$setting_classes  : array<string|int, mixed>

The setting classes.

$settings  : array<string|int, mixed>

The settings in this group.

$settings_obj  : Settings

The plugin settings object.

__construct()  : mixed

Constructs the settings section.

add_settings_fields()  : void

Adds all the settings fields for this group to the admin. dashboard.

get_options()  : array<string|int, mixed>

Creates an options group from the values of the settings in this section.

get_setting()  : Setting|null

Retrieve a setting by its key.

get_setting_value()  : mixed

Get a setting's value by its key.

set_setting_value()  : bool

Set a setting's value by its key.

add_setting()  : Setting

Constructs settings from the provided details.

add_settings()  : void

Add the settings for this settings group.

load_dependencies()  : void

Load the required dependencies.

load_values()  : void

Load the values for this settings group.