README.md

CardStackView [ ACTIVE ]

-- read realise notes before migrating to this library

Overview

Contents

• Features
  • Manual Swipe
  • Automatic Swipe
  • Move to Origin
  • Reverse
  • StackFrom
  • VisibleCount
  • ElevationEnabled
  • TranslationDiff
  • ScaleDiff
  • Overlay
  • SwipeEnabled
  • SwipeDirection
  • SwipeThreshold
• Installation
• License

Features

Manual Swipe

Automatic Swipe

Custom animation is available when automatic swiping!

CardStackView#swipe(SwipeDirection, AnimatorSet)

Move to Origin

Reverse

CardStackView#reverse();

StackFrom

Default	Value	Sample
✅	Top
	Bottom

<com.shynline.android.cardstackview.CardStackView
    app:stackFrom="top"
    or
    app:stackFrom="bottom"/>

CardStackView#setStackFrom(StackFrom.Top);
or
CardStackView#setStackFrom(StackFrom.Bottom);

VisibleCount

This value must be greater than 0.

Default	Value	Sample
✅	3
	4

<com.shynline.android.cardstackview.CardStackView
    app:visibleCount="3"
    or
    app:visibleCount="4"/>

CardStackView#setVisibleCount(3);
or
CardStackView#setVisibleCount(4);

ElevationEnabled

Default	Value	Sample
✅	true
	false

<com.shynline.android.cardstackview.CardStackView
    app:elevationEnabled="true"
    or
    app:elevationEnabled="false"/>

CardStackView#setElevationEnabled(true);
or
CardStackView#setElevationEnabled(false);

TranslationDiff

The unit of TranslationDiff is dp.

Default	Value	Sample
	8dp
✅	12dp
	16dp

<com.shynline.android.cardstackview.CardStackView
    app:translationDiff="12"/>

CardStackView#setTranslationDiff(12f);

ScaleDiff

The range of ScaleDiff is 0.0 - 1.0.

Default	Value	Sample
✅	0.02
	0.1

<com.shynline.android.cardstackview.CardStackView
    app:scaleDiff="0.02"/>

CardStackView#setScaleDiff(0.02f);

Overlay

Value	Sample
Left
Right

<com.shynline.android.cardstackview.CardStackView
    app:leftOverlay="@layout/overlay_left"
    or
    app:rightOverlay="@layout/overlay_right"/>

CardStackView#setLeftOverlay(R.layout.overlay_left);
or
CardStackView#setRightOverlay(R.layout.overlay_right);

SwipeEnabled

Default	Value	Sample
✅	true
	false

<com.shynline.android.cardstackview.CardStackView
    app:swipeEnabled="true"
    or
    app:swipeEnabled="false"/>

CardStackView#setSwipeEnabled(true);
or
CardStackView#setSwipeEnabled(false);

SwipeDirection

Default	Value	Sample
✅	Freedom
	Horizontal
	Vertical

<com.shynline.android.cardstackview.CardStackView
    app:swipeDirection="freedom"
    or
    app:swipeDirection="horizontal"
    or
    app:swipeDirection="vertical"/>

CardStackView#setSwipeDirection(SwipeDirection.FREEDOM);
or
CardStackView#setSwipeDirection(SwipeDirection.HORIZONTAL);
or
CardStackView#setSwipeDirection(SwipeDirection.VERTICAL);

SwipeThreshold

The range of SwipeThreshold is 0.0 - 1.0.

Default	Value	Sample
✅	0.75
	0.1

<com.shynline.android.cardstackview.CardStackView
    app:swipeThreshold="0.75"/>

CardStackView#setSwipeThreshold(0.75f);

Installation

dependencies {
    implementation 'com.github.shynline:CardStackView:2.1.0'
}

License

Copyright 2017 yuyakaido

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.