com.github.fluorumlabs.disconnect.vaadin.ProgressBar Maven / Gradle / Ivy

Go to download

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

Vaadin components bindings for Disconnect Zero

The newest version!

package com.github.fluorumlabs.disconnect.vaadin;

import com.github.fluorumlabs.disconnect.core.annotations.WebComponent;
import com.github.fluorumlabs.disconnect.vaadin.elements.ProgressBarElement;
import com.github.fluorumlabs.disconnect.vaadin.mixins.HasProgressMixin;
import com.github.fluorumlabs.disconnect.vaadin.mixins.HasThemableMixin;
import com.github.fluorumlabs.disconnect.vaadin.types.ThemeVariant;
import com.github.fluorumlabs.disconnect.zero.component.AbstractComponent;
import com.github.fluorumlabs.disconnect.zero.component.Component;
import com.github.fluorumlabs.disconnect.zero.component.HasComponents;
import com.github.fluorumlabs.disconnect.zero.component.HasStyle;
import js.extras.JsEnum;

/**
 * <vaadin-progress-bar> is a Web Component for progress bars.
 *
 * <vaadin-progress-bar min="0" max="1" value="0.5"
 * >
 * </vaadin-progress-bar>
 * 
 * Styling
 * The following shadow DOM parts are available for styling:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Part name Description
bar Progress-bar's background
value Progress-bar's foreground
 * See
 * ThemableMixin – how to apply styles for shadow parts
 * 
 * The following custom properties are available:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Custom property Description Default
--vaadin-progress-value current progress value (between 0 and 1) 0
 * The following state attributes are available for styling:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Attribute Description Part name
indeterminate Set to an indeterminate progress bar :host
 */
@WebComponent
public class ProgressBar extends AbstractComponent
		implements HasProgressMixin,
		HasThemableMixin,
		HasStyle, HasComponents> {
	public ProgressBar() {
		super(ProgressBarElement.TAGNAME());
	}

	public abstract static class Variant extends ThemeVariant {
		public static final Variant CONTRAST = JsEnum.of("contrast");
		public static final Variant ERROR = JsEnum.of("error");
		public static final Variant SUCCESS = JsEnum.of("success");
	}

}

Part name	Description
`bar`	Progress-bar's background
`value`	Progress-bar's foreground