Giter Club home page Giter Club logo

angular-slimscroll's Introduction

angular-slimscroll

This is a small directive to allow the use of jquery slimScroll plugin (https://github.com/rochal/jQuery-slimScroll) in angular. Get more detailed information about slimScroll, please visit: http://rocha.la/jQuery-slimScroll

Install

This plugin can be installed via bower. If you already have the bower installed in your machine, you can install it by the following command, if you are not familiar with bower, please refer to http://bower.io/ to learn more about the bower itself.

bower install angular-slimscroll --save

Then add ui.slimscroll as a dependency for your app:

var app =  angular.module('app', ['ui.slimscroll']);

Usage

<div class="scroll-body" slimscroll="{slimscrollOption: value}">
  Scroll Content
</div>

Options

  • noWatch - Prevent directive from watching the option object
  • width - Width in pixels of the visible scroll area. Stretch-to-parent if not set. Default: none
  • height - Height in pixels of the visible scroll area. Also supports auto to set the height to same as parent container. Default: 250px
  • size - Width in pixels of the scrollbar. Default: 7px
  • position - left or right. Sets the position of the scrollbar. Default: right
  • color - Color in hex of the scrollbar. Default: #000000
  • alwaysVisible - Disables scrollbar hide. Default: false
  • distance - Distance in pixels from the edge of the parent element where scrollbar should appear. It is used together with position property. Default:1px
  • start - top or bottom or $(selector) - defines initial position of the scrollbar. When set to bottom it automatically scrolls to the bottom of the scrollable container. When HTML element is passed, slimScroll defaults to offsetTop of this element. Default: top.
  • wheelStep - Integer value for mouse wheel delta. Default: 20
  • railVisible - Enables scrollbar rail. Default: false
  • railColor - Sets scrollbar rail color, Default: #333333
  • railOpacity - Sets scrollbar rail opacity. Default: 0.2
  • allowPageScroll - Checks if mouse wheel should scroll page when bar reaches top or bottom of the container. When set to true is scrolls the page.Default: false
  • scrollTo - Jumps to the specified scroll value. Can be called on any element with slimScroll already enabled. Example: $(element).slimScroll({ scrollTo: '50px' });
  • scrollBy - Increases/decreases current scroll value by specified amount (positive or negative). Can be called on any element with slimScroll already enabled. Example: $(element).slimScroll({ scrollBy: '60px' });
  • disableFadeOut - Disables scrollbar auto fade. When set to true scrollbar doesn't disappear after some time when mouse is over the slimscroll div.Default: false
  • touchScrollStep - Allows to set different sensitivity for touch scroll events. Negative number inverts scroll direction.Default: 200

License

angular-slimscroll is released under the MIT License. Feel free to use it in personal and commercial projects.

angular-slimscroll's People

Contributors

aeyoll avatar gabrielfgularte avatar gregwym avatar huguangju avatar mikhaelgerbet avatar myomyintaung512 avatar ziscloud avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.