Uses of Interface
com.vaadin.flow.signals.Signal

Packages that use Signal

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.geolocation
com.vaadin.flow.component.internal
com.vaadin.flow.component.page
com.vaadin.flow.component.trigger	Server-side API for wiring client-side triggers (DOM events, shortcuts, …) to client-side actions (clipboard copy, set property, run JS, …) reading values from outputs, without a server round-trip when not needed.
com.vaadin.flow.dom
com.vaadin.flow.dom.impl
com.vaadin.flow.internal.nodefeature
com.vaadin.flow.server
com.vaadin.flow.signals
com.vaadin.flow.signals.impl
com.vaadin.flow.signals.local
com.vaadin.flow.signals.operations
com.vaadin.flow.signals.shared

Uses of Signal in com.vaadin.flow.component

Methods in com.vaadin.flow.component with type parameters of type Signal

Modifier and Type	Method	Description
default <V extends @Nullable Object, S extends Signal<V>> void	HasComponentsOfType.bindChildren(Signal<List<S>> list, SerializableFunction<S,T> childFactory)	Binds a list Signal to this component using a child component factory.

Methods in com.vaadin.flow.component that return Signal

Modifier and Type	Method	Description
Signal<Locale>	UI.localeSignal()	Gets a read-only signal that holds the current locale of this UI.
Signal<RouterState>	UI.routerStateSignal()	Gets a read-only signal that holds the current RouterState of this UI.

Methods in com.vaadin.flow.component with parameters of type Signal

Modifier and Type	Method	Description
SignalBinding<T>	SignalPropertySupport.bind(Signal<T> signal)	Binds a Signal's value to this property support.
default <V extends @Nullable Object, S extends Signal<V>> void	HasComponentsOfType.bindChildren(Signal<List<S>> list, SerializableFunction<S,T> childFactory)	Binds a list Signal to this component using a child component factory.
default SignalBinding<Boolean>	HasStyle.bindClassName(String className, Signal<Boolean> signal)	Binds the presence of the given CSS class name to a Signal.
default SignalBinding<List<String>>	HasStyle.bindClassNames(Signal<List<String>> names)	Binds the CSS class names of this component to a Signal.
default SignalBinding<Boolean>	HasEnabled.bindEnabled(Signal<Boolean> enabledSignal)	Binds a Signal's value to the enabled state of this component.
default SignalBinding<?>	HasSize.bindHeight(Signal<String> heightSignal)	Binds a Signal's value to the height of this component.
default SignalBinding<String>	HasHelper.bindHelperText(Signal<String> helperTextSignal)	Binds a signal's value to the component's helper text.
SignalBinding<String>	Html.bindHtmlContent(Signal<String> htmlSignal)	Binds a Signal's value to this component's HTML content (outer HTML).
default SignalBinding<String>	HasPlaceholder.bindPlaceholder(Signal<String> placeholderSignal)	Binds a signal's value to the component's placeholder.
default SignalBinding<Boolean>	HasValue.bindReadOnly(Signal<Boolean> readOnlySignal)	Binds a Signal's value to the read-only state of this component.
default SignalBinding<Boolean>	HasValueAndElement.bindReadOnly(Signal<Boolean> readOnlySignal)
default SignalBinding<Boolean>	HasValue.bindRequiredIndicatorVisible(Signal<Boolean> requiredSignal)	Binds a Signal's value to the required indicator visible state of this component.
default SignalBinding<Boolean>	HasValueAndElement.bindRequiredIndicatorVisible(Signal<Boolean> requiredSignal)
default SignalBinding<String>	HasText.bindText(Signal<String> textSignal)	Binds a Signal's value to the text content of this component.
default SignalBinding<Boolean>	HasTheme.bindThemeName(String name, Signal<Boolean> signal)	Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.
default SignalBinding<List<String>>	HasTheme.bindThemeNames(Signal<List<String>> names)	Binds the theme names of this component to a Signal so that the theme list is dynamically updated to match the signal's value.
SignalBinding<T>	AbstractCompositeField.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)
SignalBinding<T>	AbstractField.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)
default SignalBinding<V>	HasValue.bindValue(Signal<V> valueSignal, SerializableConsumer<V> writeCallback)	Binds a Signal's value to the value state of this component.
SignalBinding<Boolean>	Component.bindVisible(Signal<Boolean> visibleSignal)	Binds a Signal's value to the visible property of this component.
default SignalBinding<?>	HasSize.bindWidth(Signal<String> widthSignal)	Binds a Signal's value to the width of this component.

