Skip to content
🎉📱Multiplatform lightweight drawer slide-over pane. For modern progressive applications
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
dist Removed option backdropClose, Add option backdropTransparent, Add eve… Feb 20, 2020
docs/images docs gif Dec 23, 2019
gulp fix bundles Feb 6, 2020
src Removed option backdropClose, Add option backdropTransparent, Add eve… Feb 20, 2020
.gitignore gulp Nov 30, 2019
LICENSE Create LICENSE Nov 28, 2019
README.md Removed option backdropClose, Add option backdropTransparent, Add eve… Feb 20, 2020
gulpfile.js gulp Nov 30, 2019
package-lock.json chore(package): update lockfile package-lock.json Feb 12, 2020
package.json version up Feb 20, 2020
tsconfig.json issue #4 Dec 28, 2019
tslint.json

README.md

Cupertino Pane

CircleCI npm npm NPM Code Style Code Style

Cupertino Pane is great modern slide-over pane with touch technologies. Right like in Apple Maps, Apple Stocks, Apple Music and other modern apps.

Lightweight, Multiplatform, Open Source. For progressive applications.

Demonstration

Live Demo

Supporting platforms

We officially support the last two versions of every major browser. Specifically, we test on the following browsers:

  • Chrome on Android, Windows, macOS, and Linux
  • Firefox on Windows, macOS, and Linux
  • Safari on iOS
  • iOS WkWebView on iOS
  • Android WebView on Android

Getting Started

Install via NPM

npm install cupertino-pane

Use from CDN

If you don't want to include Cupertino Pane files in your project, you may use it from CDN. The following files are available:

<script src="https://unpkg.com/cupertino-pane/dist/cupertino-pane.js"></script>
<script src="https://unpkg.com/cupertino-pane/dist/cupertino-pane.min.js"></script>

Include Files To App/Website

<!DOCTYPE html>
<html lang="en">
<body>
    ...
    <script src="path/to/cupertino-pane.min.js"></script>
</body>
</html>

Add HTML Layout

<div class="cupertino-pane">
    <h1>Header</h1>
    <div class="content">Content</div>    
</div>

Additional CSS Styles

.cupertino-pane {
    margin: 20px;
}

Initialize Cupertino Pane

<body>
  ...
  <script>
  window.onload = function () {
    var myPane = new CupertinoPane(
      '.cupertino-pane', // Pane container selector
      { 
        parentElement: 'body', // Parent container
        breaks: {
            top: { enabled: false, offset: -70 },
            middle: { enabled: true, offset: 0 },
            bottom: { enabled: true, offset: 0 },
        },
        onDrag: () => console.log('Drag event')
      }
    );
    myPane.present({animate: true});
  };
  </script>
</body>

jQuery example

$(document).ready(function () {
  //initialize pane when document ready
  var myPane = new CupertinoPane('.cupertino-pane', { /* ... */ });
  myPane.present();
});

As an ES module

Cupertino Pane package comes with ES module version which can be used where supported or with bundlers like Webpack or Rollup:

import { CupertinoPane } from 'cupertino-pane';

var myPane = new CupertinoPane('.cupertino-pane', { /* ... */ });
    myPane.present();

Settings

Common configuration

  • parentElement | string | Element selector where pane will appended (by default using parent element where html layout placed)
  • initialBreak | (top|middle|bottom): 'middle' | Initial pane position
  • darkMode | boolean: false | Initial pane styles
  • backdrop | boolean: false | Dimmed overlay will rendered with pane if true
  • backdropTransparent | boolean: false | Dimmed overlay will rendered with zero opacity
  • animationType | (ease | ease-in | ease-out | ease-in-out | cubic-bezier): 'ease' | Transition property animation type
  • animationDuration | number: 300 | Transition property duration
  • bottomClose | boolean: false | Close pane with drag to bottom breakpoint
  • freeMode | boolean: false | On true will remove automatical magnetic effects to near breakpoint.
  • buttonClose | boolean: true | Determinate whetever close button will render or not
  • topperOverflow | boolean: true | Ability to scroll content inside pane if topper point reached
  • topperOverflowOffset | number: 0 | Offset from screen bottom to the end of overflow content
  • showDraggable | boolean: true | Render rectangular shape on the top of pane
  • clickBottomOpen | boolean: true | If bottom position reached, simple click to pane will open pane to the next upper point
  • simulateTouch | boolean: true | Simulate touch events for Desktop
  • passiveListeners | boolean: true | (Indicates that the function specified by listener will never call preventDefault())

Breakpoints

  • breaks | {} | Using to override default pane breakpoints. Note that necessary to define all three breakpoints when override, with new enabled and offset if needs.
    • top | {} | Topper point that pane can reach
      • enabled | boolean: true | Enable or disable breakpoint
      • offset | number: 0 | Additional bottom margin if needs
    • middle | {} | Middle point that pane can reach
      • enabled | boolean: true | Enable or disable breakpoint
      • offset | number: 0 | Additional bottom margin if needs
    • bottom | {} | Bottom point that pane can reach
      • enabled | boolean: true | Enable or disable breakpoint
      • offset | number: 0 | Additional bottom margin if needs

Callbacks

The function that executes when the event fires.

  • onDidDismiss | void: () => {} | Call after pane will dissapeared
  • onWillDismiss | void: () => {} | Call before pane will dissapeared
  • onDidPresent | void: () => {} | Call after pane will present
  • onWillPresent | void: () => {} | Call before panel will present
  • onDragStart | void: () => {} | Call when detect user drag event on pane
  • onDrag | void: () => {} | Call executes on each new pane position
  • onBackdropTap | void: () => {} | Call when user tap backdrop overlay

Public Methods

present({animate: boolean = false})

Will render pane DOM and show pane with setted params.

myPane.present();

moveToBreak('top' | 'middle' | 'bottom')

Will change pane position with animation to selected breakpoint.

myPane.moveToBreak('top');

hide()

Dissappear pane from screen, still keep pane in DOM.

myPane.hide();

destroy({animate: boolean = false})

Remove pane from DOM and clear styles

myPane.destroy();

isHidden()

Determinate if pane position was moved out of screen, but pane still exist in DOM. true - in DOM but not visible, false - in DOM and visible, null - not rendered

if (myPane.isHidden()) {
    myPane.moveToBreak('top');
}

Attributes

hide-on-bottom

Set for element to automaticaly hide on reach bottom breakpoint.

<div class="cupertino-pane">
    <h1>Header</h1>
    <div class="content" hide-on-bottom>Content</div>    
</div>

overflow-y

Set for element with overflow ability. By default using for full pane area, but in some cases good useful with header.

<div class="cupertino-pane">
    <h1>Header</h1>
    <div class="content" overflow-y>Content</div>    
</div>

Future Goals

  • Hardware accelerated drag&drop actions
  • Realistic easy-in-out transitions
  • Using in 3 popular mobile frameworks

Contributing

We welcome contributions of all kinds from anyone.

1. Where do I go from here?

If you've noticed a bug or have a question, make an issue, we'll try to answer it as fast as possible.

2. Fork & Create a branch

If this is something you think you can fix, then fork Cupertino Pane and create a branch.

# Create new branch
git checkout -b my_issue

# Then we install the dependencies
npm install

3. Changes & Build

# Make bundles 
gulp build

This will output the files into the dist directory.

4. Push changes

Push your changes to a topic branch in your fork of the repository. Submit a pull request to the repository. It can take several days before we can review the code you've submitted.

License

Licensed under the MIT License. View license.

You can’t perform that action at this time.