# ------------------------------------------------------------------------------
# ~/_data/modules/defaults/smooth_scroll.yml
# Default configuration settings for J1 Smoothscroll module
#
# Product/Info:
# https://jekyll.one
#
# Copyright (C) 2020 Juergen Adams
#
# J1 Template is licensed under the MIT License.
# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
#
# ------------------------------------------------------------------------------

# ------------------------------------------------------------------------------
# About this configuration (used for J1 CC only)
#
about_config:

  title:                                SmoothScroll
  scope:                                Default settings
  location:                             _data/modules/defaults/smooth_scroll.yml

# ------------------------------------------------------------------------------
# User configuration settings
#
defaults:

  # ------------------------------------------------------------------------------
  # J1 Scroll Manager settings
  # ------------------------------------------------------------------------------
  # SmoothScroll settings
  # Enables smooth vertical page scrolling on Mouse Wheel, Keyboard and Touchpad
  #
  #   enabled
  #   ----------------------------------------------------------------------------
  #   Enables|Disables the use of SmoothControl
  #
  #     values:                         boolean (true|false)
  #     default:                        false
  #
  #   SCROLLING CORE
  #   --------------
  #
  #   frameRate
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         integer (Hz)
  #     default:                        150
  #
  #   animationTime
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         integer (msec)
  #     default:                        400
  #
  #   stepSize
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         integer (px)
  #     default:                        100
  #
  #   ACCELERATION SETTINGS
  #   ---------------------
  #
  #   accelerationDelta
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         integer
  #     default:                        50
  #
  #   accelerationMax
  #   ----------------------------------------------------------------------------
  #    ...
  #
  #     values:                         integer
  #     default:                        3
  #
  #   KEYBOARD SETTINGS
  #   -----------------
  #
  #   keyboardSupport
  #   ----------------------------------------------------------------------------
  #   Enables|Disables Keyboard support for smooth scrolling
  #
  #     values:                         boolean (true|false)
  #     default:                        true
  #
  #   arrowScroll
  #   ----------------------------------------------------------------------------
  #   Number of pixels to scroll when pressing a keyboard arrow key
  #
  #     values:                         integer (px)
  #     default:                        50
  #
  #   PULSE ALGORITHM SETTINGS
  #   ------------------------
  #
  #   pulseAlgorithm
  #   ----------------------------------------------------------------------------
  #   Enables easing of the scrolling animation. When disabled, the page
  #   animation will be linear (ratio of "tail" to "acceleration")
  #
  #     values:                         boolean (true|false)
  #     default:                        true
  #
  #   pulseScale
  #   ----------------------------------------------------------------------------
  #   Defines the speed of pulse step scrolling
  #
  #     values:                         integer
  #     default:                        4
  #
  # pulseNormalize
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         integer
  #     default:                        1
  #
  #   TOUCHPAD SETTINGS
  #   -----------------
  #
  #   touchpadSupport
  #   ----------------------------------------------------------------------------
  #   Enables|Disables Touchpad support for smooth scrolling
  #
  #     values:                         boolean (true|false)
  #     default:                        false
  #
  #   OTHER SETTINGS
  #   --------------
  #
  #   fixedBackground
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         boolean (true|false)
  #     default:                        true
  #
  #   excluded
  #   ----------------------------------------------------------------------------
  #   ...
  #
  #     values:                         string
  #     default:                        empty string
  # ------------------------------------------------------------------------------
  enabled:                            false
  frameRate:                          150
  animationTime:                      400
  stepSize:                           100
  accelerationDelta:                  50
  accelerationMax:                    3
  keyboardSupport:                    true
  arrowScroll:                        50
  pulseAlgorithm:                     true
  pulseScale:                         4
  pulseNormalize:                     1
  touchpadSupport:                    false
  fixedBackground:                    true
  excluded:


# ------------------------------------------------------------------------------
# END config