Constructors in com.vaadin.flow.component with parameters of type Signal

Modifier	Constructor	Description
	Html(Signal<String> htmlSignal)	Creates an instance based on the given HTML fragment signal.

Uses of Signal in com.vaadin.flow.component.geolocation

Methods in com.vaadin.flow.component.geolocation that return Signal

Modifier and Type	Method	Description
Signal<Boolean>	GeolocationWatcher.activeSignal()	Returns a read-only signal indicating whether the watcher is currently receiving updates.
static Signal<GeolocationAvailability>	Geolocation.availabilityHintSignal()	Returns a read-only signal hinting at whether geolocation is usable for the current UI.
static Signal<GeolocationAvailability>	Geolocation.availabilityHintSignal(UI ui)	Returns a read-only signal hinting at whether geolocation is usable for the given UI.
Signal<GeolocationResult>	GeolocationWatcher.positionSignal()	Returns a read-only signal that holds the most recent reading.

Uses of Signal in com.vaadin.flow.component.internal

Methods in com.vaadin.flow.component.internal that return Signal

Modifier and Type	Method	Description
Signal<RouterState>	UIInternals.getRouterStateSignal()	Gets the cached read-only Signal that holds the current RouterState for this UI.

Methods in com.vaadin.flow.component.internal with parameters of type Signal

Modifier and Type	Method	Description
SignalBinding<T>	AbstractFieldSupport.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)	Binds a Signal's value to the value state of the field and keeps the state synchronized with the signal value while the element is in attached state.

Uses of Signal in com.vaadin.flow.component.page

Methods in com.vaadin.flow.component.page that return Signal

Modifier and Type	Method	Description
Signal<PageVisibility>	Page.pageVisibilitySignal()	Returns a read-only signal that tracks the browser tab's visibility and focus state.
Signal<WindowSize>	Page.windowSizeSignal()	Returns a signal that tracks the current browser window size.

Uses of Signal in com.vaadin.flow.component.trigger

Methods in com.vaadin.flow.component.trigger that return Signal

Modifier and Type	Method	Description
Signal<T>	SignalOutput.getSignal()

Constructors in com.vaadin.flow.component.trigger with parameters of type Signal

Modifier	Constructor	Description
	SignalOutput(Class<T> valueType, Signal<T> signal)	Creates a signal-backed output.

Uses of Signal in com.vaadin.flow.dom

Methods in com.vaadin.flow.dom with type parameters of type Signal

Modifier and Type	Method	Description
static <T extends @Nullable Object, S extends Signal<T>> Registration	ElementEffect.bindChildren(Element parentElement, Signal<List<S>> list, SerializableFunction<S,Element> childFactory)	Binds a list signal containing child signals to a parent component using a child component factory.

Methods in com.vaadin.flow.dom with parameters of type Signal

