com.github.fluorumlabs.disconnect.polymer.elements.IronOverlayBackdropElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of disconnect-polymer Show documentation

Polymer 3 bindings for Disconnect Zero

There is a newer version: 0.1.0-alpha2

package com.github.fluorumlabs.disconnect.polymer.elements;

import com.github.fluorumlabs.disconnect.core.annotations.Import;
import com.github.fluorumlabs.disconnect.core.annotations.NpmPackage;
import com.github.fluorumlabs.disconnect.polymer.Polymer;
import js.web.dom.HTMLElement;
import org.teavm.jso.JSProperty;

/**
 * iron-overlay-backdrop is a backdrop used by Polymer.IronOverlayBehavior. It
 * should be a singleton.
 *
 * Styling
 * The following custom properties and mixins are available for styling.
 *
 * 
 *     
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * The following custom properties and mixins are available for styling.Custom property Description Default
--iron-overlay-backdrop-background-color Backdrop background
 * color #000
--iron-overlay-backdrop-opacity Backdrop opacity 0.6
--iron-overlay-backdrop Mixin applied to iron-overlay-backdrop. 
 * {}
 * 
--iron-overlay-backdrop-opened Mixin applied to iron-overlay-backdrop
 * when it is displayed {}
 */
@NpmPackage(
		name = "@polymer/polymer",
		version = Polymer.VERSION
)
@Import(
		symbols = "IronOverlayBackdrop",
		module = "@polymer/iron-overlay-behavior/iron-overlay-backdrop.js"
)
public interface IronOverlayBackdropElement extends HTMLElement {
	/**
	 * Tagname string.
	 *
	 * @return the string
	 */
	static String TAGNAME() {
		return "iron-overlay-backdrop";
	}

	/**
	 * Returns true if the backdrop is opened.
	 *
	 * @return the boolean
	 */
	@JSProperty
	boolean isOpened();

	/**
	 * Returns true if the backdrop is opened.
	 *
	 * @param opened the opened
	 */
	@JSProperty
	void setOpened(boolean opened);

	/**
	 * Appends the backdrop to document body if needed.
	 */
	void prepare();

	/**
	 * Shows the backdrop.
	 */
	void open();

	/**
	 * Hides the backdrop.
	 */
	void close();

	/**
	 * Removes the backdrop from document body if needed.
	 */
	void complete();
}

Custom property	Description	Default
`--iron-overlay-backdrop-background-color`	Backdrop background * color	#000
`--iron-overlay-backdrop-opacity`	Backdrop opacity	0.6
`--iron-overlay-backdrop`	Mixin applied to `iron-overlay-backdrop`.	* {} *
`--iron-overlay-backdrop-opened`	Mixin applied to `iron-overlay-backdrop` * when it is displayed	{}