#![cfg(feature = "a11y")]
use crate::extension::{
LexicalEditorWithDispose, build_editor_from_extensions, get_extension_dependency_from_editor,
};
use crate::rich_text::{
HeadingAnnounceExtensionConfigOverrides, HeadingAnnounceOutput, HeadingTagType,
create_heading_node, heading_announce_extension, rich_text_extension,
};
use crate::upstream_tests::lexical_a11y::support::{Body, mount_root};
use crate::upstream_tests::support::update;
use crate::{
AnyLexicalExtensionArgument, LexicalExtension, config_extension, create_text_node,
define_extension, get_root,
};
fn build(dependencies: Vec<AnyLexicalExtensionArgument>) -> LexicalEditorWithDispose {
build_editor_from_extensions([define_extension(LexicalExtension {
dependencies,
..LexicalExtension::<(), (), ()>::new("[root]", ())
})
.into()])
.unwrap()
}
fn build_rich_text() -> LexicalEditorWithDispose {
build(vec![rich_text_extension().into()])
}
fn read_live_region(body: &Body) -> String {
body.read_live_region().replace('\u{200B}', "")
}
fn add_heading(editor: &LexicalEditorWithDispose, tag: HeadingTagType, text: &'static str) {
update(editor, move || {
let heading = create_heading_node(tag);
heading.append(&[create_text_node(text)])?;
get_root().append(&[heading])
});
}
fn remove_last_block(editor: &LexicalEditorWithDispose) {
update(editor, || {
if let Some(last) = get_root().get_last_child() {
last.remove(false)?;
}
Ok(())
});
}
fn output(editor: &LexicalEditorWithDispose) -> HeadingAnnounceOutput {
(*get_extension_dependency_from_editor(editor, &heading_announce_extension())
.unwrap()
.output
.expect("HeadingAnnounceExtension has a build"))
.clone()
}
#[test]
fn announces_every_heading_level_as_it_is_created() {
let editor = build_rich_text();
let body = mount_root(&editor);
for (tag, level) in [
(HeadingTagType::H1, 1),
(HeadingTagType::H2, 2),
(HeadingTagType::H3, 3),
(HeadingTagType::H4, 4),
(HeadingTagType::H5, 5),
(HeadingTagType::H6, 6),
] {
add_heading(&editor, tag, "Title");
assert_eq!(read_live_region(&body), format!("Heading level {level}"));
}
editor.dispose();
}
#[test]
fn announces_the_level_a_heading_had_when_it_is_removed() {
let editor = build_rich_text();
let body = mount_root(&editor);
add_heading(&editor, HeadingTagType::H2, "Title");
assert_eq!(read_live_region(&body), "Heading level 2");
remove_last_block(&editor);
assert_eq!(read_live_region(&body), "Heading level 2 removed");
editor.dispose();
}
#[test]
fn stays_silent_while_editing_inside_a_heading() {
let editor = build_rich_text();
let body = mount_root(&editor);
add_heading(&editor, HeadingTagType::H3, "Before");
assert_eq!(read_live_region(&body), "Heading level 3");
let before = body.read_live_region();
update(&editor, || {
let heading = get_root().get_first_child().unwrap();
heading.select_end()?.insert_text(" and after")
});
assert_eq!(body.read_live_region(), before);
editor.dispose();
}
#[test]
fn announces_the_new_level_when_a_heading_changes_level() {
let editor = build_rich_text();
let body = mount_root(&editor);
for (tag, expected) in [
(HeadingTagType::H1, "Heading level 1"),
(HeadingTagType::H2, "Heading level 2"),
] {
update(&editor, move || {
let root = get_root();
root.clear()?;
root.append(&[create_heading_node(tag)])
});
assert_eq!(read_live_region(&body), expected);
}
editor.dispose();
}
#[test]
fn respects_message_overrides_from_config_extension() {
let editor = build(vec![
config_extension(
&heading_announce_extension(),
[HeadingAnnounceExtensionConfigOverrides {
created: Some("Now an H%s".to_owned()),
destroyed: Some("H%s gone".to_owned()),
..Default::default()
}],
),
rich_text_extension().into(),
]);
let body = mount_root(&editor);
add_heading(&editor, HeadingTagType::H4, "Title");
assert_eq!(read_live_region(&body), "Now an H4");
remove_last_block(&editor);
assert_eq!(read_live_region(&body), "H4 gone");
editor.dispose();
}
#[test]
fn reflects_message_signal_changes_at_runtime() {
let editor = build_rich_text();
let body = mount_root(&editor);
output(&editor)
.created
.set_value("Section, depth %s".to_owned());
add_heading(&editor, HeadingTagType::H2, "Title");
assert_eq!(read_live_region(&body), "Section, depth 2");
editor.dispose();
}
#[test]
fn does_not_announce_while_disabled_and_resumes_when_re_enabled() {
let editor = build_rich_text();
let body = mount_root(&editor);
let disabled = output(&editor).disabled;
disabled.set_value(true);
add_heading(&editor, HeadingTagType::H1, "Title");
assert_eq!(read_live_region(&body), "");
disabled.set_value(false);
add_heading(&editor, HeadingTagType::H2, "Title");
assert_eq!(read_live_region(&body), "Heading level 2");
editor.dispose();
}
#[cfg(feature = "plain-text")]
#[test]
fn leaves_a_plain_text_editor_alone() {
let editor = build(vec![
crate::a11y::aria_live_region_extension().into(),
crate::plain_text::plain_text_extension().into(),
]);
let body = mount_root(&editor);
update(&editor, || {
get_root().append(&[crate::create_paragraph_node()])
});
assert_eq!(read_live_region(&body), "");
editor.dispose();
}