Announcer

Audible accessibility announcements

Announcer is a mixin interface which can be added to component when audible notification is needed for accessibility purposes. The add-on is re-using the audible announcement part of the Lumo design system. There is a debouncer in the announcer, which should make this add-on behave well together with the Vaadin components using the same facility.

Sample code

@Route("")
public class View extends VerticalLayout
        implements Announcer, AfterNavigationObserver {

    public View() {
        var button = new Button("Click me", e -> announce("Button clicked",
                AnnouncementMode.ASSERTIVE, 1000));
        add(new Paragraph("Inspect the page to see the announcement"), button);
    }

    @Override
    public void afterNavigation(AfterNavigationEvent event) {
        announce("View navigated");
    }
}

Links

Compatibility