Modifier and Type	Method	Description
default SignalBinding<List<String>>	ClassList.bind(Signal<List<String>> names)	Binds the class names to the provided signal.
default SignalBinding<Boolean>	ClassList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given class name to the provided signal.
static <T extends @Nullable Object> SignalBinding<T>	ElementEffect.bind(Element owner, Signal<T> signal, SerializableBiConsumer<Element,T> setter)	Binds a signal's value to a given owner element in a way defined in setter function and creates a Signal effect function executing the setter whenever the signal value changes.
default SignalBinding<String>	Style.bind(String name, Signal<String> signal)	Binds the given style property to the provided string signal.
default SignalBinding<List<String>>	ThemeList.bind(Signal<List<String>> names)	Binds the theme names to the provided signal so that the theme list is dynamically updated to match the signal's value.
default SignalBinding<Boolean>	ThemeList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.
SignalBinding<String>	Element.bindAttribute(String attribute, Signal<String> signal)	Binds a Signal's value to a given attribute.
SignalBinding<String>	ElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)	Binds the given signal to the given attribute.
static <T extends @Nullable Object, S extends Signal<T>> Registration	ElementEffect.bindChildren(Element parentElement, Signal<List<S>> list, SerializableFunction<S,Element> childFactory)	Binds a list signal containing child signals to a parent component using a child component factory.
SignalBinding<Boolean>	Element.bindEnabled(Signal<Boolean> enabledSignal)	Binds a Signal's value to the enabled state of this element.
<T extends @Nullable Object> SignalBinding<T>	Element.bindProperty(String name, Signal<T> signal, SerializableConsumer<T> writeCallback)	Binds a Signal's value to the given property.
SignalBinding<?>	ElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)	Binds the given signal to the given property.
SignalBinding<String>	Element.bindText(Signal<String> signal)	Binds a Signal's value to the text content of this element.
SignalBinding<Boolean>	Element.bindVisible(Signal<Boolean> visibleSignal)	Binds a Signal's value to the visible property of this element.
SignalBinding<Boolean>	ElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)	Binds the given signal to the visible property.

Uses of Signal in com.vaadin.flow.dom.impl

Methods in com.vaadin.flow.dom.impl with parameters of type Signal

Modifier and Type	Method	Description
SignalBinding<String>	BasicElementStyle.bind(String name, Signal<String> signal)
SignalBinding<List<String>>	ImmutableClassList.bind(Signal<List<String>> names)	Binds the class names to the provided signal.
SignalBinding<Boolean>	ImmutableClassList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given class name to the provided signal.
SignalBinding<String>	ImmutableEmptyStyle.bind(String name, Signal<String> signal)	Binds the given style property to the provided string signal.
SignalBinding<List<String>>	ThemeListImpl.bind(Signal<List<String>> names)
SignalBinding<Boolean>	ThemeListImpl.bind(String name, Signal<Boolean> signal)
SignalBinding<String>	AbstractTextElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
SignalBinding<String>	BasicElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
SignalBinding<String>	ShadowRootStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
SignalBinding<?>	AbstractTextElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
SignalBinding<?>	BasicElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
SignalBinding<?>	ShadowRootStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
SignalBinding<Boolean>	AbstractTextElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)
SignalBinding<Boolean>	BasicElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)
SignalBinding<Boolean>	ShadowRootStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)

Uses of Signal in com.vaadin.flow.internal.nodefeature

Methods in com.vaadin.flow.internal.nodefeature that return Signal

Modifier and Type	Method	Description
<T extends @Nullable Object> @Nullable Signal<T>	SignalBindingFeature.getSignal(String key)	Gets the signal bound to the given key.
Signal<?>	NodeMap.InternalSignalBinding.signal()	Returns the value of the signal record component.

Methods in com.vaadin.flow.internal.nodefeature with parameters of type Signal

Modifier and Type	Method	Description
<T> SignalBinding<T>	AbstractPropertyMap.bindSignal(Element owner, String name, Signal<T> signal, SerializableConsumer<?> writeCallback)	Binds the given signal to the given property with a write callback.
SignalBinding<String>	ElementAttributeMap.bindSignal(Element owner, String attribute, Signal<String> signal)	Binds the given signal to the given attribute.
protected <T extends @Nullable Object> SignalBinding<T>	NodeMap.bindSignal(Element owner, String key, Signal<T> signal, SerializableBiConsumer<Element,T> setter, SerializableConsumer<?> writeCallback)	Binds a signal to a given key using a setter function and stores the writeCallback in SignalBindingFeature.
SignalBinding<Boolean>	ElementData.bindVisibleSignal(Element owner, Signal<Boolean> signal)	Binds the given signal to the visible property.
void	SignalBindingFeature.setBinding(String key, Signal<?> signal)	Sets a binding for the given key.
void	SignalBindingFeature.setBinding(String key, Signal<?> signal, @Nullable SerializableConsumer<?> writeCallback)	Sets a binding for the given key with a write callback.

Constructors in com.vaadin.flow.internal.nodefeature with parameters of type Signal

