com.vaadin.polymer.iron.IronSwipeableContainerElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from iron-swipeable-container project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.iron;
import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;
/**
* <iron-swipeable-container> is a container that allows any of its nested
children (native or custom elements) to be swiped away. By default it supports
a curved or horizontal transition, but the transition duration and properties
can be customized.
* Example:
* <iron-swipeable-container>
* <div>I can be swiped</div>
* <paper-card heading="Me too!"></paper-card>
* </iron-swipeable-container>
*
*
*
To disable swiping on individual children, you must give them the .disable-swipe
class. Alternatively, to disable swiping on the whole container, you can use its
disable-swipe attribute:
* <iron-swipeable-container>
* <div class="disable-swipe">I cannot be swiped be swiped</div>
* <paper-card heading="But I can!"></paper-card>
* </iron-swipeable-container>
*
* <iron-swipeable-container disable-swipe>
* <div>I cannot be swiped</div>
* <paper-card heading="Me neither :("></paper-card>
* </iron-swipeable-container>
*
*
*
It is a good idea to disable text selection on any of the children that you
want to be swiped:
* .swipe {
* -moz-user-select: none;
* -ms-user-select: none;
* -webkit-user-select: none;
* user-select: none;
* cursor: default;
* }
*
*
*
*/
@JsType(isNative=true)
public interface IronSwipeableContainerElement extends HTMLElement {
@JsOverlay public static final String TAG = "iron-swipeable-container";
@JsOverlay public static final String SRC = "iron-swipeable-container/iron-swipeable-container.html";
/**
* If true, then the container will not allow swiping.
*
* JavaScript Info:
* @property disabled
* @type Boolean
*
*/
@JsProperty boolean getDisabled();
/**
* If true, then the container will not allow swiping.
*
* JavaScript Info:
* @property disabled
* @type Boolean
*
*/
@JsProperty void setDisabled(boolean value);
/**
* The ratio of the total animation distance after which the opacity
transformation begins. For example, if the widthRatio is 1 and
the opacityRate is 0.5, then the element needs to travel half its
width before its opacity starts decreasing.
*
* JavaScript Info:
* @property opacityRate
* @type Number
*
*/
@JsProperty double getOpacityRate();
/**
* The ratio of the total animation distance after which the opacity
transformation begins. For example, if the widthRatio is 1 and
the opacityRate is 0.5, then the element needs to travel half its
width before its opacity starts decreasing.
*
* JavaScript Info:
* @property opacityRate
* @type Number
*
*/
@JsProperty void setOpacityRate(double value);
/**
* The ratio of the width of the element that the translation animation
should happen over. For example, if the widthRatio is 3, the
animation will take place on a distance 3 times the width of the
element being swiped.
*
* JavaScript Info:
* @property widthRatio
* @type Number
*
*/
@JsProperty double getWidthRatio();
/**
* The ratio of the width of the element that the translation animation
should happen over. For example, if the widthRatio is 3, the
animation will take place on a distance 3 times the width of the
element being swiped.
*
* JavaScript Info:
* @property widthRatio
* @type Number
*
*/
@JsProperty void setWidthRatio(double value);
/**
* The style in which to swipe the card. Currently supported
options are curve | horizontal. If left unspecified, the default
is assumed to be horizontal.
*
* JavaScript Info:
* @property swipeStyle
* @type String
*
*/
@JsProperty String getSwipeStyle();
/**
* The style in which to swipe the card. Currently supported
options are curve | horizontal. If left unspecified, the default
is assumed to be horizontal.
*
* JavaScript Info:
* @property swipeStyle
* @type String
*
*/
@JsProperty void setSwipeStyle(String value);
/**
* The CSS transition applied while swiping.
*
* JavaScript Info:
* @property transition
* @type String
*
*/
@JsProperty String getTransition();
/**
* The CSS transition applied while swiping.
*
* JavaScript Info:
* @property transition
* @type String
*
*/
@JsProperty void setTransition(String value);
}