Package Exports

cupertino-pane

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cupertino-pane) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cupertino Pane

npm npm NPM

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
Supporting platforms
Getting Started
Settings
Future Goals
Contributing
License

Demonstration

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">
    <div class="cupertino-header">
        Header
    </div>
    <div class="cupertino-content">
        Content
    </div>    
</div>

Additional CSS Styles

.cupertino-pane-wrapper .pane {
    background: #ffffff;
}

.cupertino-header,
.cupertino-content {
    margin: 20px;
}

Initialize Cupertino Pane

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

jQuery example

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

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', { /* ... */ });

Settings

Common configuration

initialShow | boolean: false | Determinate if pane will rendered with animation or immediately
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
backdropClose | boolean: false | Close pane with click to backdrop element
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

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

Future Goals

Hardware accelerated drag&drop actions
Realistic easy-in-out transitions
Work out the state with overflow-x
Using in all 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.