You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by hn...@apache.org on 2023/05/10 18:42:21 UTC
[myfaces-tobago] 02/03: fix: dropdown key events
This is an automated email from the ASF dual-hosted git repository.
hnoeth pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/myfaces-tobago.git
commit 070e9a61f61778d56da56029887607e5cdc47a07
Author: Henning Noeth <hn...@apache.org>
AuthorDate: Tue Apr 18 10:02:11 2023 +0200
fix: dropdown key events
* reimplement dropdown key and click events, because bootstrap implementation didn't support sub-menus.
* fix css style: sub-menus are now positioned correctly for keyboard
* increased clickable area for checkbox/radio button label
* use .tobago-dropdown-menu instead of .dropdown-menu to prevent Bootstrap from creating a dropdown instance
* dropdown menu stays open if clicked on checkbox/radio button
* fix: disabled sub-menus are not opened anymore
* adjust tests
* add integration test
Issue: TOBAGO-2205
---
.../renderkit/renderer/CommandRendererBase.java | 11 +-
.../renderer/buttons/separator-inside-buttons.html | 6 +-
.../renderer/in/input-group-dropdown-after.html | 6 +-
.../renderer/in/input-group-dropdown-before.html | 6 +-
.../resources/renderer/link/booleanInsideLink.html | 6 +-
.../resources/renderer/link/manyInsideLink.html | 4 +-
.../resources/renderer/link/radioInsideLink.html | 6 +-
.../renderer/link/separatorInsideLink.html | 6 +-
.../renderer/links/link-inside-links-sub.html | 4 +-
.../content/010-input/50-input-group/Group.test.js | 2 +-
.../main/webapp/content/060-popup/Popup.test.js | 4 +-
.../4050-ajax-dropdown/Ajax_Dropdown.test.js | 2 +-
.../900-test/4000-button-link/Button_Link.test.js | 4 +-
.../900-test/4200-dropdown/Dropdown.test.js | 134 +++++++++++
.../content/900-test/4200-dropdown/Dropdown.xhtml | 112 ++++++++++
.../900-test/6500-behavior/Behavior.test.js | 6 +-
.../src/main/webapp/script/tobago-test.js | 21 +-
tobago-theme/src/main/scss/_tobago.scss | 55 +++--
.../src/main/ts/tobago-css.ts | 4 +
.../src/main/ts/tobago-dropdown-item-factory.ts | 44 ++++
.../src/main/ts/tobago-dropdown-item.ts | 93 ++++++++
.../src/main/ts/tobago-dropdown.ts | 246 ++++++++++++++++++++-
.../src/main/ts/tobago-key.ts | 2 +
23 files changed, 716 insertions(+), 68 deletions(-)
diff --git a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/renderkit/renderer/CommandRendererBase.java b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/renderkit/renderer/CommandRendererBase.java
index db358df9c1..dfdb97021e 100644
--- a/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/renderkit/renderer/CommandRendererBase.java
+++ b/tobago-core/src/main/java/org/apache/myfaces/tobago/internal/renderkit/renderer/CommandRendererBase.java
@@ -114,7 +114,6 @@ public abstract class CommandRendererBase<T extends AbstractUICommand> extends D
HtmlRendererUtils.writeDataAttributes(facesContext, writer, component);
if (parentOfCommands) {
- writer.writeAttribute(DataAttributes.BS_TOGGLE, "dropdown", false);
writer.writeAttribute(Arias.EXPANDED, Boolean.FALSE.toString(), false);
}
final String title = HtmlRendererUtils.getTitleFromTipAndMessages(facesContext, component);
@@ -175,6 +174,9 @@ public abstract class CommandRendererBase<T extends AbstractUICommand> extends D
@Override
public void encodeChildrenInternal(final FacesContext facesContext, final T component) throws IOException {
final boolean parentOfCommands = component.isParentOfCommands();
+ final boolean isInsideInputAfter = isInside(facesContext, HtmlElements.TOBAGO_IN)
+ && isInside(facesContext, Facets.after);
+ final boolean disabled = component.isDisabled();
final TobagoResponseWriter writer = getResponseWriter(facesContext);
@@ -182,9 +184,10 @@ public abstract class CommandRendererBase<T extends AbstractUICommand> extends D
List<UIComponent> renderLater = null;
writer.startElement(HtmlElements.DIV);
- writer.writeClassAttribute(BootstrapClass.DROPDOWN_MENU,
- isInside(facesContext, HtmlElements.TOBAGO_IN) && isInside(facesContext, Facets.after)
- ? BootstrapClass.DROPDOWN_MENU_END : null);
+ writer.writeClassAttribute(
+ TobagoClass.DROPDOWN__MENU,
+ isInsideInputAfter ? BootstrapClass.DROPDOWN_MENU_END : null,
+ disabled ? TobagoClass.DISABLED : null);
writer.writeAttribute(Arias.LABELLEDBY, component.getFieldId(facesContext), false);
writer.writeAttribute(HtmlAttributes.NAME, component.getClientId(facesContext), false);
diff --git a/tobago-core/src/test/resources/renderer/buttons/separator-inside-buttons.html b/tobago-core/src/test/resources/renderer/buttons/separator-inside-buttons.html
index 0ff3ec6cbb..4df742b525 100644
--- a/tobago-core/src/test/resources/renderer/buttons/separator-inside-buttons.html
+++ b/tobago-core/src/test/resources/renderer/buttons/separator-inside-buttons.html
@@ -19,8 +19,8 @@ CSS class of "tobago-dropdown" has changed from btn-group to dropdown
-->
<tobago-buttons id='list' class='btn-group tobago-auto-spacing' role='group'>
<tobago-dropdown id='id' class='dropdown btn-group'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>button</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>button</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<button type='button' id='sub1' name='sub1' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='sub1'></tobago-behavior><span>sub1</span></button>
<tobago-separator id='separator1' class='dropdown-divider'>
</tobago-separator>
@@ -30,4 +30,4 @@ CSS class of "tobago-dropdown" has changed from btn-group to dropdown
<button type='button' id='sub3' name='sub3' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='sub3'></tobago-behavior><span>sub3</span></button>
</div>
</tobago-dropdown>
-</tobago-buttons>
\ No newline at end of file
+</tobago-buttons>
diff --git a/tobago-core/src/test/resources/renderer/in/input-group-dropdown-after.html b/tobago-core/src/test/resources/renderer/in/input-group-dropdown-after.html
index f20e9927ac..f63407d2e4 100644
--- a/tobago-core/src/test/resources/renderer/in/input-group-dropdown-after.html
+++ b/tobago-core/src/test/resources/renderer/in/input-group-dropdown-after.html
@@ -21,11 +21,11 @@ dropdown-menu-right is temporarily not here (in the div with dropdown-menu), XXX
<div class='input-group'>
<input type='text' name='id' id='id::field' class='form-control'>
<tobago-dropdown id='button' class='dropdown'>
- <button type='button' id='button::command' name='button' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='button' field-id='button::command' omit='omit'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu dropdown-menu-end' aria-labelledby='button::command' name='button'>
+ <button type='button' id='button::command' name='button' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='button' field-id='button::command' omit='omit'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu dropdown-menu-end' aria-labelledby='button::command' name='button'>
<button type='button' id='l1' name='l1' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='l1'></tobago-behavior><span>Link 1</span></button>
<button type='button' id='l2' name='l2' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='l2'></tobago-behavior><span>Link 2</span></button>
</div>
</tobago-dropdown>
</div>
-</tobago-in>
\ No newline at end of file
+</tobago-in>
diff --git a/tobago-core/src/test/resources/renderer/in/input-group-dropdown-before.html b/tobago-core/src/test/resources/renderer/in/input-group-dropdown-before.html
index 06d7ca08c8..2a4964f93f 100644
--- a/tobago-core/src/test/resources/renderer/in/input-group-dropdown-before.html
+++ b/tobago-core/src/test/resources/renderer/in/input-group-dropdown-before.html
@@ -18,12 +18,12 @@
<tobago-in id='id' class='tobago-auto-spacing'>
<div class='input-group'>
<tobago-dropdown id='button' class='dropdown'>
- <button type='button' id='button::command' name='button' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='button' field-id='button::command' omit='omit'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu' aria-labelledby='button::command' name='button'>
+ <button type='button' id='button::command' name='button' aria-expanded='false' class='tobago-button btn btn-secondary dropdown-toggle'><tobago-behavior event='click' client-id='button' field-id='button::command' omit='omit'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='button::command' name='button'>
<button type='button' id='l1' name='l1' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='l1'></tobago-behavior><span>Link 1</span></button>
<button type='button' id='l2' name='l2' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='l2'></tobago-behavior><span>Link 2</span></button>
</div>
</tobago-dropdown>
<input type='text' name='id' id='id::field' class='form-control'>
</div>
-</tobago-in>
\ No newline at end of file
+</tobago-in>
diff --git a/tobago-core/src/test/resources/renderer/link/booleanInsideLink.html b/tobago-core/src/test/resources/renderer/link/booleanInsideLink.html
index d5b478e14e..dba64a9bfc 100644
--- a/tobago-core/src/test/resources/renderer/link/booleanInsideLink.html
+++ b/tobago-core/src/test/resources/renderer/link/booleanInsideLink.html
@@ -16,11 +16,11 @@
-->
<tobago-dropdown id='id' class='dropdown'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<tobago-select-boolean-checkbox id='id' class='form-check dropdown-item'>
<input class='form-check-input' type='checkbox' value='true' name='id' id='id::field'>
<label class='form-check-label' for='id::field'></label>
</tobago-select-boolean-checkbox>
</div>
-</tobago-dropdown>
\ No newline at end of file
+</tobago-dropdown>
diff --git a/tobago-core/src/test/resources/renderer/link/manyInsideLink.html b/tobago-core/src/test/resources/renderer/link/manyInsideLink.html
index 0a369e7294..c094e6f0f6 100644
--- a/tobago-core/src/test/resources/renderer/link/manyInsideLink.html
+++ b/tobago-core/src/test/resources/renderer/link/manyInsideLink.html
@@ -16,8 +16,8 @@
-->
<tobago-dropdown id='id' class='dropdown'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<tobago-select-many-checkbox>
<div class='form-check dropdown-item'>
<input class='form-check-input' type='checkbox' name='many' id='many::0' value=''>
diff --git a/tobago-core/src/test/resources/renderer/link/radioInsideLink.html b/tobago-core/src/test/resources/renderer/link/radioInsideLink.html
index 54df9b55a4..ae114eb9bd 100644
--- a/tobago-core/src/test/resources/renderer/link/radioInsideLink.html
+++ b/tobago-core/src/test/resources/renderer/link/radioInsideLink.html
@@ -16,8 +16,8 @@
-->
<tobago-dropdown id='id' class='dropdown'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<tobago-select-one-radio>
<div class='form-check dropdown-item'>
<input class='form-check-input' type='radio' checked='checked' name='radio' id='radio::0' value=''>
@@ -29,4 +29,4 @@
</div>
</tobago-select-one-radio>
</div>
-</tobago-dropdown>
\ No newline at end of file
+</tobago-dropdown>
diff --git a/tobago-core/src/test/resources/renderer/link/separatorInsideLink.html b/tobago-core/src/test/resources/renderer/link/separatorInsideLink.html
index ef60ef708b..ea88b39247 100644
--- a/tobago-core/src/test/resources/renderer/link/separatorInsideLink.html
+++ b/tobago-core/src/test/resources/renderer/link/separatorInsideLink.html
@@ -16,11 +16,11 @@
-->
<tobago-dropdown id='id' class='dropdown'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-link btn btn-link tobago-auto-spacing dropdown-toggle'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>dropdown</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<a id='link1' name='link1' href='https://www.apache.org/' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='link1' omit='omit'></tobago-behavior><span>Link 1</span></a>
<tobago-separator id='separator' class='dropdown-divider'>
</tobago-separator>
<a id='link2' name='link2' href='https://www.apache.org/' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='link2' omit='omit'></tobago-behavior><span>Link 2</span></a>
</div>
-</tobago-dropdown>
\ No newline at end of file
+</tobago-dropdown>
diff --git a/tobago-core/src/test/resources/renderer/links/link-inside-links-sub.html b/tobago-core/src/test/resources/renderer/links/link-inside-links-sub.html
index ed111248ae..d41754f7cc 100644
--- a/tobago-core/src/test/resources/renderer/links/link-inside-links-sub.html
+++ b/tobago-core/src/test/resources/renderer/links/link-inside-links-sub.html
@@ -21,8 +21,8 @@ CSS class nav-item has moved from "tobago-dropdown" to "li"
<ul class='nav'>
<li class='nav-item'>
<tobago-dropdown id='id' class='dropdown'>
- <button type='button' id='id::command' name='id' data-bs-toggle='dropdown' aria-expanded='false' class='tobago-link btn btn-link dropdown-toggle nav-link'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>apache</span></button>
- <div class='dropdown-menu' aria-labelledby='id::command' name='id'>
+ <button type='button' id='id::command' name='id' aria-expanded='false' class='tobago-link btn btn-link dropdown-toggle nav-link'><tobago-behavior event='click' client-id='id' field-id='id::command'></tobago-behavior><span>apache</span></button>
+ <div class='tobago-dropdown-menu' aria-labelledby='id::command' name='id'>
<a id='sub' name='sub' href='https://www.apache.org/' class='tobago-link dropdown-item'><tobago-behavior event='click' client-id='sub' omit='omit'></tobago-behavior><span>sub</span></a>
</div>
</tobago-dropdown>
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/010-input/50-input-group/Group.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/010-input/50-input-group/Group.test.js
index 5e78555902..6572e77f5a 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/content/010-input/50-input-group/Group.test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/010-input/50-input-group/Group.test.js
@@ -37,7 +37,7 @@ it("ajax: chat send button", function (done) {
it("ajax: dropdown button", function (done) {
let buttonFn = querySelectorFn("#page\\:mainForm\\:lsendtoc\\:\\:command");
let buttonLabelFn = querySelectorFn("#page\\:mainForm\\:lsendtoc\\:\\:command span");
- let dropdownMenu = querySelectorFn(".dropdown-menu[name='page:mainForm:lsendtoc']");
+ let dropdownMenu = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:lsendtoc']");
let sendToPeterFn = querySelectorFn("#page\\:mainForm\\:sendToPeter");
let sendToBobFn = querySelectorFn("#page\\:mainForm\\:sendToBob");
let sendToAllFn = querySelectorFn("#page\\:mainForm\\:sendToAll");
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/060-popup/Popup.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/060-popup/Popup.test.js
index 7725c3b58e..1ca7dfc5a6 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/content/060-popup/Popup.test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/060-popup/Popup.test.js
@@ -224,7 +224,7 @@ it("Open 'Client Popup', press 'Submit & Close' while field has content.", funct
it("Open 'Large Popup'.", function (done) {
let dropdownButtonFn = elementByIdFn("page:mainForm:dropdownButton::command");
- let dropdownMenuFn = querySelectorFn(".dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
+ let dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
let openButtonFn = elementByIdFn("page:mainForm:largePopupLink");
let popupFn = elementByIdFn("page:mainForm:largePopup");
let collapseFn = elementByIdFn("page:mainForm:largePopup::collapse");
@@ -264,7 +264,7 @@ it("Open 'Large Popup'.", function (done) {
it("Open 'Small Popup'.", function (done) {
let dropdownButtonFn = elementByIdFn("page:mainForm:dropdownButton::command");
- let dropdownMenuFn = querySelectorFn(".dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
+ let dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
let openButtonFn = elementByIdFn("page:mainForm:smallPopupLink");
let popupFn = elementByIdFn("page:mainForm:smallPopup");
let collapseFn = elementByIdFn("page:mainForm:smallPopup::collapse");
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/4050-ajax-dropdown/Ajax_Dropdown.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/4050-ajax-dropdown/Ajax_Dropdown.test.js
index 897e1d6cb3..3a9ade6194 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/4050-ajax-dropdown/Ajax_Dropdown.test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/4050-ajax-dropdown/Ajax_Dropdown.test.js
@@ -20,7 +20,7 @@ import {elementByIdFn, querySelectorAllFn, querySelectorFn} from "/script/tobago
it("Execute 'AJAX' entry in dropdown menu", function (done) {
let dropdownButtonFn = elementByIdFn("page:mainForm:dropdownButton::command");
- let dropdownMenuFn = querySelectorFn(".dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
+ let dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name=page\\:mainForm\\:dropdownButton]");
let dropdownAjaxEntryFn = elementByIdFn("page:mainForm:ajaxEntry");
let inputFn = elementByIdFn("page:mainForm:inputAjax::field");
let outputFn = querySelectorFn("#page\\:mainForm\\:outputAjax .form-control-plaintext");
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/Button_Link.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/Button_Link.test.js
index dc29061012..f92c9a47c1 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/Button_Link.test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4000-button-link/Button_Link.test.js
@@ -115,8 +115,8 @@ function getTargetFrameInput() {
}
it("Style must not be a dropdown item", function (done) {
- const dropdownMenuFn = querySelectorFn("#page\\:mainForm\\:dropdownWithStyle .dropdown-menu");
- const styleAsItemFn = querySelectorFn("#page\\:mainForm\\:dropdownWithStyle .dropdown-menu .dropdown-item > style");
+ const dropdownMenuFn = querySelectorFn("#page\\:mainForm\\:dropdownWithStyle .tobago-dropdown-menu");
+ const styleAsItemFn = querySelectorFn("#page\\:mainForm\\:dropdownWithStyle .tobago-dropdown-menu .dropdown-item > style");
const buttonFn = elementByIdFn("page:mainForm:dropdownWithStyle::command");
const test = new JasmineTestTool(done);
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.test.js
new file mode 100644
index 0000000000..b8f47abb74
--- /dev/null
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.test.js
@@ -0,0 +1,134 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {activeElementFn, elementByIdFn, querySelectorFn} from "/script/tobago-test.js";
+import {JasmineTestTool} from "/tobago/test/tobago-test-tool.js";
+
+it("Dropdown key events", function (done) {
+ const toggleButtonFn = elementByIdFn("page:mainForm:root::command");
+ const dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:root']");
+ const entry1Fn = elementByIdFn("page:mainForm:entry1");
+ const checkboxFn = elementByIdFn("page:mainForm:checkbox::field");
+ const toggleFn = elementByIdFn("page:mainForm:toggle::field");
+ const radioSunFn = elementByIdFn("page:mainForm:radio::0");
+ const radioMoonFn = elementByIdFn("page:mainForm:radio::1");
+ const multiCheckboxFn = elementByIdFn("page:mainForm:multiCheckbox::0");
+ const entry2Fn = elementByIdFn("page:mainForm:entry2");
+ const entry3Fn = elementByIdFn("page:mainForm:entry3::command");
+ const entry3DropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:entry3']");
+ const subFn = elementByIdFn("page:mainForm:sub::command");
+ const subDropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:sub']");
+ const link311Fn = elementByIdFn("page:mainForm:link311");
+ const link312Fn = elementByIdFn("page:mainForm:link312::command");
+ const link312DropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:link312']");
+ const link313Fn = elementByIdFn("page:mainForm:link313");
+
+ const test = new JasmineTestTool(done);
+ test.setup(() => !dropdownMenuFn().classList.contains("show"), null, "click", toggleButtonFn);
+ test.setup(() => activeElementFn() === toggleButtonFn(), null, "focus", toggleButtonFn);
+ test.do(() => expect(dropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => expect(dropdownMenuFn().parentElement.tagName).toEqual("TOBAGO-DROPDOWN"));
+ test.do(() => expect(activeElementFn()).toEqual(toggleButtonFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => dropdownMenuFn().classList.contains("show"));
+ test.do(() => expect(dropdownMenuFn().classList).toContain("show"));
+ test.do(() => expect(dropdownMenuFn().parentElement.classList).toContain("tobago-page-menuStore"));
+ test.do(() => expect(activeElementFn()).toEqual(entry1Fn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === checkboxFn());
+ test.do(() => expect(activeElementFn()).toEqual(checkboxFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === toggleFn());
+ test.do(() => expect(activeElementFn()).toEqual(toggleFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === radioSunFn());
+ test.do(() => expect(activeElementFn()).toEqual(radioSunFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === radioMoonFn());
+ test.do(() => expect(activeElementFn()).toEqual(radioMoonFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === multiCheckboxFn());
+ test.do(() => expect(activeElementFn()).toEqual(multiCheckboxFn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === entry2Fn());
+ test.do(() => expect(activeElementFn()).toEqual(entry2Fn()));
+
+ test.do(() => expect(entry3DropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowDown'})));
+ test.wait(() => activeElementFn() === entry3Fn());
+ test.do(() => expect(activeElementFn()).toEqual(entry3Fn()));
+ test.do(() => expect(entry3DropdownMenuFn().classList).toContain("show"));
+
+ test.do(() => expect(subDropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowRight'})));
+ test.wait(() => activeElementFn() === subFn());
+ test.do(() => expect(activeElementFn()).toEqual(subFn()));
+ test.do(() => expect(subDropdownMenuFn().classList).toContain("show"));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowRight'})));
+ test.wait(() => activeElementFn() === link311Fn());
+ test.do(() => expect(activeElementFn()).toEqual(link311Fn()));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowUp'})));
+ test.wait(() => activeElementFn() === link313Fn());
+ test.do(() => expect(activeElementFn()).toEqual(link313Fn()));
+
+ test.do(() => expect(link312DropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowUp'})));
+ test.wait(() => activeElementFn() === link312Fn());
+ test.do(() => expect(activeElementFn()).toEqual(link312Fn()));
+ test.do(() => expect(link312DropdownMenuFn().classList).toContain("show"));
+
+ test.do(() => expect(entry3DropdownMenuFn().classList).toContain("show"));
+ test.do(() => expect(subDropdownMenuFn().classList).toContain("show"));
+ test.do(() => expect(link312DropdownMenuFn().classList).toContain("show"));
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'ArrowLeft'})));
+ test.wait(() => activeElementFn() === subFn());
+ test.do(() => expect(activeElementFn()).toEqual(subFn()));
+ test.do(() => expect(entry3DropdownMenuFn().classList).toContain("show"));
+ test.do(() => expect(subDropdownMenuFn().classList).toContain("show"));
+ test.do(() => expect(link312DropdownMenuFn().classList).not.toContain("show"));
+
+ test.do(() => activeElementFn().dispatchEvent(
+ new KeyboardEvent("keydown", {bubbles: true, key: 'Escape'})));
+ test.do(() => expect(dropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => expect(entry3DropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => expect(subDropdownMenuFn().classList).not.toContain("show"));
+ test.do(() => expect(link312DropdownMenuFn().classList).not.toContain("show"));
+
+ test.start();
+});
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.xhtml b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.xhtml
new file mode 100644
index 0000000000..0cab0260f7
--- /dev/null
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/4200-dropdown/Dropdown.xhtml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<ui:composition template="/main.xhtml"
+ xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:f="http://java.sun.com/jsf/core"
+ xmlns:tc="http://myfaces.apache.org/tobago/component"
+ xmlns:ui="http://xmlns.jcp.org/jsf/facelets">
+
+ <tc:button id="root" label="Dropdown" omit="true">
+ <tc:link id="entry1" label="Entry One"/>
+ <tc:selectBooleanCheckbox id="checkbox" itemLabel="Checkbox"/>
+ <tc:selectBooleanToggle id="toggle" itemLabel="Toggle"/>
+ <tc:selectBooleanToggle itemLabel="Disabled" disabled="true"/>
+ <tc:selectOneRadio id="radio">
+ <tc:selectItem id="sun" itemLabel="Sun" itemValue="solis"/>
+ <tc:selectItem id="moon" itemLabel="Moon" itemValue="luna"/>
+ <tc:selectItem itemLabel="Stars" itemValue="stella" itemDisabled="true"/>
+ </tc:selectOneRadio>
+ <tc:selectManyCheckbox id="multiCheckbox" label="Checkbox Group">
+ <tc:selectItem id="checkbox1" itemLabel="Item One" itemValue="one"/>
+ <tc:selectItem itemLabel="Item Two (disabled)" itemValue="two" itemDisabled="true"/>
+ </tc:selectManyCheckbox>
+ <tc:link id="entry2" label="Entry Two"/>
+ <tc:separator/>
+ <tc:link label="Entry disabled" disabled="true"/>
+ <tc:link id="entry3" label="Entry Three" omit="true">
+ <tc:link id="sub" label="Sub" omit="true">
+ <tc:link id="link311" label="3-1-1"/>
+ <tc:selectBooleanCheckbox itemLabel="Checkbox"/>
+ <tc:selectBooleanToggle itemLabel="Toggle"/>
+ <tc:link id="link312" label="3-1-2" omit="true">
+ <tc:link label="3-1-2-1"/>
+ <tc:link label="3-1-2-2"/>
+ <tc:link label="3-1-2-3"/>
+ </tc:link>
+ <tc:link id="link313" label="3-1-3"/>
+ </tc:link>
+ <tc:link label="3-1"/>
+ <tc:link label="3-2" disabled="true">
+ <tc:link label="3-2-1"/>
+ <tc:link label="3-2-2"/>
+ <tc:link label="3-2-3"/>
+ </tc:link>
+ <tc:link label="3-3"/>
+ </tc:link>
+ <tc:link label="Entry 4"/>
+ <tc:link label="apache.org" link="https://www.apache.org/"/>
+ <tc:link label="Entry 6"/>
+ </tc:button>
+
+ <tc:in>
+ <f:facet name="after">
+ <tc:button omit="true">
+ <tc:link label="Entry One"/>
+ <tc:selectBooleanCheckbox itemLabel="Checkbox"/>
+ <tc:selectBooleanToggle itemLabel="Toggle"/>
+ <tc:selectBooleanToggle itemLabel="Disabled" disabled="true"/>
+ <tc:selectOneRadio id="ins1">
+ <tc:selectItem itemLabel="Sun" itemValue="solis"/>
+ <tc:selectItem itemLabel="Moon" itemValue="luna"/>
+ <tc:selectItem itemLabel="Stars" itemValue="stella" itemDisabled="true"/>
+ </tc:selectOneRadio>
+ <tc:selectManyCheckbox label="Checkbox Group">
+ <tc:selectItem itemLabel="Item One" itemValue="one"/>
+ <tc:selectItem itemLabel="Item Two (disabled)" itemValue="two" itemDisabled="true"/>
+ </tc:selectManyCheckbox>
+ <tc:link label="Entry Two"/>
+ <tc:separator/>
+ <tc:link label="Entry disabled" disabled="true"/>
+ <tc:link label="Entry Three" omit="true">
+ <tc:link label="Sub" omit="true">
+ <tc:link label="3-1-1"/>
+ <tc:selectBooleanCheckbox itemLabel="Checkbox"/>
+ <tc:selectBooleanToggle itemLabel="Toggle"/>
+ <tc:link label="3-1-2">
+ <tc:link label="3-1-2-1"/>
+ <tc:link label="3-1-2-2"/>
+ <tc:link label="3-1-2-3"/>
+ </tc:link>
+ <tc:link label="3-1-3"/>
+ </tc:link>
+ <tc:link label="3-1"/>
+ <tc:link label="3-2">
+ <tc:link label="3-2-1"/>
+ <tc:link label="3-2-2"/>
+ <tc:link label="3-2-3"/>
+ </tc:link>
+ <tc:link label="3-3"/>
+ </tc:link>
+ <tc:link label="Entry 4"/>
+ <tc:link label="apache.org" link="https://www.apache.org/"/>
+ <tc:link label="Entry 6"/>
+ </tc:button>
+ </f:facet>
+ </tc:in>
+</ui:composition>
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/6500-behavior/Behavior.test.js b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/6500-behavior/Behavior.test.js
index 0cb72f7280..1a447ac96a 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/6500-behavior/Behavior.test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/content/900-test/6500-behavior/Behavior.test.js
@@ -80,7 +80,7 @@ it("Simple EventAjax", function (done) {
it("Dropdown: Simple Event", function (done) {
const dropdownButtonFn = elementByIdFn("page:mainForm:dropdown::command");
- const dropdownMenuFn = querySelectorFn(".dropdown-menu[name='page:mainForm:dropdown']");
+ const dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:dropdown']");
const entryFn = elementByIdFn("page:mainForm:simpleEventEntry");
const oldCounterValues = getCounterValues();
@@ -108,7 +108,7 @@ it("Dropdown: Simple Event", function (done) {
it("Dropdown: Simple Ajax", function (done) {
const dropdownButtonFn = elementByIdFn("page:mainForm:dropdown::command");
- const dropdownMenuFn = querySelectorFn(".dropdown-menu[name='page:mainForm:dropdown']");
+ const dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:dropdown']");
const entryFn = elementByIdFn("page:mainForm:simpleAjaxEntry");
const oldCounterValues = getCounterValues();
@@ -136,7 +136,7 @@ it("Dropdown: Simple Ajax", function (done) {
it("Dropdown: Simple EventAjax", function (done) {
const dropdownButtonFn = elementByIdFn("page:mainForm:dropdown::command");
- const dropdownMenuFn = querySelectorFn(".dropdown-menu[name='page:mainForm:dropdown']");
+ const dropdownMenuFn = querySelectorFn(".tobago-dropdown-menu[name='page:mainForm:dropdown']");
const entryFn = elementByIdFn("page:mainForm:simpleEventAjaxEntry");
const oldCounterValues = getCounterValues();
diff --git a/tobago-example/tobago-example-demo/src/main/webapp/script/tobago-test.js b/tobago-example/tobago-example-demo/src/main/webapp/script/tobago-test.js
index 0791fb36b2..761cda8aac 100644
--- a/tobago-example/tobago-example-demo/src/main/webapp/script/tobago-test.js
+++ b/tobago-example/tobago-example-demo/src/main/webapp/script/tobago-test.js
@@ -19,25 +19,44 @@
import {JasmineTestTool} from "/tobago/test/tobago-test-tool.js";
+/**
+ * @param expression
+ * @returns {function(): HTMLElement}
+ */
function elementByIdFn(expression) {
return function () {
return document.getElementById("page:testframe").contentWindow.document.getElementById(expression);
}
}
+/**
+ * @param expression
+ * @returns {function(): *}
+ */
function querySelectorFn(expression) {
return function () {
return document.getElementById("page:testframe").contentWindow.document.querySelector(expression);
}
}
+/**
+ * @param expression
+ * @returns {function(): NodeListOf<*>}
+ */
function querySelectorAllFn(expression) {
return function () {
return document.getElementById("page:testframe").contentWindow.document.querySelectorAll(expression);
}
}
-export {elementByIdFn, querySelectorFn, querySelectorAllFn};
+/**
+ * @returns {HTMLElement}
+ */
+function activeElementFn() {
+ return document.getElementById("page:testframe").contentWindow.document.activeElement;
+}
+
+export {elementByIdFn, querySelectorFn, querySelectorAllFn, activeElementFn};
beforeEach(function (done) {
const test = new JasmineTestTool(done);
diff --git a/tobago-theme/src/main/scss/_tobago.scss b/tobago-theme/src/main/scss/_tobago.scss
index e835804db7..14592463b1 100644
--- a/tobago-theme/src/main/scss/_tobago.scss
+++ b/tobago-theme/src/main/scss/_tobago.scss
@@ -93,18 +93,6 @@ $tobago-flex-layout-spacing: 0.5rem;
}
}
-@mixin dropdownMenuFormCheckComponents() {
- .dropdown-menu .form-check {
- /* move form-check components to the right, so checkbox/radio buttons are inside dropdown-menu */
- $paddingLeftCheckboxRadio: (divide($dropdown-item-padding-x, 1rem) + $form-check-padding-start);
- padding-left: $paddingLeftCheckboxRadio;
-
- &.form-switch {
- padding-left: $paddingLeftCheckboxRadio + ($form-switch-width - $form-check-input-width);
- }
- }
-}
-
@mixin formControlFocusShadows() {
//_form-control:focus from bootstrap
@if $enable-shadows {
@@ -331,6 +319,28 @@ $tobago-flex-layout-spacing: 0.5rem;
}
}
+@mixin tobagoDropdownMenu() {
+ .tobago-dropdown-menu {
+ /* Use .tobago-dropdown-menu instead of .dropdown-menu to prevent Bootstrap from creating a dropdown instance.
+ This leads to javascript error if arrow up/down is pressed. */
+ @extend .dropdown-menu;
+
+ .form-check {
+ /* move form-check components to the right, so checkbox/radio buttons are inside dropdown-menu */
+ $paddingLeftCheckboxRadio: (divide($dropdown-item-padding-x, 1rem) + $form-check-padding-start);
+ padding-left: $paddingLeftCheckboxRadio;
+
+ &.form-switch {
+ padding-left: $paddingLeftCheckboxRadio + ($form-switch-width - $form-check-input-width);
+ }
+ }
+
+ label[for] {
+ width: 100%; //increased clickable area for checkbox/radio button label
+ }
+ }
+}
+
@mixin tobagoTreeNodeToggle() {
.tobago-toggle:not(.invisible) {
cursor: pointer;
@@ -497,11 +507,10 @@ tobago-date {
// dummy for unit tests
}
-/* dropdown ------------------------------------------------------- */
tobago-dropdown {
display: inline-block; //make tobago-dropdown height the same the inner button. Important for dropdown-menu position
- @include dropdownMenuFormCheckComponents();
+ @include tobagoDropdownMenu();
&.tobago-dropdown-submenu {
cursor: pointer;
@@ -512,12 +521,8 @@ tobago-dropdown {
&:hover {
background-color: $dropdown-link-hover-bg;
- > .dropdown-menu {
+ > .tobago-dropdown-menu:not(.tobago-disabled) {
display: block;
- top: 0;
- left: 100%;
- margin-top: -0.5rem;
- margin-left: -1px;
}
}
@@ -531,6 +536,13 @@ tobago-dropdown {
margin-top: 7px;
margin-right: -10px;
}
+
+ > .tobago-dropdown-menu {
+ top: 0;
+ left: 100%;
+ margin-top: -0.5rem;
+ margin-left: -1px;
+ }
}
}
@@ -1007,7 +1019,7 @@ tobago-messages {
}
}
-.dropdown-menu .form-check {
+.tobago-dropdown-menu .form-check {
display: block;
}
@@ -1082,9 +1094,8 @@ tobago-page {
}
}
-/* menuStore -------------------------------------------------------- */
.tobago-page-menuStore {
- @include dropdownMenuFormCheckComponents();
+ @include tobagoDropdownMenu();
position: absolute;
top: 0;
diff --git a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-css.ts b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-css.ts
index e3fed5d73e..2032fa74a3 100644
--- a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-css.ts
+++ b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-css.ts
@@ -25,7 +25,10 @@ export enum Css {
COLLAPSING = "collapsing",
D_NONE = "d-none",
DISABLED = "disabled",
+ DROPDOWN = "dropdown",
+ DROPDOWN_ITEM = "dropdown-item",
DROPDOWN_MENU = "dropdown-menu",
+ DROPDOWN_MENU_END = "dropdown-menu-end",
FIXED_BOTTOM = "fixed-bottom",
INPUT_GROUP = "input-group",
POSITION_RELATIVE = "position-relative",
@@ -36,6 +39,7 @@ export enum Css {
TOBAGO_COLLAPSED = "tobago-collapsed",
TOBAGO_DISABLED = "tobago-disabled",
TOBAGO_DROP_ZONE = "tobago-drop-zone",
+ TOBAGO_DROPDOWN_MENU = "tobago-dropdown-menu",
TOBAGO_DROPDOWN_SUBMENU = "tobago-dropdown-submenu",
TOBAGO_EXPANDED = "tobago-expanded",
TOBAGO_FOCUS = "tobago-focus",
diff --git a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item-factory.ts b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item-factory.ts
new file mode 100644
index 0000000000..2a99523d6f
--- /dev/null
+++ b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item-factory.ts
@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {DropdownItem} from "./tobago-dropdown-item";
+import {Css} from "./tobago-css";
+
+export class DropdownItemFactory {
+ static create(dropdownMenu: HTMLDivElement): DropdownItem[] {
+ if (dropdownMenu.classList.contains(Css.TOBAGO_DROPDOWN_MENU)) {
+ const dropdownItems: DropdownItem[] = [];
+ dropdownMenu.querySelectorAll<HTMLElement>(
+ ":scope > a.dropdown-item, "
+ + ":scope > button.dropdown-item, "
+ + ":scope > tobago-select-boolean-checkbox.dropdown-item > input, "
+ + ":scope > tobago-select-boolean-toggle.dropdown-item > input, "
+ + ":scope > tobago-select-one-radio > .dropdown-item > input, "
+ + ":scope > tobago-select-many-checkbox > .dropdown-item > input, "
+ + ":scope > tobago-dropdown.tobago-dropdown-submenu > .dropdown-item").forEach(
+ (element) => {
+ dropdownItems.push(new DropdownItem(element));
+ }
+ );
+ return dropdownItems;
+ } else {
+ console.error("Given element is no dropdown menu.");
+ }
+ }
+}
diff --git a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item.ts b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item.ts
new file mode 100644
index 0000000000..78e12971ae
--- /dev/null
+++ b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown-item.ts
@@ -0,0 +1,93 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {Css} from "./tobago-css";
+import {DropdownItemFactory} from "./tobago-dropdown-item-factory";
+
+export class DropdownItem {
+ private _element: HTMLElement;
+
+ constructor(element: HTMLElement) {
+ this._element = element;
+ }
+
+ get ancestors(): DropdownItem[] {
+ const ancestors: DropdownItem[] = [];
+ let dropdownItem: DropdownItem = this as DropdownItem;
+ while (dropdownItem != null) {
+ ancestors.push(dropdownItem);
+ dropdownItem = dropdownItem.parent;
+ }
+ return ancestors;
+ }
+
+ get children(): DropdownItem[] {
+ const dropdownMenu = this.dropdownMenu;
+ if (dropdownMenu) {
+ return DropdownItemFactory.create(dropdownMenu);
+ }
+ }
+
+ get element(): HTMLElement {
+ return this._element;
+ }
+
+ get disabled(): boolean {
+ const input = this.element.querySelector("input");
+ return input ? input.disabled : this.element.getAttribute("disabled") === "disabled";
+ }
+
+ get focused(): boolean {
+ const root = this.element.getRootNode() as ShadowRoot | Document;
+ return root.activeElement === this.element;
+ }
+
+ get parent(): DropdownItem {
+ const dropdownItemElement: HTMLElement = this.element
+ .closest(`.${Css.TOBAGO_DROPDOWN_MENU}`)
+ ?.closest("tobago-dropdown")
+ ?.querySelector(":scope." + Css.TOBAGO_DROPDOWN_SUBMENU + " > ." + Css.DROPDOWN_ITEM);
+ return dropdownItemElement ? new DropdownItem(dropdownItemElement) : null;
+ }
+
+ get siblings(): DropdownItem[] {
+ const dropdownMenu: HTMLDivElement = this.element.closest(`.${Css.TOBAGO_DROPDOWN_MENU}`);
+ if (dropdownMenu) {
+ return DropdownItemFactory.create(dropdownMenu);
+ }
+ }
+
+ private get dropdownMenu(): HTMLDivElement {
+ return this.element.parentElement.querySelector(":scope > ." + Css.TOBAGO_DROPDOWN_MENU);
+ }
+
+ focus(options?: FocusOptions): void {
+ this.element.focus(options);
+ }
+
+ showSubMenu(): void {
+ if (!this.disabled) {
+ this.dropdownMenu?.classList.add(Css.SHOW);
+ }
+ }
+
+ hideSubMenu(): void {
+ this.dropdownMenu?.classList.remove(Css.SHOW);
+ }
+}
diff --git a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown.ts b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown.ts
index a07e6d7842..15f752f89a 100644
--- a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown.ts
+++ b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-dropdown.ts
@@ -17,6 +17,10 @@
import {MenuStore} from "./tobago-menu-store";
import {Css} from "./tobago-css";
+import {Key} from "./tobago-key";
+import {createPopper, Instance} from "@popperjs/core";
+import {DropdownItem} from "./tobago-dropdown-item";
+import {DropdownItemFactory} from "./tobago-dropdown-item-factory";
const TobagoDropdownEvent = {
HIDE: "tobago.dropdown.hide",
@@ -31,11 +35,25 @@ const TobagoDropdownEvent = {
*/
class Dropdown extends HTMLElement {
+ private popper: Instance;
+ private globalClickEventListener: EventListenerOrEventListenerObject;
+
constructor() {
super();
+ }
+
+ connectedCallback(): void {
if (!this.classList.contains(Css.TOBAGO_DROPDOWN_SUBMENU)) { // ignore submenus
- this.addEventListener("shown.bs.dropdown", this.openDropdown.bind(this));
- this.addEventListener("hidden.bs.dropdown", this.closeDropdown.bind(this));
+ this.popper = createPopper(this.toggle, this.dropdownMenu, {
+ placement: this.dropdownMenu.classList.contains(Css.DROPDOWN_MENU_END) ? "bottom-end" : "bottom-start",
+ });
+ this.globalClickEventListener = this.globalClickEvent.bind(this) as EventListenerOrEventListenerObject;
+ document.addEventListener("click", this.globalClickEventListener);
+ this.addEventListener("keydown", this.keydownEvent.bind(this));
+ this.dropdownMenu.addEventListener("keydown", this.keydownEvent.bind(this));
+ this.getAllDropdownItems(this.dropdownItems).forEach((dropdownItem) => {
+ dropdownItem.element.addEventListener("focus", this.focusEvent.bind(this));
+ });
}
// the click should not sort the column of a table - XXX not very nice - may look for a better solution
if (this.closest("tr") != null) {
@@ -45,24 +63,237 @@ class Dropdown extends HTMLElement {
}
}
- openDropdown(): void {
+ disconnectedCallback(): void {
+ document.removeEventListener("click", this.globalClickEventListener);
+ MenuStore.get().querySelector(`:scope > .${Css.TOBAGO_DROPDOWN_MENU}[name='${this.id}']`)?.remove();
+ }
+
+ get toggle(): HTMLButtonElement {
+ return this.querySelector(".dropdown-toggle");
+ }
+
+ get expanded(): boolean {
+ return this.toggle.ariaExpanded === "true";
+ }
+
+ get dropdownItems(): DropdownItem[] {
+ return DropdownItemFactory.create(this.dropdownMenu);
+ }
+
+ get dropdownMenu(): HTMLDivElement {
+ const root = this.getRootNode() as ShadowRoot | Document;
+ return root.querySelector(`.${Css.TOBAGO_DROPDOWN_MENU}[name='${this.id}']`);
+ }
+
+ private globalClickEvent(event: MouseEvent): void {
+ if (!this.toggle.disabled) {
+ const element = (event.target as Element);
+ if (this.isPartOfDropdown(event.target as Element)) {
+ if (element.getAttribute("for") !== null || element.tagName === "INPUT") {
+ /* do nothing if for-label, because click event triggers a second time on input element
+ do nothing if input element, because dropdown menu should stay open */
+ } else if (element.querySelector<HTMLInputElement>(":scope.dropdown-item > input") !== null) {
+ element.querySelector<HTMLInputElement>(":scope.dropdown-item > input")?.click();
+ } else if (this.getSubMenuToggle(element as HTMLElement) !== null) {
+ const subMenuToggle = this.getSubMenuToggle(element as HTMLElement);
+ subMenuToggle.click();
+ } else if (this.expanded) {
+ this.hideDropdown();
+ } else {
+ this.showDropdown();
+ }
+ } else {
+ this.hideDropdown();
+ }
+ }
+ }
+
+ private isPartOfDropdown(element: Element): boolean {
+ if (element) {
+ if (this.id === element.id || this.id === element.getAttribute("name")) {
+ return true;
+ } else {
+ return element.parentElement ? this.isPartOfDropdown(element.parentElement) : false;
+ }
+ } else {
+ return false;
+ }
+ }
+
+ private getSubMenuToggle(element: HTMLElement): HTMLElement {
+ if (element && element.classList.contains(Css.DROPDOWN_ITEM)
+ && element.parentElement && element.parentElement.classList.contains(Css.TOBAGO_DROPDOWN_SUBMENU)) {
+ return element;
+ } else if (element.parentElement) {
+ return this.getSubMenuToggle(element.parentElement);
+ } else {
+ return null;
+ }
+ }
+
+ private keydownEvent(event: KeyboardEvent): void {
+ switch (event.key) {
+ case Key.ARROW_DOWN:
+ event.preventDefault(); //prevent click event if radio button is selected
+ this.showDropdown();
+ this.getNextDropdownItem()?.focus();
+ break;
+ case Key.ARROW_UP:
+ event.preventDefault(); //prevent click event if radio button is selected
+ this.showDropdown();
+ this.getPreviousDropdownItem()?.focus();
+ break;
+ case Key.ARROW_RIGHT:
+ event.preventDefault(); //prevent click event if radio button is selected
+ this.getSubmenuDropdownItem()?.focus();
+ break;
+ case Key.ARROW_LEFT:
+ event.preventDefault(); //prevent click event if radio button is selected
+ this.getParentDropdownItem()?.focus();
+ break;
+ case Key.ESCAPE:
+ this.hideDropdown();
+ break;
+ default:
+ break;
+ }
+ }
+
+ private showDropdown(): void {
this.dispatchEvent(new CustomEvent(TobagoDropdownEvent.SHOW));
- if (!this.insideNavbar()) {
+ if (!this.insideNavbar() && !this.dropdownMenu.classList.contains(Css.SHOW)) {
MenuStore.appendChild(this.dropdownMenu);
}
+ this.toggle.classList.add(Css.SHOW);
+ this.toggle.ariaExpanded = "true";
+ this.dropdownMenu.classList.add(Css.SHOW);
+ this.popper.update();
this.dispatchEvent(new CustomEvent(TobagoDropdownEvent.SHOWN));
}
- closeDropdown(): void {
+ private hideDropdown(): void {
this.dispatchEvent(new CustomEvent(TobagoDropdownEvent.HIDE));
+
+ this.toggle.classList.remove(Css.SHOW);
+ this.toggle.ariaExpanded = "false";
+ this.dropdownMenu.classList.remove(Css.SHOW);
+ this.getAllDropdownItems(this.dropdownItems).forEach((dropdownItem) => dropdownItem.hideSubMenu());
if (!this.insideNavbar()) {
this.appendChild(this.dropdownMenu);
}
+
this.dispatchEvent(new CustomEvent(TobagoDropdownEvent.HIDDEN));
}
+ private getNextDropdownItem(): DropdownItem {
+ const focusedDropdownItem = this.getFocusedDropdownItem(this.dropdownItems);
+ if (focusedDropdownItem) {
+ const enabledDropdownItems = this.getEnabledDropdownItems(focusedDropdownItem.siblings);
+ if (enabledDropdownItems.length > 0) {
+ const index = enabledDropdownItems.findIndex((value) => value.element === focusedDropdownItem.element);
+ const newIndex = index === -1 ? 0 : index + 1;
+ if (newIndex >= 0 && newIndex < enabledDropdownItems.length) {
+ return enabledDropdownItems[newIndex];
+ } else {
+ return enabledDropdownItems[0];
+ }
+ }
+ } else {
+ const enabledDropdownItems = this.getEnabledDropdownItems(this.dropdownItems);
+ if (enabledDropdownItems.length > 0) {
+ return enabledDropdownItems[0];
+ }
+ }
+ }
+
+ private getPreviousDropdownItem(): DropdownItem {
+ const focusedDropdownItem = this.getFocusedDropdownItem(this.dropdownItems);
+ if (focusedDropdownItem) {
+ const enabledDropdownItems = this.getEnabledDropdownItems(focusedDropdownItem.siblings);
+ if (enabledDropdownItems.length > 0) {
+ const index = enabledDropdownItems.findIndex((value) => value.element === focusedDropdownItem.element);
+ const newIndex = index === -1 ? 0 : index - 1;
+ if (newIndex >= 0 && newIndex < enabledDropdownItems.length) {
+ return enabledDropdownItems[newIndex];
+ } else {
+ return enabledDropdownItems[enabledDropdownItems.length - 1];
+ }
+ }
+ } else {
+ const enabledDropdownItems = this.getEnabledDropdownItems(this.dropdownItems);
+ if (enabledDropdownItems.length > 0) {
+ return enabledDropdownItems[enabledDropdownItems.length - 1];
+ }
+ }
+ }
+
+ private getSubmenuDropdownItem(): DropdownItem {
+ const focusedDropdownItems = this.getFocusedDropdownItem(this.dropdownItems);
+ if (focusedDropdownItems && focusedDropdownItems.children) {
+ const enabledDropdownItems = this.getEnabledDropdownItems(focusedDropdownItems.children);
+ if (enabledDropdownItems.length > 0) {
+ return enabledDropdownItems[0];
+ }
+ }
+ }
+
+ private getParentDropdownItem(): DropdownItem {
+ const focusedDropdownItems = this.getFocusedDropdownItem(this.dropdownItems);
+ if (focusedDropdownItems) {
+ return focusedDropdownItems.parent;
+ }
+ }
+
+ private focusEvent(event: FocusEvent): void {
+ const dropdownItem = new DropdownItem(event.target as HTMLElement);
+ const ancestors: DropdownItem[] = dropdownItem.ancestors;
+ const allDropdownItems: DropdownItem[] = this.getAllDropdownItems(this.dropdownItems);
+ allDropdownItems.forEach((dropdownItem) => {
+ if (ancestors.find((ancestor) => ancestor.element === dropdownItem.element)) {
+ dropdownItem.showSubMenu();
+ } else {
+ dropdownItem.hideSubMenu();
+ }
+ });
+ }
+
+ private getFocusedDropdownItem(dropdownItems: DropdownItem[]): DropdownItem {
+ if (dropdownItems) {
+ for (let i = 0; i < dropdownItems.length; i++) {
+ const dropdownItem = dropdownItems[i];
+ const focusedDropdownItem = this.getFocusedDropdownItem(dropdownItem.children);
+ if (focusedDropdownItem != null) {
+ return focusedDropdownItem;
+ } else if (dropdownItem.focused) {
+ return dropdownItem;
+ }
+ }
+ }
+ }
+
+ private getEnabledDropdownItems(dropdownItems: DropdownItem[]): DropdownItem[] {
+ const enabledDropdownItems: DropdownItem[] = [];
+ dropdownItems.forEach((dropdownItem) => {
+ if (!dropdownItem.disabled) {
+ enabledDropdownItems.push(dropdownItem);
+ }
+ });
+ return enabledDropdownItems;
+ }
+
+ private getAllDropdownItems(dropdownItems: DropdownItem[]): DropdownItem[] {
+ let allDropdownItems: DropdownItem[] = [];
+ dropdownItems.forEach((dropdownItem) => {
+ allDropdownItems.push(dropdownItem);
+ if (dropdownItem.children) {
+ allDropdownItems = allDropdownItems.concat(this.getAllDropdownItems(dropdownItem.children));
+ }
+ });
+ return allDropdownItems;
+ }
+
/**
* The bootstrap dropdown implementation doesn't adjust the position of the dropdown menu if inside a '.navbar'.
* In this case the dropdown menu should not be appended to the menu store.
@@ -71,11 +302,6 @@ class Dropdown extends HTMLElement {
private insideNavbar(): boolean {
return Boolean(this.closest(".navbar"));
}
-
- private get dropdownMenu(): HTMLDivElement {
- const root = this.getRootNode() as ShadowRoot | Document;
- return root.querySelector(`.dropdown-menu[name='${this.id}']`);
- }
}
document.addEventListener("tobago.init", function (event: Event): void {
diff --git a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-key.ts b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-key.ts
index cdb99fbbf7..3b50d24905 100644
--- a/tobago-theme/tobago-theme-standard/src/main/ts/tobago-key.ts
+++ b/tobago-theme/tobago-theme-standard/src/main/ts/tobago-key.ts
@@ -19,6 +19,8 @@
export enum Key {
ARROW_DOWN = "ArrowDown",
+ ARROW_LEFT = "ArrowLeft",
+ ARROW_RIGHT = "ArrowRight",
ARROW_UP = "ArrowUp",
BACKSPACE = "Backspace",
ENTER = "Enter",