ScrollPanelScrollPanel is a cross browser, lightweight and skinnable alternative to native browser scrollbar.

ScrollPanel - 图1

Documentation

Import

  2. import {ScrollPanelModule} from 'primeng/scrollpanel';
  3.  

Getting Started

ScrollPanel is defined with p-scrolPanel element having dimensions for the scrollable viewport.

  2. <p-scrollPanel [style]="{width: '100%', height: '200px'}">
  3.     Content
  4. </p-scrollPanel>
  5.  

Customization

Look and feel can easily be customized, here is an example with a background and blue handle.

  2. <p-scrollPanel [style]="{width: '100%', height: '200px'}" styleClass="custom">
  3.     Content
  4. </p-scrollPanel>
  5.  
  2. .custom .ui-scrollpanel-wrapper {
  3.     border-right: 9px solid #f4f4f4; 
  4. }
  6. .custom .ui-scrollpanel-bar {
  7.     background-color: #1976d2; 
  8.     opacity: 1; 
  9.     transition: background-color .3s; 
  10. }
  12. .custom .ui-scrollpanel-bar:hover {
  13.     background-color: #135ba1;
  14. }
  15.  

Properties

NameTypeDefaultDescription
stylestringnullInline style of the component.
styleClassstringnullStyle class of the component.

Styling

Following is the list of structural style classes, for theming classes visit theming page.

NameElement
ui-scrollpanelContainer element.
ui-scrollpanel-wrapperWrapper of content section.
ui-scrollpanel-contentContent section.
ui-scrollpanel-barScrollbar handle.
ui-scrollpanel-bar-xScrollbar handle of a horizontal bar.
ui-scrollpanel-bar-yScrollbar handle of a vertical bar

Methods

NameParametersDescription
refresh-Refreshes the position and size of the scrollbar.
scrollTopvalue: numberScrolls the top location to the given value.

Dependencies

None.

Source

View on GitHub

  2. <div class="ui-g">
  3.     <div class="ui-g-12 ui-md-4">
  4.         <p-scrollPanel [style]="{width: '100%', height: '200px'}">
  5.             <div style="padding:1em;line-height:1.5">
  6.                 The story begins as Don Vito Corleone, the head of a New York Mafia family, oversees his daughter's wedding. His beloved
  7.                 son Michael has just come home from the war, but does not intend to become part of his father's business.
  8.                 Through Michael's life the nature of the family business becomes clear. The business of the family is just
  9.                 like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence
  10.                 whenever anything stands against the good of the family. The story begins as Don Vito Corleone, the head
  11.                 of a New York Mafia family, oversees his daughter's wedding. His beloved son Michael has just come home from
  12.                 the war, but does not intend to become part of his father's business. Through Michael's life the nature of
  13.                 the family business becomes clear. The business of the family is just like the head of the family, kind and
  14.                 benevolent to those who give respect, but given to ruthless violence whenever anything stands against the
  15.                 good of the family.
  16.             </div>
  17.         </p-scrollPanel>
  18.     </div>
  19.     <div class="ui-g-12 ui-md-4">
  20.         <p-scrollPanel [style]="{width: '100%', height: '200px'}" styleClass="custombar1">
  21.             <div style="padding:1em;line-height:1.5">
  22.                 The story begins as Don Vito Corleone, the head of a New York Mafia family, oversees his daughter's wedding. His beloved
  23.                 son Michael has just come home from the war, but does not intend to become part of his father's business.
  24.                 Through Michael's life the nature of the family business becomes clear. The business of the family is just
  25.                 like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence
  26.                 whenever anything stands against the good of the family. The story begins as Don Vito Corleone, the head
  27.                 of a New York Mafia family, oversees his daughter's wedding. His beloved son Michael has just come home from
  28.                 the war, but does not intend to become part of his father's business. Through Michael's life the nature of
  29.                 the family business becomes clear. The business of the family is just like the head of the family, kind and
  30.                 benevolent to those who give respect, but given to ruthless violence whenever anything stands against the
  31.                 good of the family.
  32.             </div>
  33.         </p-scrollPanel>
  34.     </div>
  35.     <div class="ui-g-12 ui-md-4">
  36.         <p-scrollPanel [style]="{width: '100%', height: '200px'}" styleClass="custombar2">
  37.             <div style="padding:1em;line-height:1.5;width:600px;">
  38.                 The story begins as Don Vito Corleone, the head of a New York Mafia family, oversees his daughter's wedding. His beloved
  39.                 son Michael has just come home from the war, but does not intend to become part of his father's business.
  40.                 Through Michael's life the nature of the family business becomes clear. The business of the family is just
  41.                 like the head of the family, kind and benevolent to those who give respect, but given to ruthless violence
  42.                 whenever anything stands against the good of the family. The story begins as Don Vito Corleone, the head
  43.                 of a New York Mafia family, oversees his daughter's wedding. His beloved son Michael has just come home from
  44.                 the war, but does not intend to become part of his father's business. Through Michael's life the nature of
  45.                 the family business becomes clear. The business of the family is just like the head of the family, kind and
  46.                 benevolent to those who give respect, but given to ruthless violence whenever anything stands against the
  47.                 good of the family.
  48.             </div>
  49.         </p-scrollPanel>
  50.     </div>
  51. </div>
  52.  
  2. @Component({
  3.     templateUrl: './scrollpaneldemo.html',
  4.     styles: [`
  5.         .custombar1 .ui-scrollpanel-wrapper {
  6.             border-right: 9px solid #f4f4f4;
  7.         }
  9.         .custombar1 .ui-scrollpanel-bar {
  10.             background-color: #1976d2;
  11.             opacity: 1;
  12.             transition: background-color .3s;
  13.         }
  15.         .custombar1 .ui-scrollpanel-bar:hover {
  16.             background-color: #135ba1;
  17.         }
  19.         .custombar2 .ui-scrollpanel-wrapper {
  20.             border-right: 9px solid #757575;
  21.             border-bottom: 9px solid #757575;
  22.         }
  24.         .custombar2 .ui-scrollpanel-bar {
  25.             background-color: #68C77D;
  26.             border-radius: 0;
  27.             opacity: 1;
  28.             transition: background-color .3s;
  29.         }
  31.         .custombar2:hover .ui-scrollpanel-bar {
  32.             background-color: #46A55A;
  33.         }
  34.     `],
  35.     encapsulation: ViewEncapsulation.None
  36. })
  37. export class ScrollPanelDemo {
  39. }    
  40.