npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@terminus/ui-scrollbars

v2.0.0

Published

<h1>Scrollbars</h1>

Downloads

5

Readme

CI/CD Status Codecov MIT License
NPM version Library size

Table of Contents

Installation

Packages that need to be installed

  • @angular/cdk
  • @angular/common
  • @angular/core
  • @angular/flex-layout
  • @angular/forms
  • @angular/platform-browser
  • @terminus/design-tokens
  • @terminus/fe-utilities
  • @terminus/ui-utilities
  • @terminus/ui-scrollbars
  • date-fns
  • ngx-perfect-scrollbar

Use the ng add command to quickly install all the needed dependencies:

ng add @terminus/ui-scrollbars

Modules that need to be in NgModule

  • TsScrollbarsModule

CSS imports

In your top level stylesheet, add these imports:

@import '~@terminus/design-tokens/css/library-design-tokens.css';
@import '~@terminus/ui-styles/terminus-ui.css';

Usage

You must set a fixed height and/or width to enable scrollbars (otherwise the browser will just continue making the container larger to fit the content).

<ts-scrollbars style="height: 300px; width: 400px;">
  ...
</ts-scrollbars>

Disable

The scrollbars can be disabled dynamically if needed:

<ts-scrollbars [isDisabled]="true">
  ...
</ts-scrollbars>

Update

If the scrollbars content is dynamically updated, you will need to update the scrollbars instance:

<!-- Get a reference to the component class -->
<ts-scrollbars #scrollbars="tsScrollbars">
  ...
</ts-scrollbars>
...

@ViewChild(TsScrollbarsComponent, {static: false})
public scrollbars!: TsScrollbarsComponent;

myUpdate() {
  // Update the content
  this.updateScrollContent();

  // Update the scrollbars
  this.scrollbars.update();
}

Manual Position Control

Scrolling methods can be called directly once a reference to the component is attained:

<!-- Get a reference to the component class -->
<ts-scrollbars #scrollbars="tsScrollbars">
  ...
</ts-scrollbars>
...
// A reference to the component instance:
@ViewChild(TsScrollbarsComponent, {static: false})
public scrollbars!: TsScrollbarsComponent;
...

The following scroll examples will assume that a reference has already been created.

Scroll to fixed location

@ViewChild(TsScrollbarsComponent, {static: false})
public scrollbars!: TsScrollbarsComponent;

scrollToTop() {
  // Scroll the container to the very top
  this.scrollbars.scrollToTop();
}

Available fixed location methods:

| Method | |--------------------| | scrollToBottom() | | scrollToLeft() | | scrollToRight() | | scrollToTop() |

Scroll to x/y location

Scroll the container to a specific x/y location:

@ViewChild(TsScrollbarsComponent, {static: false})
public scrollbars!: TsScrollbarsComponent;

scrollToCoordinates() {
  //                       x    y    speed
  this.scrollbars.scrollTo(100, 250, 200);
}

Scroll to element

The component can scroll a nested element to the top of the scroll container:

@ViewChild(TsScrollbarsComponent, {static: false})
public scrollbars!: TsScrollbarsComponent;

scrollToElement() {
  // This supports any string that can be passed to `querySelector()`
  this.scrollbars.scrollToElement('.my-class');
}

Events

<ts-scrollbars (scrollDown)="myFunc($event)">
  ...
</ts-scrollbars>

| Available events | |------------------| | scrollDown | | scrollLeft | | scrollRight | | scrollUp | | scrollX | | scrollY | | xReachEnd | | xReachStart | | yReachEnd | | yReachStart |