com.github.fluorumlabs.disconnect.polymer.elements.IronMediaQueryElement 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.cssom.MediaQueryList;
import js.web.dom.HTMLElement;
import org.teavm.jso.JSProperty;

import javax.annotation.Nullable;

/**
 * iron-media-query can be used to data bind to a CSS media query.
 * The query property is a bare CSS media query. The query-matches property is a boolean
 * representing whether the page matches that media query.
 * 
 * Example:
 *
 * 
<iron-media-query query="(min-width: 600px)" query-matches="{{
 * queryMatches}}">
 * </iron-media-query>
 * 
 */
@NpmPackage(
		name = "@polymer/polymer",
		version = Polymer.VERSION
)
@Import(
		symbols = "IronMediaQuery",
		module = "@polymer/iron-media-query/iron-media-query.js"
)
public interface IronMediaQueryElement extends HTMLElement {
	/**
	 * Tagname string.
	 *
	 * @return the string
	 */
	static String TAGNAME() {
		return "iron-media-query";
	}

	/**
	 * The Boolean return value of the media query.
	 *
	 * @return the boolean
	 */
	@JSProperty
	boolean isQueryMatches();

	/**
	 * The CSS media query to evaluate.
	 *
	 * @return the query
	 */
	@Nullable
	@JSProperty
	String getQuery();

	/**
	 * The CSS media query to evaluate.
	 *
	 * @param query the query
	 */
	@JSProperty
	void setQuery(String query);

	/**
	 * If true, the query attribute is assumed to be a complete media query string rather than a single media feature.
	 *
	 * @return the boolean
	 */
	@JSProperty
	boolean isFull();

	/**
	 * If true, the query attribute is assumed to be a complete media query string rather than a single media feature.
	 *
	 * @param full the full
	 */
	@JSProperty
	void setFull(boolean full);

	/**
	 * Query changed.
	 */
	void queryChanged();

	/**
	 * Query handler.
	 *
	 * @param mq the mq
	 */
	void queryHandler(MediaQueryList mq);
}