com.github.fluorumlabs.disconnect.polymer.elements.IronA11yAnnouncerElement 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;

import javax.annotation.Nullable;

/**
 * The interface Iron a 11 y announcer element.
 */
@NpmPackage(
		name = "@polymer/polymer",
		version = Polymer.VERSION
)
@Import(
		symbols = "IronA11yAnnouncer",
		module = "@polymer/iron-a11y-announcer/iron-a11y-announcer.js"
)
public interface IronA11yAnnouncerElement extends HTMLElement {
	/**
	 * Tagname string.
	 *
	 * @return the string
	 */
	static String TAGNAME() {
		return "iron-a11y-announcer";
	}

	/**
	 * The value of mode is used to set the aria-live attribute for the element that will be announced.
	 * Valid values are: off,
	 * polite and assertive.
	 *
	 * @return the mode
	 */
	@Nullable
	@JSProperty
	String getMode();

	/**
	 * The value of mode is used to set the aria-live attribute for the element that will be announced.
	 * Valid values are: off,
	 * polite and assertive.
	 *
	 * @param mode the mode
	 */
	@JSProperty
	void setMode(String mode);

	/**
	 * Cause a text string to be announced by screen readers.
	 *
	 * @param text The text that should be announced.
	 */
	void announce(String text);
}