Modifier	Constructor	Description
	InternalSignalBinding(Signal<?> signal, Serializable value, SerializableConsumer<?> writeCallback)	Creates an instance of a InternalSignalBinding record class.

Uses of Signal in com.vaadin.flow.server

Methods in com.vaadin.flow.server that return Signal

Modifier and Type	Method	Description
Signal<Locale>	VaadinSession.localeSignal()	Gets a read-only signal that holds the current locale of this session.

Uses of Signal in com.vaadin.flow.signals

Methods in com.vaadin.flow.signals that return Signal

Modifier and Type	Method	Description
static <T extends @Nullable Object> Signal<T>	Signal.cached(Signal<T> innerSignal)	Creates a new cached signal based on the given inner signal.
static <T extends @Nullable Object> Signal<T>	Signal.computed(SignalComputation<T> computation)	Creates a new computed signal with the given computation callback.
default <C extends @Nullable Object> Signal<C>	Signal.map(SignalMapper<T,C> mapper)	Creates a simple computed signal based on a mapper function that is passed the value of this signal.
static Signal<Boolean>	Signal.not(Signal<Boolean> signal)	Creates a new computed signal containing the negation of the provided boolean-valued signal.

Methods in com.vaadin.flow.signals with parameters of type Signal

Modifier and Type	Method	Description
static <T extends @Nullable Object> Signal<T>	Signal.cached(Signal<T> innerSignal)	Creates a new cached signal based on the given inner signal.
static Signal<Boolean>	Signal.not(Signal<Boolean> signal)	Creates a new computed signal containing the negation of the provided boolean-valued signal.

Uses of Signal in com.vaadin.flow.signals.impl

Classes in com.vaadin.flow.signals.impl that implement Signal

Modifier and Type	Class	Description
class	CachedSignal<T extends @Nullable Object>	A signal that caches the value of an inner signal.

Constructors in com.vaadin.flow.signals.impl with parameters of type Signal

Modifier	Constructor	Description
	CachedSignal(Signal<T> inner)	Creates a new cached signal with the provided inner signal.

Uses of Signal in com.vaadin.flow.signals.local

Classes in com.vaadin.flow.signals.local that implement Signal

Modifier and Type	Class	Description
class	AbstractLocalSignal<T extends @Nullable Object>	Base class for local signals providing shared listener notification, usage tracking, and value access logic.
class	ListSignal<T extends @Nullable Object>	A local list signal that holds a list of writable signals, enabling per-entry reactivity.
class	ValueSignal<T extends @Nullable Object>	A local writable signal that holds a reference to an object.

Methods in com.vaadin.flow.signals.local that return Signal

Modifier and Type	Method	Description
Signal<T>	ValueSignal.asReadonly()	Wraps this signal to not accept changes.

Uses of Signal in com.vaadin.flow.signals.operations

Classes in com.vaadin.flow.signals.operations with type parameters of type Signal

Modifier and Type	Class	Description
class	BulkInsertOperation<T extends Signal<?>>	An operation that inserts multiple child signals into a list as a single atomic batch.
class	InsertOperation<T extends Signal<?>>	An operation that inserts a new child signal into a list or map.
final record	PutIfAbsentResult<S extends Signal<?>>	The result of a put-if-absent operation.

Uses of Signal in com.vaadin.flow.signals.shared

Classes in com.vaadin.flow.signals.shared that implement Signal

Modifier and Type	Class	Description
class	AbstractSharedSignal<T extends @Nullable Object>	Base type for full-featured signals that are backed by a transactional signal tree.
class	SharedListSignal<T extends @Nullable Object>	A signal containing a list of values.
class	SharedMapSignal<T extends @Nullable Object>	A signal containing a map of values with string keys.
class	SharedNodeSignal	A signal representing a node in a tree structure.
class	SharedNumberSignal	A signal containing a numeric value.
class	SharedValueSignal<T extends @Nullable Object>	A signal containing a value.

Methods in com.vaadin.flow.signals.shared that return Signal

Modifier and Type	Method	Description
<C> Signal<C>	SharedNumberSignal.mapIntValue(SerializableIntFunction<C> mapper)	Creates a computed signal based on an integer mapper function that is passed the value of this signal.