https://github.com/chemzqm/viewstack

Lightweight view switch component with animation
https://github.com/chemzqm/viewstack

Last synced: about 1 month ago
JSON representation

Lightweight view switch component with animation

• Host: GitHub
• URL: https://github.com/chemzqm/viewstack
• Owner: chemzqm
• Created: 2016-04-17T13:59:03.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-08-03T12:15:50.000Z (over 8 years ago)
• Last Synced: 2024-11-07T01:16:04.829Z (about 2 months ago)
• Language: JavaScript
• Size: 106 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# ViewStack

Flexible view switch component build with lightweight components.

[demo](https://chemzqm.github.io/viewstack/)

**WIP** use with caution.

## Install

     npm i viewstack -S

## Example

``` js

var header = document.querySelector('header')

var body = document.querySelector('.viewstack-body')

var vs = new ViewStack(header, body)

// push a view

vs.push({

  text 'title',

  back: 'back',

  bgColor: '#111',

  icon: 'icon-more',

  action: 'showMore'

}, el)

// transition back

vs.back()

```

## API

### new ViewStack(head, body ,[delegate])

Init ViewStack with head element, body element, and optional delegate object.

* `head` should be Dom element for current head.

* `body` should be Dom element for current body.

* `delegate` should be object contains handlers for icon tap.

### .push(title, body)

Add a new view with title config and body as content element.

* `title.text` for title text (could be html)

* `title.back` [optional] for back text.

* `title.bgColor` [optional] background color of new title.

* `title.icon` [optional] icon className for right icon.

* `title.action` [optional] action key of delegate object to handle icon tap.

### .back()

Return to previous view.

## LICENSE

Copyright 2016 [email protected]

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the "Software"),

to deal in the Software without restriction, including without limitation

the rights to use, copy, modify, merge, publish, distribute, sublicense,

and/or sell copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE

OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.